This tutorial expects that the Deploy a Go MSSQL API Endpoint in the Kyma Runtime tutorial has been completed and relies on the database running within the Kyma runtime.
Deploying the SAPUI5 Docker image to the Kyma runtime includes:
- A Kubernetes
Deployment
of the frontend image with the ConfigMap
mounted to a volume
- A Kubernetes
ConfigMap
containing the URL to the backend API
- A Kubernetes Service used to expose the application to other Kubernetes resources
- A Kyma
APIRule
to expose the frontend application to the Internet
Step 1: Clone the Git repository
- Copy the repository URL.
In your browser, go to kyma-runtime-extension-samples. This repository contains a collection of Kyma sample applications which will be used during the tutorial.
Choose the Code button and choose one of the options to download the code locally or simply run the following command within your CLI at your desired folder location:
git clone https://github.com/SAP-samples/kyma-runtime-extension-samples
Step 2: Explore the sample
-
Open the frontend-ui5-mssql
directory in your desired editor.
-
Explore the content of the sample.
-
You can find many directories that relate to the UI5 application.
-
The docker
directory contains the Dockerfile used to generate the Docker image. The image is built in two stages to create a small image. In the first stage, a NodeJS
image is used which copies the related content of the project into the image and builds the application. The built application is then copied into an nginx
image with the default setup exposing the application on port 80.
-
Within the k8s
directory you can find the Kubernetes/Kyma resources you will apply to your Kyma runtime.
Step 3: Run application locally
-
Within the frontend-ui5-mssql
directory, run the following command using your CLI to install the application dependencies:
npm install
-
Within the project, open the webapp/config.json
file and adjust API_URL
by replacing <cluster domain>
to match the Kyma runtime cluster domain. This should be the value of the API Rule created in step 6 of the Deploying a Go MSSQL API Endpoint in the Kyma Runtime tutorial.
{
"API_URL": "https://api-mssql-go.*******.kyma.shoot.live.k8s-hana.ondemand.com"
}
-
To start the application, run the following command. This should automatically load the application in your browser.
npm run-script start
Pressing control-c
will stop the running application.
Step 4: Build Docker image
Run the following commands from the frontend-ui5-mssql
directory using your CLI. Make sure to replace the value of <your-docker-id>
with your Docker account ID.
-
To build the Docker image, run this command:
docker build -t <your-docker-id>/fe-ui5-mssql -f docker/Dockerfile .
-
To push the Docker image to your Docker repository, run this command:
docker push <your-docker-id>/fe-ui5-mssql
Step 5: Apply resources to Kyma runtime
You can find the resource definitions in the k8s
folder. If you performed any changes in the configuration, these files may also need to be updated. The folder contains the following files that are relevant to this tutorial:
apirule.yaml
: defines the API endpoint which exposes the application to the Internet. This endpoint does not define any authentication access strategy and should be disabled when not in use.
configmap.yaml
: defines API_URL
which represents the endpoint used for the orders API. It must be adjusted to reflect the domain of the Kyma runtime.
deployment.yaml
: defines the Deployment definition for the SAPUI5 application as well as a service used for communication. This definition references the configmap.yaml
by name. It is used to overwrite the webapp/config.json
of the application.
-
Start by creating the dev
Namespace if it doesn’t already exist:
kubectl create namespace dev
-
Within the project, open the k8s/configmap.yaml
file and adjust API_URL
by replacing <cluster domain>
to match the Kyma runtime cluster domain:
kind: ConfigMap
apiVersion: v1
metadata:
name: fe-ui5-mssql
labels:
app: fe-ui5-mssql
data:
config.json: |-
{
"API_URL": "https://api-mssql-go.*******.kyma.shoot.live.k8s-hana.ondemand.com"
}
-
Apply the ConfigMap
:
kubectl -n dev apply -f ./k8s/configmap.yaml
-
Within the deployment.yaml
, adjust the value of spec.template.spec.containers.image
to use your Docker image. Apply the Deployment:
kubectl -n dev apply -f ./k8s/deployment.yaml
-
Apply the APIRule
:
kubectl -n dev apply -f ./k8s/apirule.yaml
Step 6: Open the UI application
To access the application we can use the APIRule
we created in the previous step.
-
Open the Kyma runtime console
-
Choose the dev
Namespace.
-
From the menu, choose Discovery and Network > APIRules
.
-
Choose the Host entry for the fe-ui5-mssql APIRule
to open the application in the browser. This should be similar to:
https://fe-ui5-mssql.*******.kyma.shoot.live.k8s-hana.ondemand.com