Skip to content

Install with Helm

Before you begin...

Install the prerequisites that are required to run WSO2 API Platform For Kubernetes.

Start WSO2 API Platform For Kubernetes

Follow the instructions below to deploy APK Data Service (DS) servers and the Cloud Native Postgres(CloudNativePG) in the Kubernetes cluster.

Install APK

  1. Create a new helm repository with the latest apk release using the following command. Let’s consider the <repository-name> as wso2apk for this guide.

    helm repo add wso2apk
  2. Execute the following command to update the helm repositories.

    helm repo update
  3. Install the APK components and start WSO2 API Platform For Kubernetes. Consider apk as the <chart-name> for this guide. As the --version of this command, use the version of the release you used in point 1 above. It will take a few minutes for the deployment to complete.

helm install apk wso2apk/apk-helm --version 1.1.0
helm install <chart-name> <repository-name>/apk-helm --version <version-of-APK>


To commence the installation while making use of the customization capabilities inherent in the values.yaml file, follow the subsequent command format. Instructions in Customize Configurations will guide you through the process of acquiring the values.yaml file.

helm install apk wso2apk/apk-helm --version 1.1.0 -f values.yaml
helm install <chart-name> <repository-name>/apk-helm --version <version-of-APK> -f <path-to-values.yaml-file>

If you want to update the values of an existing APK installation, please execute the following helm upgrade command. Use the --no-hooks flag to disable the hooks available in the APK helm chart.

helm upgrade apk wso2apk/apk-helm --version 1.1.0 -f values.yaml --no-hooks
helm upgrade <chart-name> <repository-name>/apk-helm --version <version-of-APK> -f <path-to-values.yaml-file> --no-hooks

Verify the deployment

Now you can verify the deployment by executing the following command. You will see the status of the pods as follows once completed.

kubectl get pods

Pod Status


If pods are not transitioning to running state, please follow the steps in the FAQs to troubleshoot the problem.