Deploy MSSQL in SAP BTP, Kyma Runtime

1. Go to the kyma-runtime-extension-samples repository. This repository contains a collection of Kyma sample applications which will be used during the tutorial.

2. Use the green Code button to choose one of the options to download the code locally, or simply run the following command using your CLI at your desired folder location:

   Shell/Bash

   Copy

   git clone https://github.com/SAP-samples/kyma-runtime-extension-samples
   

1. Open the database-mssql directory in your desired editor.

2. Explore the content of the sample.

   Within the app folder you can find the configuration files for setting up the sample DemoDB database within the Docker image. The process includes defining the database password as well as the creation of the Orders table with sample data.

   Within the docker folder you can find the Dockerfile, which is a text-based set of instructions that is used to create a container image. Notice how the last command references the entrypoint.sh script defined within the app directory which is used to call the commands to configure the sample database.

   Within the k8s folder you can find the resource definitions that will be used to deploy the sample to SAP BTP, Kyma runtime. This includes deployment.yaml which specifies the microservice definition of the MSSQL database and also a service definition which exposes the microservice to other resources within the cluster. The pvc.yaml file specifies PVC which is used to request a storage location for the data of the database. The secret.yaml file contains the database user and password.

A Docker container image is a lightweight, standalone, executable package of software that includes everything needed to run an application: code, runtime, system tools, system libraries and settings. In this step, you will build the mssql image according to the Dockerfile definition contained in the docker folder. Make sure to run the following commands from the database-mssql directory using your CLI, and also replace the value of <your-docker-id> with your Docker account ID.

If you’re using any device with a non-x86 processor (e.g. MacBook M1/M2) you need to instruct Docker to use x86 images by setting the DOCKER_DEFAULT_PLATFORM environment variable using the command export DOCKER_DEFAULT_PLATFORM=linux/amd64. Check Environment variables for more information.

1. To build the Docker image, run this command:

   Shell/Bash

   Copy

   docker build -t <your-docker-id>/mssql -f docker/Dockerfile .
   

2. To push the Docker image to your Docker repository, run this command:

   Shell/Bash

   Copy

   docker push <your-docker-id>/mssql
   

Make sure to replace the value of <your-docker-id> with your Docker account ID.

1. Start the image locally by running the following command. The start-up takes about two minutes because the scripts run to initialize the database.

   Shell/Bash

   Copy

   docker run -e ACCEPT_EULA=Y -e SA_PASSWORD=Yukon900 -p 1433:1433 --name sql1 -d <your-docker-id>/mssql
   

2. Open a bash shell within the image by running this command:

   Shell/Bash

   Copy

   docker exec -it sql1 "bash"
   

3. Start the sqlcmd tool, which allows you to run queries against the database, by running this command:

   Shell/Bash

   Copy

   /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P Yukon900
   

4. Enter a query by entering this command:

   Shell/Bash

   Copy

   USE DemoDB SELECT * FROM ORDERS
   

5. The query can now be executed by entering this command:

   Shell/Bash

   Copy

   GO
   

6. End the sqlcmd session by running:

   Shell/Bash

   Copy

   exit
   

7. End the bash session by running:

   Shell/Bash

   Copy

   exit
   

8. Shutdown the Docker container by running this command:

   Shell/Bash

   Copy

   docker stop sql1
   

You can also use the following additional commands:

• To start the container again, run:

  Shell/Bash

  Copy

  docker start sql1
  

• To remove the container, run:

  Shell/Bash

  Copy

  docker rm sql1
  

• To list all existing local containers, run:

  Shell/Bash

  Copy

  docker container ls -a
  

• To list out all existing local images, run:

  Shell/Bash

  Copy

  docker images
  

You can find the resource definitions in the k8s folder. If you performed any changes in the database configuration, these files may also need to be updated. The folder contains the following files:

• secret.yaml: defines the database password and the base64-encoded user.
• pvc.yaml: defines PVC used to store the data of the database.
• deployment.yaml: defines the Deployment definition for the MSSQL database as well as a service used for communication. This definition references both the secret.yaml and pvc.yaml by name.

