"What do I need before I start?"

" You\u0026rsquo;ve configured the respective entitlements, enabled the Kyma runtime in your subaccount, and created an SAP HANA Cloud service instance in the SAP BTP cockpit. Follow the steps in the Prepare for Deployment in the SAP BTP, Kyma Runtime tutorial that is part of the Deploy a Full-Stack CAP Application in SAP BTP, Kyma Runtime Following SAP BTP Developer’s Guide tutorial group. You have an enterprise global account in SAP BTP. To use services for free, you can sign up for an SAP BTPEA (SAP BTP Enterprise Agreement) or a Pay-As-You-Go for SAP BTP global account and use the free tier services only. See Using Free Service Plans. You have a platform user. See User and Member Management. You\u0026rsquo;re an administrator of the global account in SAP BTP. You have a subaccount in SAP BTP to deploy the services and applications. You have a tenant of SAP Cloud Identity Services. See Get Your Tenant for details how to get a tenant of SAP Cloud Identity Services if you don\u0026rsquo;t have one yet. You\u0026rsquo;ve established trust between your tenant of SAP Cloud Identity Services and your SAP BTP account. This established trust allows you to use your SAP Cloud Identity Services tenant as an identity provider or a proxy to your own identity provider hosting your business users. See Establish Trust and Federation Between SAP Authorization and Trust Management Service and SAP Cloud Identity Services. You have one of the following browsers that are supported for working in SAP Business Application Studio: Mozilla Firefox Google Chrome Microsoft Edge For Windows, you need Chocolatey. Chocolatey is a package manager that speeds up and eases installation of the tools in this tutorial. See how to install Chocolatey in Setup/Install. You\u0026rsquo;ve prepared a container registry and you\u0026rsquo;ve logged in to the container registry through your CLI. A container registry is a repo where you can push your Docker images. SAP BTP doesn\u0026rsquo;t currently provide a container registry. You can use any container registry offering as long as it can be reached from the public Internet. This tutorial follows the guidance provided in the SAP BTP Developer\u0026rsquo;s Guide.\n"

Deploy in SAP BTP, Kyma Runtime

This tutorial shows you how to deploy your CAP application in SAP BTP, Kyma runtime.

🎓beginner ⏱30 min SAP Cloud Application Programming Model Beginner Node Js SAP Business Technology Platform SAP Fiori 0/10

Overview

🎓 beginner ⏱ 30 min. SAP Cloud Application Programming ModelBeginnerNode JsSAP Business Technology PlatformSAP Fiori

You will learn

✔How to deploy your CAP application in SAP BTP, Kyma runtime.

G Grzegorz Karaluch July 24, 2026

Created by November 1, 2023

Contributors

Prerequisites

You’ve configured the respective entitlements, enabled the Kyma runtime in your subaccount, and created an SAP HANA Cloud service instance in the SAP BTP cockpit. Follow the steps in the Prepare for Deployment in the SAP BTP, Kyma Runtime tutorial that is part of the Deploy a Full-Stack CAP Application in SAP BTP, Kyma Runtime Following SAP BTP Developer’s Guide tutorial group.
You have an enterprise global account in SAP BTP. To use services for free, you can sign up for an SAP BTPEA (SAP BTP Enterprise Agreement) or a Pay-As-You-Go for SAP BTP global account and use the free tier services only. See Using Free Service Plans.
You have a platform user. See User and Member Management.
You’re an administrator of the global account in SAP BTP.
You have a subaccount in SAP BTP to deploy the services and applications.
You have a tenant of SAP Cloud Identity Services. See Get Your Tenant for details how to get a tenant of SAP Cloud Identity Services if you don’t have one yet.
You’ve established trust between your tenant of SAP Cloud Identity Services and your SAP BTP account. This established trust allows you to use your SAP Cloud Identity Services tenant as an identity provider or a proxy to your own identity provider hosting your business users. See Establish Trust and Federation Between SAP Authorization and Trust Management Service and SAP Cloud Identity Services.
You have one of the following browsers that are supported for working in SAP Business Application Studio:
- Mozilla Firefox
- Google Chrome
- Microsoft Edge
For Windows, you need Chocolatey. Chocolatey is a package manager that speeds up and eases installation of the tools in this tutorial. See how to install Chocolatey in Setup/Install.
You’ve prepared a container registry and you’ve logged in to the container registry through your CLI. A container registry is a repo where you can push your Docker images. SAP BTP doesn’t currently provide a container registry. You can use any container registry offering as long as it can be reached from the public Internet.

