Skip to content

Install Kubernetes Gateway Agent with Enterprise Helm Chart

Before you begin...

Install the prerequisites that are required to run WSO2 Kubernetes Gateway.

Start WSO2 Kubernetes Gateway Enterprise Version

  1. Create WSO2 Kubernetes Gateway image pull secrets with your WSO2 credentials as shown below and apply this in K8s.

    console kubectl create secret docker-registry apk-registry-secret --docker-server=docker.wso2.com --docker-username=<username> --docker-password=<password> --docker-email=<email>

    Note

    If you don't have a WSO2 user account, we've created one and sent you the details. If you already have an account, just use your existing credentials.

  2. Add the WSO2 Kubernetes Gateway Helm repository.

    console helm repo add wso2 https://helm.wso2.com

  3. Execute the following command to update the helm repositories.

    console helm repo update

  4. Install the Kubernetes Gateway Agent components and start WSO2 Kubernetes Gateway. Consider apim-apk-agent 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 for amd64

helm install apim-apk-agent wso2/apim-apk-agent --version 1.3.0 --set wso2.subscription.imagePullSecrets="apk-registry-secret"

helm install <chart-name> <repository-name>/apim-apk-agent --version <version-of-APIM-APK-Agent> --set wso2.subscription.imagePullSecrets=<secret-name>

Helm install for arm64

helm install apim-apk-agent wso2/apim-apk-agent --version 1.3.0 --set image.tag="1.3.0.0-arm64" --set wso2.subscription.imagePullSecrets="apk-registry-secret"

helm install <chart-name> <repository-name>/apim-apk-agent --version <version-of-APK> --set image.tag="1.3.0.0-arm64" --set wso2.subscription.imagePullSecrets=<secret-name>

Optional

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

helm install apim-apk-agent wso2/apim-apk-agent --version 1.3.0 -set wso2.subscription.imagePullSecrets="apk-registry-secret" -f values.yaml

helm install <chart-name> <repository-name>/apim-apk-agent --version <version-of-APIM-APK-Agent> --set wso2.subscription.imagePullSecrets=<secret-name> -f <path-to-values.yaml-file>

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

Important

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