Run the following commands from the database-mssql directory using your CLI.

1. Create the dev namespace and enable Istio:

   Shell/Bash

   Copy

   kubectl create namespace dev
   kubectl label namespaces dev istio-injection=enabled
   

   Namespaces separate objects inside a Kubernetes cluster. Choosing a different namespace requires adjustments to the provided samples.

   Adding the istio-injection=enabled label to the namespace enables Istio. Istio is the service mesh implementation used by SAP BTP, Kyma runtime.

2. Apply the PVC:

   Shell/Bash

   Copy

   kubectl -n dev apply -f ./k8s/pvc.yaml
   

3. Apply the Secret:

   Shell/Bash

   Copy

   kubectl -n dev apply -f ./k8s/secret.yaml
   

4. In deployment.yaml, adjust the value of spec.template.spec.containers.image, commented with #change it to your image, to use your Docker image. Apply the Deployment:

   Shell/Bash

   Copy

   kubectl -n dev apply -f ./k8s/deployment.yaml
   

5. Verify if the Pod is up and running:

   Shell/Bash

   Copy

   kubectl -n dev get po
   

   This command results in a table similar to the one below, showing a Pod with the mssql- name ending with a random hash. The STATUS will display Running when the Pod is up and running.

   Shell/Bash

   Copy

   NAME                                     READY   STATUS    RESTARTS   AGE
   mssql-6df65c689d-qdj4r        2/2     Running   0          93s
   

Kubernetes provides a port-forward functionality that allows you to connect to resources running in SAP BTP, Kyma runtime locally. This can be useful for development and debugging tasks. Make sure to adjust the name of the Pod in the following commands to match your own.

1. Confirm the port on which the Pod is listening:

   Shell/Bash

   Copy

   kubectl get pod mssql-6df65c689d-qdj4r -n dev -o jsonpath="{.spec.containers[*].ports}"
   

   This command should return the ports of two containers existing within the Pod:

   Shell/Bash

   Copy

   [{"containerPort":15090,"name":"http-envoy-prom","protocol":"TCP"}] [{"containerPort":1433,"protocol":"TCP"}]
   

2. Apply the port-forward to the Pod using the port 1433 used by the MSQL Deployment:

   Shell/Bash

   Copy

   kubectl port-forward mssql-6df65c689d-qdj4r -n dev 1433:1433
   

   This command should return:

   Shell/Bash

   Copy

   Forwarding from 127.0.0.1:1433 -> 1433
   Forwarding from [::1]:1433 -> 1433
   

   At this point, a tool such as sqlcmd or a development project running on your computer can access the database running in SAP BTP, Kyma runtime using localhost:1433.

3. To end the process, use CTRL+C.

Similarly to how the Docker image can be accessed locally, you can perform the same on the Deployment running in SAP BTP, Kyma runtime. Make sure to adjust the name of the Pod in the following commands to match your own.

1. By default, a Pod includes the denoted Deployments defined in the yaml definition as well as the istio-proxy. For the mssql Deployment, this means there will be two containers in the Pod.

   The describe command can be used to view this information.

   Shell/Bash

   Copy

   kubectl describe pod mssql-6df65c689d-qdj4r -n dev
   

2. Run the following command to obtain a bash shell.

   If any adjustments were made to the name of the MSSQL Deployment, adjust the name of the container denoted by the -c option.

   Shell/Bash

   Copy

   kubectl exec -it mssql-6df65c689d-qdj4r -n dev -c mssql -- bash
   

   This may output the following message, which can be ignored: groups: cannot find name for group ID 1337

3. To run the sqlcmd tool, which allows you to run queries against the database, run this command:

   Shell/Bash

   Copy

   /opt/mssql-tools/bin/sqlcmd -S 127.0.0.1 -U SA -P Yukon900
   

4. The commands performed in Step 4 to query the database can now be used in the same fashion.