Deploying the Micro Integrator on Kubernetes using Helm Resources¶
Follow the instructions given below to deploy the Micro Integrator on Kubernetes (K8s) using Helm resources.
Before you begin¶
Be sure you have an active WSO2 Subscription. If you don't already have a subscription, sign up for a WSO2 Free Trial Subscription.
You need an active subscription to use the updated Docker images of the Micro Integrator with your Helm resources. Otherwise, you can use the community version of Docker images, which do not include product updates.
Install Git, Helm, Dep, and Kubernetes client.
Set up a Kubernetes cluster.
Install NGINX Ingress Controller.
Helm resources for WSO2 product deployment patterns are compatible with the
Step 1 - Get the Helm resources¶
Check out the Helm Resources for the WSO2 Micro Integrator Git repository.
- Open a terminal and navigate to the location where you want to save the local copy.
Clone the Micro Integrator Git repository with Helm resources:
git clone https://github.com/wso2/kubernetes-mi.git git checkout tags/v188.8.131.52
This creates a local copy of
wso2/kubernetes-mi, which includes all the Helm Resources for WSO2 Micro Integrator.
Let's refer to the root folder of the local copy as
Step 2 - Update the deployment configurations¶
Follow the steps given below to configure how your Micro Integrator deployment should be set up.
values.yamlfile in the `
/helm/micro-integrator folder of your local copy.
Before you do any changes, go through the default configurations in this file.
Use the following guidelines to update the deployment configurations:
Updating the WSO2 subscription details
You can update the user name and password in the following section. If you don't have an active WSO2 subscription, leave these parameters empty.
wso2: subscription: username: "<username>" password: "<password>"
Alternatively, you can skip this step and pass your subscription details at the time of deploying (see the next step for details).
Updating the Micro Integrator Docker images
By default, the
values.yamlfile uses the base Micro Integrator image (which does not include any integrations) to set up the deployment.
imageName: "wso2mi" imageTag: "4.0.0"
When you have a custom Docker image with integrations, uncomment the
dockerRegistryparameter and the details of your custom image.
dockerRegistry: "<docker_registry>" imageName: "<custom_mi_image>" imageTag: "<custom_image_tag>"
You can update other configurations as required.
Step 3 - Deploy the Micro Integrator¶
Once you have set up your Helm resources locally, follow the instructions given below to set up the deployment.
- Open a terminal and navigate to the `
Execute the command that is relevant to your Helm version.
Be sure to replace
NAMESPACEwith the Kubernetes namespace in which your resources are deployed.
Using Helm v2
helm install --name <RELEASE_NAME> wso2/micro-integrator --version 4.0.0-1 --namespace <NAMESPACE>
Using Helm v3
helm install <RELEASE_NAME> wso2/micro-integrator --version 4.0.0-1 --namespace <NAMESPACE> --create-namespace
Update configurations during deployment¶
If required, you can set any of the deployment configurations at the time of running the deployment (instead of
specifying them in the
values.yaml file). See the examples given below.
Setting the subscription username and password.
--set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME>
Setting the custom Micro Integrator Docker image.
--set wso2.deployment.mi.dockerRegistry=<CUSTOM_IMAGE_REGISTRY> --set wso2.deployment.mi.imageName=<CUSTOM_IMAGE_NAME> --set wso2.deployment.mi.imageTag=<CUSTOM_IMAGE_TAG>
Use the following parameter only if your custom Docker image is stored in a private Docker registry.
Your Micro Integrator Kubernetes cluster should now be created.
Step 4 - Access the Micro Integrator deployment¶
Go to your Kubernetes cluster from your terminal and follow the steps given below.
Get the external IP (
EXTERNAL-IP) of the Ingress resources by listing down the Kubernetes Ingresses.
kubectl get ing -n <NAMESPACE>
NAME HOSTS ADDRESS PORTS AGE <RELEASE_NAME>-micro-integrator-service-ingress mi.wso2.com <EXTERNAL-IP> 80, 443 3m <RELEASE_NAME>-micro-integrator-management-ingress management.mi.wso2.com <EXTERNAL-IP> 80, 443 3m
Add the above hosts in the
/etc/hostsfile as follows:
<EXTERNAL-IP> mi.wso2.com <EXTERNAL-IP> management.mi.wso2.com
Execute the following command to invoke health check services:
curl https://mi.wso2.com/healthz -k
Note that these instructions are for setting up a standalone deployment of the Micro Integrator. To set up one of the recommended deployment patterns, see the following topics:
- Using Helm Resources for a Standard HA Deployment of WSO2 API Manager
- Using Helm Resources for a Standard HA Deployment of WSO2 API Manager with Multitenancy
- Using Helm Resources for a Simple Scalable Deployment of WSO2 API Manager with Multitenancy