Resources for building a Helm chart for deployment of All-In-One WSO2 API Manager with WSO2 API Manager Analytics support.
For advanced details on the deployment pattern, please refer to the official documentation.
-
WSO2 product Docker images used for the Kubernetes deployment.
WSO2 product Docker images available at DockerHub package General Availability (GA) versions of WSO2 products with no WSO2 Updates.
For a production grade deployment of the desired WSO2 product-version, it is highly recommended to use the relevant Docker image which packages WSO2 Updates, available at WSO2 Private Docker Registry. In order to use these images, you need an active WSO2 Subscription.
-
Install Git, Helm 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.
-
Add the WSO2 Helm chart repository.
helm repo add wso2 https://helm.wso2.com && helm repo update
You can install the relevant Helm chart either from WSO2 Helm Chart Repository or by source.
Note:
NAMESPACEshould be the Kubernetes Namespace in which the resources are deployed.
Install Chart From WSO2 Helm Chart Repository
Helm version 2
helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 3.1.0-3 --namespace <NAMESPACE>
Helm version 3
-
Create the Kubernetes Namespace.
kubectl create ns <NAMESPACE> -
Deploy the Kubernetes resources using the Helm Chart
helm install <RELEASE_NAME> wso2/am-pattern-1 --version 3.1.0-3 --namespace <NAMESPACE>
The above steps will deploy the deployment pattern using WSO2 product Docker images available at DockerHub.
If you are using WSO2 product Docker images available from WSO2 Private Docker Registry,
please provide your WSO2 Subscription credentials via input values (using --set argument).
Please see the following example.
helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 3.1.0-3 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
In the context of this document,
KUBERNETES_HOMEwill refer to a local copy of thewso2/kubernetes-apimGit repository.HELM_HOMEwill refer to<KUBERNETES_HOME>/advanced.
git clone https://github.com/wso2/kubernetes-apim.git
Helm version 2
helm install --dep-up --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 3.1.0-3 --namespace <NAMESPACE>
Helm version 3
-
Create the Kubernetes Namespace to which you desire to deploy the Kubernetes resources.
kubectl create ns <NAMESPACE> -
Deploy the Kubernetes resources using the Helm Chart
helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 3.1.0-3 --namespace <NAMESPACE> --dependency-update
The above steps will deploy the deployment pattern using WSO2 product Docker images available at DockerHub.
If you are using WSO2 product Docker images available from WSO2 Private Docker Registry,
please provide your WSO2 Subscription credentials via input values (using --set argument).
Please see the following example.
helm install --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 3.1.0-3 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
Obtain the external IP (EXTERNAL-IP) of the API Manager Ingress resources, by listing down the Kubernetes Ingresses.
kubectl get ing -n <NAMESPACE>
The output under the relevant column stands for the following.
API Manager Publisher-DevPortal
- NAME: Metadata name of the Kubernetes Ingress resource (defaults to
wso2am-pattern-1-am-ingress) - HOSTS: Hostname of the WSO2 API Manager service (
<wso2.deployment.am.hostname>) - ADDRESS: External IP (
EXTERNAL-IP) exposing the API Manager service to outside of the Kubernetes environment - PORTS: Externally exposed service ports of the API Manager service
API Manager Gateway
- NAME: Metadata name of the Kubernetes Ingress resource (defaults to
wso2am-pattern-1-am-gateway-ingress) - HOSTS: Hostname of the WSO2 API Manager's Gateway service (
<wso2.deployment.am.gateway.hostname>) - ADDRESS: External IP (
EXTERNAL-IP) exposing the API Manager's Gateway service to outside of the Kubernetes environment - PORTS: Externally exposed service ports of the API Manager' Gateway service
API Manager Analytics Dashboard
- NAME: Metadata name of the Kubernetes Ingress resource (defaults to
wso2am-pattern-1-am-analytics-dashboard-ingress) - HOSTS: Hostname of the WSO2 API Manager Analytics Dashboard service (
<.wso2.deployment.analytics.dashboard.hostname>) - ADDRESS: External IP (
EXTERNAL-IP) exposing the API Manager Analytics Dashboard service to outside of the Kubernetes environment - PORTS: Externally exposed service ports of the API Manager Analytics Dashboard service
If the defined hostnames (in the previous step) are backed by a DNS service, add a DNS record mapping the hostnames and
the external IP (EXTERNAL-IP) in the relevant DNS service.
If the defined hostnames are not backed by a DNS service, for the purpose of evaluation you may add an entry mapping the
hostnames and the external IP in the /etc/hosts file at the client-side.
<EXTERNAL-IP> <wso2.deployment.am.hostname> <wso2.deployment.am.gateway.hostname> <wso2.deployment.analytics.dashboard.hostname>
-
API Manager Publisher:
https://<wso2.deployment.am.hostname>/publisher -
API Manager DevPortal:
https://<wso2.deployment.am.hostname>/devportal -
API Manager Analytics Dashboard:
https://<wso2.deployment.analytics.dashboard.hostname>/analytics-dashboard
The following tables lists the configurable parameters of the chart and their default values.
| Parameter | Description | Default Value |
|---|---|---|
wso2.subscription.username |
Your WSO2 Subscription username | - |
wso2.subscription.password |
Your WSO2 Subscription password | - |
If you do not have an active WSO2 subscription, do not change the parameters wso2.subscription.username and wso2.subscription.password.
| Parameter | Description | Default Value |
|---|---|---|
wso2.deployment.dependencies.mysql |
Enable the deployment and usage of WSO2 API Management MySQL based Helm Chart | true |
wso2.deployment.dependencies.nfsProvisioner |
Enable the deployment and usage of NFS Server Provisioner (https://github.com/helm/charts/tree/master/stable/nfs-server-provisioner) | true |
| Parameter | Description | Default Value |
|---|---|---|
wso2.deployment.persistentRuntimeArtifacts.storageClass |
Appropriate Kubernetes Storage Class | nfs |
wso2.deployment.persistentRuntimeArtifacts.sharedArtifacts.capacity.executionPlans |
Capacity for execution plans shared between the Traffic Manager profile instances | 20M |
wso2.deployment.persistentRuntimeArtifacts.sharedArtifacts.capacity.synapseConfigs |
Capacity for synapse artifacts of APIs shared between the Gateway profile instances | 50M |
wso2.deployment.persistentRuntimeArtifacts.apacheSolrIndexing.enabled |
Indicates if persistence of the runtime artifacts for Apache Solr-based indexing is enabled | false |
wso2.deployment.persistentRuntimeArtifacts.apacheSolrIndexing.capacity.carbonDatabase |
Capacity for persisting the H2 based local Carbon database file | 50M |
wso2.deployment.persistentRuntimeArtifacts.apacheSolrIndexing.capacity.solrIndexedData |
Capacity for persisting the Apache Solr indexed data | 50M |
| Parameter | Description | Default Value |
|---|---|---|
wso2.deployment.am.hostname |
Hostname for API Manager Publisher, DevPortal and Carbon Management Console | am.wso2.com |
wso2.deployment.am.gateway.hostname |
Hostname for API Manager Gateway | gateway.am.wso2.com |
wso2.deployment.am.dockerRegistry |
Registry location of the Docker image to be used to create API Manager instances | - |
wso2.deployment.am.imageName |
Name of the Docker image to be used to create API Manager instances | wso2am |
wso2.deployment.am.imageTag |
Tag of the image used to create API Manager instances | 3.1.0 |
wso2.deployment.am.imagePullPolicy |
Refer to doc | Always |
wso2.deployment.am.livenessProbe.initialDelaySeconds |
Initial delay for the live-ness probe for API Manager node | 180 |
wso2.deployment.am.livenessProbe.periodSeconds |
Period of the live-ness probe for API Manager node | 10 |
wso2.deployment.am.readinessProbe.initialDelaySeconds |
Initial delay for the readiness probe for API Manager node | 180 |
wso2.deployment.am.readinessProbe.periodSeconds |
Period of the readiness probe for API Manager node | 10 |
wso2.deployment.am.resources.requests.memory |
The minimum amount of memory that should be allocated for a Pod | 2Gi |
wso2.deployment.am.resources.requests.cpu |
The minimum amount of CPU that should be allocated for a Pod | 2000m |
wso2.deployment.am.resources.limits.memory |
The maximum amount of memory that should be allocated for a Pod | 3Gi |
wso2.deployment.am.resources.limits.cpu |
The maximum amount of CPU that should be allocated for a Pod | 3000m |
wso2.deployment.am.config |
Custom deployment configuration file (<WSO2AM>/repository/conf/deployment.toml) |
- |
Note: The above mentioned default, minimum resource amounts for running WSO2 API Manager server profiles are based on its official documentation.
| Parameter | Description | Default Value |
|---|---|---|
wso2.deployment.analytics.dashboard.hostname |
Hostname for API Manager Analytics Dashboard | analytics.am.wso2.com |
wso2.deployment.analytics.dashboard.dockerRegistry |
Registry location of the Docker image to be used to create an API Manager Analytics instance | - |
wso2.deployment.analytics.dashboard.imageName |
Name of the Docker image to be used to create an API Manager Analytics instance | wso2am-analytics-dashboard |
wso2.deployment.analytics.dashboard.imageTag |
Tag of the image used to create an API Manager Analytics instance | 3.1.0 |
wso2.deployment.analytics.dashboard.imagePullPolicy |
Refer to doc | Always |
wso2.deployment.analytics.dashboard.replicas |
Number of replicas of API Manager Analytics to be started | 1 |
wso2.deployment.analytics.dashboard.strategy.rollingUpdate.maxSurge |
Refer to doc | 1 |
wso2.deployment.analytics.dashboard.strategy.rollingUpdate.maxUnavailable |
Refer to doc | 0 |
wso2.deployment.analytics.dashboard.livenessProbe.initialDelaySeconds |
Initial delay for the live-ness probe for API Manager Analytics node | 20 |
wso2.deployment.analytics.dashboard.livenessProbe.periodSeconds |
Period of the live-ness probe for API Manager Analytics node | 10 |
wso2.deployment.analytics.dashboard.readinessProbe.initialDelaySeconds |
Initial delay for the readiness probe for API Manager Analytics node | 20 |
wso2.deployment.analytics.dashboard.readinessProbe.periodSeconds |
Period of the readiness probe for API Manager Analytics node | 10 |
wso2.deployment.analytics.dashboard.resources.requests.memory |
The minimum amount of memory that should be allocated for a Pod | 4Gi |
wso2.deployment.analytics.dashboard.resources.requests.cpu |
The minimum amount of CPU that should be allocated for a Pod | 2000m |
wso2.deployment.analytics.dashboard.resources.limits.memory |
The maximum amount of memory that should be allocated for a Pod | 4Gi |
wso2.deployment.analytics.dashboard.resources.limits.cpu |
The maximum amount of CPU that should be allocated for a Pod | 2000m |
wso2.deployment.analytics.dashboard.config |
Custom deployment configuration file (<WSO2AM_ANALYTICS>/conf/dashboard/deployment.yaml) |
- |
| Parameter | Description | Default Value |
|---|---|---|
wso2.deployment.analytics.worker.dockerRegistry |
Registry location of the Docker image to be used to create an API Manager Analytics instance | - |
wso2.deployment.analytics.worker.imageName |
Name of the Docker image to be used to create an API Manager Analytics instance | wso2am-analytics-worker |
wso2.deployment.analytics.worker.imageTag |
Tag of the image used to create an API Manager Analytics instance | 3.1.0 |
wso2.deployment.analytics.worker.imagePullPolicy |
Refer to doc | Always |
wso2.deployment.analytics.worker.livenessProbe.initialDelaySeconds |
Initial delay for the live-ness probe for API Manager Analytics node | 20 |
wso2.deployment.analytics.worker.livenessProbe.periodSeconds |
Period of the live-ness probe for API Manager Analytics node | 10 |
wso2.deployment.analytics.worker.readinessProbe.initialDelaySeconds |
Initial delay for the readiness probe for API Manager Analytics node | 20 |
wso2.deployment.analytics.worker.readinessProbe.periodSeconds |
Period of the readiness probe for API Manager Analytics node | 10 |
wso2.deployment.analytics.worker.resources.requests.memory |
The minimum amount of memory that should be allocated for a Pod | 4Gi |
wso2.deployment.analytics.worker.resources.requests.cpu |
The minimum amount of CPU that should be allocated for a Pod | 2000m |
wso2.deployment.analytics.worker.resources.limits.memory |
The maximum amount of memory that should be allocated for a Pod | 4Gi |
wso2.deployment.analytics.worker.resources.limits.cpu |
The maximum amount of CPU that should be allocated for a Pod | 2000m |
| Parameter | Description | Default Value |
|---|---|---|
kubernetes.serviceAccount |
Name of the Kubernetes Service Account to which the Pods are to be bound | wso2am-pattern-1-svc-account |