"How to install and use Kyma CLI How to create a Kyma Function"

"What do I need before I start?"

" You have created and set up your \u0026ldquo;SAP BTP, Kyma Environment\u0026rdquo; either manually or by Quick Account Setup. You have added the Serverless module to your Kyma environment. You have completed the Install the Kubernetes Command Line Tool tutorial. "

Create Kyma Function Using Kyma CLI

Overview

You will learn

✔How to install and use Kyma CLI
✔How to create a Kyma Function

G Gaurav Abbi, Oliver Stiefbold, Malgorzata Swieca, Jacek Konopelski August 21, 2026

Created on December 17, 2024

Contributors

Prerequisites

You have created and set up your “SAP BTP, Kyma Environment” either manually or by Quick Account Setup.
You have added the Serverless module to your Kyma environment.
You have completed the Install the Kubernetes Command Line Tool tutorial.

Steps

Windows

macOS

Linux

BAS

Step 1 Install Kyma CLI

—

To install Kyma CLI, run the following command:
Shell
```
brew install kyma-cli
```
Check if the installation is successful:
Shell
```
kyma version
```

You should see a version number.

To install Kyma CLI, go to the Kyma CLI GitHub release page and download the relevant Windows binary files.

Step 2 Create a Function

Enable the Istio sidecar proxy injection in the default namespace:
bash/Powershell
```
kubectl label namespace default istio-injection=enabled --overwrite
```
If you create a Function in a namespace with enabled Istio sidecar injection, an Istio sidecar proxy is automatically injected to the Function’s Pod during its creation. This makes the Function part of the Istio service mesh. To expose a workload using an APIRule custom resource, it is required to include the workload in the Istio service mesh.
In your terminal, go to your working folder, and run:
bash/Powershell
```
kyma function init
```
If successful, you get the following message: Functions files of runtime nodejs22 initialized to dir {WORKING_FOLDER_PATH}
You have created 2 files in your working folder:
- handler.js
- package.json
You can check the content of the files with your editor (e.g. Visual Studio Code).
To apply your Function to your Kyma runtime, run:
bash/Powershell
```
kyma function create hello-function
```
If successful, you get the following message:
bash/Powershell
```
resource default/hello-function applied
```

To verify the Function deployment, run:

bash/Powershell

kyma function get hello-function

If successful, you get the following result:

bash/Powershell

NAME             CONFIGURED   BUILT   RUNNING   RUNTIME    GENERATION
hello-function   True         True    True      nodejs22   1

Step 3 Expose the Function

In your working folder, create a new YAML file named myapirule.yaml. You can do this using a text editor or by running touch myapirule.yaml in your terminal.

Open the file in your editor and add the following APIRule definition:

YAML
apiVersion: gateway.kyma-project.io/v2
kind: APIRule
metadata:
  name: hello-rule
  namespace: default
spec:
  hosts:
    - hello-host
  service:
    name: hello-function
    port: 80
  gateway: kyma-system/kyma-gateway
  rules:
    - path: /*
      methods: ["GET", "POST"]
      noAuth: true

Deploy your APIRule.

bash/Powershell

kubectl apply -f "{PATH_TO_YOUR_CONFIG_FILE}"

For example:

bash/Powershell

kubectl apply -f "C:\tools\myapirule.yaml"

Step 4 Verify the Function exposure

Run the following command to get the domain name of your Kyma cluster:
Shell
```
kubectl get gateway -n kyma-system kyma-gateway -o jsonpath='{.spec.servers[0].hosts[0]}'
```
You see output similar to this:
Shell
```
*.12345678.kyma.ondemand.com
```
Export the result without the leading *. as an environment variable:
Shell
```
export CLUSTER_DOMAIN={DOMAIN_NAME}
```
For example:
Shell
```
export CLUSTER_DOMAIN=12345678.kyma.ondemand.com
```
Run the following curl command:
Shell
```
curl https://hello-host.$CLUSTER_DOMAIN
```

If the deployment was successful, you see the Hello World! message.

Run the following command to get the domain name of your Kyma cluster:
PowerShell
```
kubectl get gateway -n kyma-system kyma-gateway -o jsonpath='{.spec.servers[0].hosts[0]}'
```
You see output similar to this:
PowerShell
```
*.12345678.kyma.ondemand.com
```
Replace the placeholder and export the result as an environment variable without the leading *.:
PowerShell
```
$Env:CLUSTER_DOMAIN="{YOUR_CLUSTER_DOMAIN}"
```
For example:
PowerShell
```
$Env:CLUSTER_DOMAIN="12345678.kyma.ondemand.com"
```

Run the following curl command:

PowerShell
Invoke-RestMethod -Uri "hello-host.$Env:CLUSTER_DOMAIN" -Method GET

If the deployment was successful, you see the Hello World! message.

Resources

Next Steps

Discussion

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

Submit detailed feedback

Discuss in Community

Create Kyma Function Using Kyma CLI

Overview

You will learn

Prerequisites

Prerequisites

Steps

Resources

Next Steps

Related Tutorials

Discussion

Joule

AI Notice