Deploying API-M on Kubernetes using Helm Resources

Follow the instructions below to use Kubernetes (K8s) and Helm resources for container-based deployments of WSO2 API Manager (API-M).

Note

• In the context of this document, <HELM_HOME> refers to a local copy of the wso2/helm-apim.

Prerequisites

• Install Git, Helm, Dep and Kubernetes client in order to run the steps provided in the following quick start guide.
  
  

• An already setup Kubernetes cluster.
  
  

• Configure one of the following for traffic routing:

  • Recommended: Gateway API with a Gateway API implementation such as Envoy Gateway. Steps to configure Gateway API with Envoy Gateway can be found here.
  • Legacy: If your environment still depends on Ingress resources you should install the NGINX Ingress Controller. Please note that Helm resources for WSO2 product deployment patterns are compatible with NGINX Ingress Controller Git release nginx-0.22.0.

1. Checkout the Helm Resources for WSO2 API Manager Git repository using git clone :

   git clone https://github.com/wso2/helm-apim.git
   cd helm-apim
   git checkout tags/all-in-one-4.3.0
   

2. Provide the necessary configurations.

   Note

   The default product configurations for deployment of WSO2 API Manager are available here folder. Change the configurations, as necessary.

   Open the <HELM_HOME>/all-in-one/values.yaml and provide the following values for WSO2 Subscription Configurations.

   Parameter	Description	Default Value
   wso2.deployment.image.registry	Registry of the APIM Docker image	""
   wso2.deployment.image.repository	Repostiory of the APIM Docker image	""
   wso2.deployment.image.digest	Digest of the APIM Docker image	""

3. Deploy WSO2 API Manager

   helm install --dependency-update <RELEASE_NAME> <HELM_HOME>/all-in-one --namespace <NAMESPACE>
   

4. Access Management Console.

   1. Obtain the external IP (EXTERNAL-IP) depending on your traffic routing method.

      If you are using Gateway API:

      kubectl get gateway -n <NAMESPACE>
      

      If you are using legacy Ingress:

      kubectl get ing -n <NAMESPACE>
      

      Example:

      NAME                                                CLASS   HOSTS                ADDRESS   PORTS     AGE
      
      <RELEASE_NAME>-am-all-in-one-am-gateway-ingress     nginx   gw.wso2.com          <ADDRESS> 80, 443   8s
      
      <RELEASE_NAME>-am-all-in-one-am-ingress             nginx   am.wso2.com          <ADDRESS> 80, 443   8s
      
      <RELEASE_NAME>-am-all-in-one-am-websocket-ingress   nginx   websocket.wso2.com   <ADDRESS> 80, 443   8s
      
      <RELEASE_NAME>-am-all-in-one-am-websub-ingress      nginx   websub.wso2.com      <ADDRESS> 80, 443   8s
      

   2. Add the above hosts as entries in /etc/hosts file as follows:

      <EXTERNAL-IP> am.wso2.com
      <EXTERNAL-IP> gw.wso2.com
      <EXTERNAL-IP> websocket.wso2.com
      <EXTERNAL-IP> websub.wso2.com
      

   3. Try navigating to https://am.wso2.com/carbon, https://am.wso2.com/publisher and https://am.wso2.com/devportal from your favorite browser.

Note

You can read the README guide of WSO2 API Manager Git repository for further details on other dependencies and configurations.

For different deployment patterns, see the deployment configurations with regard to the Advanced Deployment Patterns.