Deploying API-M on Kubernetes using Helm Resources

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

Note

• In the context of this document, <HELM_HOME> refers to a local copy of the oxynexus/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.
  
  

• Install NGINX Ingress Controller. Please note that Helm resources for OxyNexus product deployment patterns are compatible with NGINX Ingress Controller Git release nginx-0.22.0.

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

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

2. Provide the necessary configurations.

   Note

   The default product configurations for deployment of OxyNexus 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 OxyNexus Subscription Configurations.

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

3. Deploy OxyNexus 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) of the Ingress resources by listing down the Kubernetes Ingresses.

      kubectl get ing -n <NAMESPACE>
      

      Example: NAME CLASS HOSTS ADDRESS PORTS AGE -am-all-in-one-am-gateway-ingress nginx gw.oxynexus.com 80, 443 8s -am-all-in-one-am-ingress nginx am.oxynexus.com 80, 443 8s -am-all-in-one-am-websocket-ingress nginx websocket.oxynexus.com 80, 443 8s -am-all-in-one-am-websub-ingress nginx websub.oxynexus.com 80, 443 8s ```

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

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

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

Note

You can read the README guide of OxyNexus 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.