This tutorial follows the guidance provided in the SAP BTP Developer’s Guide.

Steps

Windows

macOS

Linux

BAS

Open all Close all

Step 1 Introduction

—

SAP BTP, Kyma runtime is a cloud-native application runtime that combines the power of Kubernetes with a set of best-in-class tools and open-source components that empower you to develop, run, and operate secure and scalable cloud-native applications. Detailed information is available at Kyma Environment.

The files of the SAP BTP, Kyma runtime are provided as a container image. In addition, since the containers run on Kubernetes, their configuration is described by Kubernetes resources.

Hence, you need two kinds of artifacts to run applications on Kubernetes:

Container images
Kubernetes resources

You start by building your project as container images and push those images to a container registry of your choice. Then, you add a CAP Helm chart to your project. As a last step, you deploy the Helm chart to your Kyma resources, where service instances of SAP BTP services are created and pods pull the previously created container images from the container registry.

Step 2 Install kubectl

To install kubectl, run the following command:

Shell/Bash

brew install kubectl

Check if the installation is successful:

Shell/Bash

kubectl version --client

You see a version number.

You can install kubectl using chocolatey.

To install kubectl, run the following command:

Shell/Bash

choco install kubernetes-cli

Check if the installation is successful:

Shell/Bash

kubectl version --client

You see something like: Client Version: version.Info{Major:"1", Minor:"19", GitVersion:"v1.19.3", GitCommit:"1e11e4a2108024935ecfcb2912226cedeafd99df", GitTreeState:"clean", BuildDate:"2020-10-14T12:50:19Z", GoVersion:"go1.15.2", Compiler:"gc", Platform:"windows/amd64"}

Follow the instructions for your preferred way of installing kubectl at Install and Set Up kubectl on Linux.

Step 3 Install kubelogin

To install kubelogin, run the following command:

Shell/Bash

brew install int128/kubelogin/kubelogin

See Setup in the kubelogin docs for more details.

You can install kubelogin using chocolatey:

Shell/Bash

choco install kubelogin

See Setup in the kubelogin docs for more details.

To install kubelogin, run the following command:

Shell/Bash

brew install int128/kubelogin/kubelogin

See Setup in the kubelogin docs for more details.

Step 4 Log in to your Kyma cluster

Step 5 Install helm

There’s a multitude of options to install helm. You can see the full list at Installing Helm. We have also listed some options:

To install helm, run the following command:

Shell/Bash

brew install helm

There’s a multitude of options to install helm. You can see the full list at Installing Helm. We have also listed some options:

You can install helm using chocolatey.

To install helm, run the following command:

Shell/Bash

choco install kubernetes-helm

Check if the installation is successful:

Shell/Bash

helm version

You see something like version.BuildInfo{Version:"v3.8.0", GitCommit:"d14138609b01886f544b2025f5000351c9eb092e", GitTreeState:"clean", GoVersion:"go1.17.5"}.

Step 6 Install Paketo (pack)

Pack lets you build container images, which are collaboratively maintained making it easier to maintain and update.

Shell/Bash

brew install buildpacks/tap/pack

Pack lets you build container images, which are collaboratively maintained making it easier to maintain and update.

You can install pack using chocolatey with the command:

Shell/Bash

choco install pack

As an alternative, you can install pack manually:

Download pack for your platform from GitHub.
Extract the pack binary.
Enter Edit the System Environment Variables in the Windows search box (Windows icon in the task bar). The System Properties dialog is opened.
Choose Environment Variables….
Choose your Path environment variable under User Variables for <your_user_name> and choose Edit.
Choose Browse and navigate to the folder where you extracted the pack binary.
Choose OK to add pack to your Path environment variable.

Pack lets you build container images, which are collaboratively maintained making it easier to maintain and update.

Follow the instructions to install the pack CLI.

Step 7 Install a container management app

Kyma runs on containers. Hence, for this tutorial, you need an application that enables you to manage (build, push, pull, and run) container images on your desktop and a docker-compatible command-line interface. We provide two examples - Docker Desktop and Rancher Desktop. You can pick one of them or any other app suitable for the purpose.

macOS: Download the installer from Install Docker Desktop on Mac and follow the instructions to install and set up Docker Desktop.
Windows: Download the installer from Install Docker Desktop on Windows and follow the instructions to install and set up Docker Desktop.

Step 8 Download and set up the project locally

Skip this step if you cloned the application from the Incident Management application GitHub repository without going through the application development steps. Perform this step only in case you’ve developed the application from the start following the Develop a Full-Stack CAP Application Following the SAP BTP Developer’s Guide mission in the SAP Discovery Center.
1. In SAP Business Application Studio, choose the icon to download dev space content.
  Download dev space content
  Make sure the IncidentManagement dev space is in status RUNNING.
2. Extract the incident-management folder from the downloaded archive.
Open a command-line window in the folder where your application resides (for example, incident-management if developed from the start or incidents-app if cloned from GitHub) and run the following command to open the project in VS Code:
Shell
```
code .
```

Step 9 Prepare your application

Make sure you’re logged in to your container registry.

In VS Code, choose Terminal → New Terminal and run the following command:
Shell
```
npm install
```
This command installs the required dependencies and updates the package-lock.json file of your project.
In your terminal, run the following command:
Shell
```
cds add workzone
```
Provide a Helm chart:
Shell
```
cds add kyma
```

Configure containerize.yaml at the root of your project:

Note: Set BP_NODE_VERSION: "20" to pin Node.js to version 20 LTS. Without it, the Paketo buildpack selects Node.js 26, which requires libatomic.so.1 — a library not present in the paketobuildpacks/run-jammy-base runtime image, causing the container to crash on startup.

YAML
_schema-version: '1.0'
repository: <your-dockerhub-username>
tag: <image-version>
modules:
  - name: incident-management-srv
    build-parameters:
      buildpack:
        type: nodejs
        builder: builder-jammy-base
        path: gen/srv
        env:
          BP_NODE_VERSION: "20"
  - name: incident-management-hana-deployer
    build-parameters:
      buildpack:
        type: nodejs
        builder: builder-jammy-base
        path: gen/db
        env:
          BP_NODE_VERSION: "20"
  - name: incident-management-html5-deployer
    build-parameters:
      buildpack:
        type: nodejs
        builder: builder-jammy-base
        path: app/html5-deployer
        env:
          BP_NODE_VERSION: "20"

Make sure you’re logged in to your container registry.

In VS Code, choose Terminal → New Terminal and run the following command:
Shell
```
npm install
```
This command installs the required dependencies and updates the package-lock.json file of your project.
Add configuration for the managed App Router:
Shell
```
cds add workzone
```
Provide a Helm chart:
Shell
```
cds add kyma
```
Provide your container registry name when prompted.
In the VS Code terminal, navigate to the app/incidents folder and run the following command:
Shell
```
npm install && npm run build
```

Step 10 Deploy the application

Run the following command to create a namespace:

Shell
kubectl create namespace incident-management
kubectl label namespace incident-management istio-injection=enabled

Make sure that your SAP HANA Cloud instance is running. Free tier HANA instances are stopped overnight.
Your SAP HANA Cloud service instance is automatically stopped overnight, according to the time zone of the region where the server is located. That means you need to restart your instance every day before you start working with it.
You can either use the SAP BTP cockpit or the terminal in the SAP Business Application Studio to restart the stopped instance:
Shell
cf update-service incident-management -c '{"data":{"serviceStopped":false}}'

Deploy using the cds up command:

Shell

cds up -2 k8s --namespace incident-management

You may be asked to create your Docker imagePullSecret. If so, follow the provided instructions.
The cds up -2 k8s --namespace incident-management command installs the Helm chart from the chart folder with the release name incident-management in the namespace incident-management.
The outcome of the installation looks like this:
Deployed app

In the next tutorial, you can access your UIs from SAP Build Work Zone, standard edition. The SAP Build Work Zone, standard edition triggers the authentication flow to provide the required token to access the service.

Resources

Next Steps

TUTORIAL Set Up a CI/CD Pipeline for SAP BTP, Kyma Runtime ⏱ 60 min. +

Discussion

Share feedback on this tutorial or join the conversation in SAP Community.

Submit detailed feedback

Discuss in Community

Steps

1. Introduction

2. Install kubectl

3. Install kubelogin

4. Log in to your Kyma cluster

5. Install helm

6. Install Paketo (pack)

7. Install a container management app

8. Download and set up the project locally

9. Prepare your application

10. Deploy the application

Deploy in SAP BTP, Kyma Runtime

Overview

You will learn

Prerequisites

Prerequisites

Steps

Resources

Next Steps

Related Tutorials

Discussion

Joule

AI Notice