Helm Chart for a deployment of Integrator and Broker profiles of WSO2 Enterprise Integrator with Analytics

Prerequisites

In order to use WSO2 Helm resources, you need an active WSO2 subscription. If you do not possess an active WSO2 subscription already, you can sign up for a WSO2 Free Trial Subscription from here. Otherwise you can proceed with Docker images which are created using GA releases.
Install Git, Helm (and Tiller) 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

Quick Start Guide

In the context of this document,

KUBERNETES_HOME will refer to a local copy of the wso2/kubernetes-ei Git repository.

HELM_HOME will refer to <KUBERNETES_HOME>/advanced/ei-pattern-2.

1. Clone Kubernetes Resources for WSO2 Enterprise Integrator Git repository.

git clone https://github.com/wso2/kubernetes-ei.git

2. Provide configurations.

a. The default product configurations are available at <HELM_HOME>/confs folder. Change the configurations as necessary.

b. Open the <HELM_HOME>/values.yaml and provide the following values.

MySQL Configurations

Parameter	Description	Default Value
`wso2.mysql.enabled`	Enable MySQL chart as a dependency	true
`wso2.mysql.host`	Set MySQL server host	wso2ei-rdbms-service-mysql
`wso2.mysql.username`	Set MySQL server username	wso2carbon
`wso2.mysql.password`	Set MySQL server password	wso2carbon
`wso2.mysql.driverClass`	Set JDBC driver class for MySQL	com.mysql.jdbc.Driver
`wso2.mysql.validationQuery`	Validation query for the MySQL server	SELECT 1

WSO2 Subscription Configurations

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.

Centralized Logging Configurations

Parameter	Description	Default Value
`wso2.centralizedLogging.enabled`	Enable Centralized logging for WSO2 components	true
`wso2.centralizedLogging.logstash.imageTag`	Logstash Sidecar container image tag	7.2.0
`wso2.centralizedLogging.logstash.elasticsearch.username`	Elasticsearch username	elastic
`wso2.centralizedLogging.logstash.elasticsearch.password`	Elasticsearch password	changeme
`wso2.centralizedLogging.logstash.indexNodeID.wso2ISNode`	Elasticsearch IS Node log index ID(index name: ${NODE_ID}-${NODE_IP})	wso2

Monitoring Configurations

Parameter	Description	Default Value
`wso2.monitoring.enabled`	Enable Prometheus monitoring	false
`wso2.monitoring.prometheus.blackBoxNamespace`	Prometheus blackbox exporter namespace	<RELEASE_NAMESPACE>
`wso2.monitoring.prometheus.jmxJobName`	Prometheus job name	jmx
`wso2.monitoring.prometheus.serviceMonitor.labels`	Prometheus labels for identifying Service Monitor	"release: monitoring"

Integrator Profile Configurations

Parameter	Description	Default Value
`wso2.deployment.wso2ei.imageName`	Image name for Integrator node	wso2ei-integrator
`wso2.deployment.wso2ei.imageTag`	Image tag for Integrator node	6.6.0
`wso2.deployment.wso2ei.replicas`	Number of Integrator replicas	1
`wso2.deployment.wso2ei.minReadySeconds`	Refer to doc	75
`wso2.deployment.wso2ei.strategy.rollingUpdate.maxSurge`	Refer to doc	1
`wso2.deployment.wso2ei.strategy.rollingUpdate.maxUnavailable`	Refer to doc	0
`wso2.deployment.wso2ei.livenessProbe.initialDelaySeconds`	Period of initial delay for the liveness probe for Integrator profile node	40
`wso2.deployment.wso2ei.livenessProbe.periodSeconds`	Period of the liveness probe for Integrator profile node	10
`wso2.deployment.wso2ei.readinessProbe.initialDelaySeconds`	Period of initial delay for the readiness probe Integrator profile node	40
`wso2.deployment.wso2ei.readinessProbe.periodSeconds`	Period of the readiness probe for Integrator profile node	10
`wso2.deployment.wso2ei.imagePullPolicy`	Refer to doc	Always
`wso2.deployment.wso2ei.resources.requests.memory`	The minimum amount of memory that should be allocated for a Pod	1Gi
`wso2.deployment.wso2ei.resources.requests.cpu`	The minimum amount of CPU that should be allocated for a Pod	1000m
`wso2.deployment.wso2ei.resources.limits.memory`	The maximum amount of memory that should be allocated for a Pod	2Gi
`wso2.deployment.wso2ei.resources.limits.cpu`	The maximum amount of CPU that should be allocated for a Pod	2000m

Broker Profile Configurations

Parameter	Description	Default Value
`wso2.deployment.wso2eiBroker.imageName`	Image name for Broker node	wso2ei-broker
`wso2.deployment.wso2eiBroker.imageTag`	Image tag for Broker node	6.6.0
`wso2.deployment.wso2eiBroker.replicas`	Number of Broker replicas	1
`wso2.deployment.wso2eiBroker.minReadySeconds`	Refer to doc	75
`wso2.deployment.wso2eiBroker.strategy.rollingUpdate.maxSurge`	Refer to doc	1
`wso2.deployment.wso2eiBroker.strategy.rollingUpdate.maxUnavailable`	Refer to doc	0
`wso2.deployment.wso2eiBroker.livenessProbe.initialDelaySeconds`	Period of initial delay for the liveness probe for Broker profile node	40
`wso2.deployment.wso2eiBroker.livenessProbe.periodSeconds`	Period of the liveness probe for Broker profile node	10
`wso2.deployment.wso2eiBroker.readinessProbe.initialDelaySeconds`	Period of initial delay for the readiness probe Broker profile node	40
`wso2.deployment.wso2eiBroker.readinessProbe.periodSeconds`	Period of the readiness probe for Broker profile node	10
`wso2.deployment.wso2eiBroker.imagePullPolicy`	Refer to doc	Always
`wso2.deployment.wso2eiBroker.resources.requests.memory`	The minimum amount of memory that should be allocated for a Pod	1Gi
`wso2.deployment.wso2eiBroker.resources.requests.cpu`	The minimum amount of CPU that should be allocated for a Pod	1000m
`wso2.deployment.wso2eiBroker.resources.limits.memory`	The maximum amount of memory that should be allocated for a Pod	2Gi
`wso2.deployment.wso2eiBroker.resources.limits.cpu`	The maximum amount of CPU that should be allocated for a Pod	2000m

Note: The above mentioned default, minimum resource amounts for running WSO2 Enterprise Integrator server profiles (Broker and Integrator)are based on its official documentation.

Analytics Dashboard Runtime Configurations

Parameter	Description	Default Value
`wso2.deployment.wso2eiAnalyticsDashboard.imageName`	Image name for Analytics Dashbaord node	wso2ei-analytics-dashboard
`wso2.deployment.wso2eiAnalyticsDashboard.imageTag`	Image tag for Analytics Dashbaord node	6.6.0
`wso2.deployment.wso2eiAnalyticsDashboard.replicas`	Number of Analytics Dashbaord replicas	1
`wso2.deployment.wso2eiAnalyticsDashboard.minReadySeconds`	Refer to doc	30
`wso2.deployment.wso2eiAnalyticsDashboard.strategy.rollingUpdate.maxSurge`	Refer to doc	1
`wso2.deployment.wso2eiAnalyticsDashboard.strategy.rollingUpdate.maxUnavailable`	Refer to doc	0
`wso2.deployment.wso2eiAnalyticsDashboard.livenessProbe.initialDelaySeconds`	Period of initial delay for the liveness probe for Analytics Dashbaord node	20
`wso2.deployment.wso2eiAnalyticsDashboard.livenessProbe.periodSeconds`	Period of the liveness probe for Analytics Dashbaord node	10
`wso2.deployment.wso2eiAnalyticsDashboard.readinessProbe.initialDelaySeconds`	Period of initial delay for the readiness probe Analytics Dashbaord node	20
`wso2.deployment.wso2eiAnalyticsDashboard.readinessProbe.periodSeconds`	Period of the readiness probe for Analytics Dashbaord node	10
`wso2.deployment.wso2eiAnalyticsDashboard.imagePullPolicy`	Refer to doc	Always
`wso2.deployment.wso2eiAnalyticsDashboard.resources.requests.memory`	The minimum amount of memory that should be allocated for a Pod	4Gi
`wso2.deployment.wso2eiAnalyticsDashboard.resources.requests.cpu`	The minimum amount of CPU that should be allocated for a Pod	2000m
`wso2.deployment.wso2eiAnalyticsDashboard.resources.limits.memory`	The maximum amount of memory that should be allocated for a Pod	4Gi
`wso2.deployment.wso2eiAnalyticsDashboard.resources.limits.cpu`	The maximum amount of CPU that should be allocated for a Pod	2000m

Analytics Worker Runtime Configurations

Parameter	Description	Default Value
`wso2.deployment.wso2eiAnalyticsWorker.imageName`	Image name for Analytics Worker node	wso2ei-analytics-worker
`wso2.deployment.wso2eiAnalyticsWorker.imageTag`	Image tag for Analytics Worker node	6.6.0
`wso2.deployment.wso2eiAnalyticsWorker.replicas`	Number of Analytics Worker replicas	2
`wso2.deployment.wso2eiAnalyticsWorker.minReadySeconds`	Refer to doc	30
`wso2.deployment.wso2eiAnalyticsWorker.strategy.rollingUpdate.maxSurge`	Refer to doc	2
`wso2.deployment.wso2eiAnalyticsWorker.strategy.rollingUpdate.maxUnavailable`	Refer to doc	0
`wso2.deployment.wso2eiAnalyticsWorker.livenessProbe.initialDelaySeconds`	Period of initial delay for the liveness probe for Analytics Worker node	20
`wso2.deployment.wso2eiAnalyticsWorker.livenessProbe.periodSeconds`	Period of the liveness probe for Analytics Worker node	10
`wso2.deployment.wso2eiAnalyticsWorker.readinessProbe.initialDelaySeconds`	Period of initial delay for the readiness probe Analytics Worker node	20
`wso2.deployment.wso2eiAnalyticsWorker.readinessProbe.periodSeconds`	Period of the readiness probe for Analytics Worker node	10
`wso2.deployment.wso2eiAnalyticsWorker.imagePullPolicy`	Refer to doc	Always
`wso2.deployment.wso2eiAnalyticsWorker.resources.requests.memory`	The minimum amount of memory that should be allocated for a Pod	4Gi
`wso2.deployment.wso2eiAnalyticsWorker.resources.requests.cpu`	The minimum amount of CPU that should be allocated for a Pod	2000m
`wso2.deployment.wso2eiAnalyticsWorker.resources.limits.memory`	The maximum amount of memory that should be allocated for a Pod	4Gi
`wso2.deployment.wso2eiAnalyticsWorker.resources.limits.cpu`	The maximum amount of CPU that should be allocated for a Pod	2000m

Analytics Worker Instance One Runtime Configurations

Parameter	Description	Default Value
`wso2.deployment.wso2eiAnalyticsWorker1.imageName`	Image name for EI Analytics Worker node	wso2ei-analytics-worker
`wso2.deployment.wso2eiAnalyticsWorker1.imageTag`	Image tag for EI Analytics Worker node	6.6.0
`wso2.deployment.wso2eiAnalyticsWorker1.replicas`	Number of replicas for EI node	1
`wso2.deployment.wso2eiAnalyticsWorker1.minReadySeconds`	Refer to doc	30
`wso2.deployment.wso2eiAnalyticsWorker1.strategy.rollingUpdate.maxSurge`	Refer to doc	2
`wso2.deployment.wso2eiAnalyticsWorker1.strategy.rollingUpdate.maxUnavailable`	Refer to doc	0
`wso2.deployment.wso2eiAnalyticsWorker1.livenessProbe.initialDelaySeconds`	Initial delay for the live-ness probe for EI Analytics Worker node	20
`wso2.deployment.wso2eiAnalyticsWorker1.livenessProbe.periodSeconds`	Period of the live-ness probe for EI Analytics Worker node	10
`wso2.deployment.wso2eiAnalyticsWorker1.readinessProbe.initialDelaySeconds`	Initial delay for the readiness probe for EI Analytics Worker node	20
`wso2.deployment.wso2eiAnalyticsWorker1.readinessProbe.periodSeconds`	Period of the readiness probe for EI Analytics Worker node	10
`wso2.deployment.wso2eiAnalyticsWorker1.imagePullPolicy`	Refer to doc	Always
`wso2.deployment.wso2eiAnalyticsWorker1.resources.requests.memory`	The minimum amount of memory that should be allocated for a Pod	4Gi
`wso2.deployment.wso2eiAnalyticsWorker1.resources.requests.cpu`	The minimum amount of CPU that should be allocated for a Pod	2000m
`wso2.deployment.wso2eiAnalyticsWorker1.resources.limits.memory`	The maximum amount of memory that should be allocated for a Pod	4Gi
`wso2.deployment.wso2eiAnalyticsWorker1.resources.limits.cpu`	The maximum amount of CPU that should be allocated for a Pod	2000m

Analytics Worker Instance Two Runtime Configurations

Parameter	Description	Default Value
`wso2.deployment.wso2eiAnalyticsWorker2.imageName`	Image name for EI Analytics Worker node	wso2ei-analytics-worker
`wso2.deployment.wso2eiAnalyticsWorker2.imageTag`	Image tag for EI Analytics Worker node	6.6.0
`wso2.deployment.wso2eiAnalyticsWorker2.replicas`	Number of replicas for EI node	1
`wso2.deployment.wso2eiAnalyticsWorker2.minReadySeconds`	Refer to doc	30
`wso2.deployment.wso2eiAnalyticsWorker2.strategy.rollingUpdate.maxSurge`	Refer to doc	2
`wso2.deployment.wso2eiAnalyticsWorker2.strategy.rollingUpdate.maxUnavailable`	Refer to doc	0
`wso2.deployment.wso2eiAnalyticsWorker2.livenessProbe.initialDelaySeconds`	Initial delay for the live-ness probe for EI Analytics Worker node	20
`wso2.deployment.wso2eiAnalyticsWorker2.livenessProbe.periodSeconds`	Period of the live-ness probe for EI Analytics Worker node	10
`wso2.deployment.wso2eiAnalyticsWorker2.readinessProbe.initialDelaySeconds`	Initial delay for the readiness probe for EI Analytics Worker node	20
`wso2.deployment.wso2eiAnalyticsWorker2.readinessProbe.periodSeconds`	Period of the readiness probe for EI Analytics Worker node	10
`wso2.deployment.wso2eiAnalyticsWorker2.imagePullPolicy`	Refer to doc	Always
`wso2.deployment.wso2eiAnalyticsWorker2.resources.requests.memory`	The minimum amount of memory that should be allocated for a Pod	4Gi
`wso2.deployment.wso2eiAnalyticsWorker2.resources.requests.cpu`	The minimum amount of CPU that should be allocated for a Pod	2000m
`wso2.deployment.wso2eiAnalyticsWorker2.resources.limits.memory`	The maximum amount of memory that should be allocated for a Pod	4Gi
`wso2.deployment.wso2eiAnalyticsWorker2.resources.limits.cpu`	The maximum amount of CPU that should be allocated for a Pod	2000m

Note: The above mentioned default, minimum resource amounts for running WSO2 Stream Processor server profiles (Dashboard and Worker)are based on its official documentation. Also, see the official documentation on WSO2 Stream Processor based Performance Analysis and Resource recommendations and tune the limits according to your needs, where necessary.

Kubernetes Configurations

Parameter	Description	Default Value
`kubernetes.svcaccount`	Kubernetes Service Account in the `namespace` to which product instance pods are attached	wso2svc-account

3. Deploy WSO2 Enterprise Integrator and Broker with Analytics.

helm install --dep-up --name <RELEASE_NAME> <HELM_HOME>/ei-pattern-2 --namespace <NAMESPACE>

NAMESPACE should be the Kubernetes Namespace in which the resources are deployed.

4. Access product management consoles.

Default deployment will expose <RELEASE_NAME>-integrator, <RELEASE_NAME>-broker, <RELEASE_NAME>-gateway and <RELEASE_NAME>-analytics-dashboard hosts.

To access the console in the environment,

a. Obtain the external IP (EXTERNAL-IP) of the Ingress resources by listing down the Kubernetes Ingresses.

kubectl get ing --namespace <NAMESPACE>

e.g.

NAME                                                  HOSTS                               ADDRESS        PORTS     AGE
wso2ei-pattern-2-analytics-dashboard-ingress          <RELEASE_NAME>-analytics-dashboard  <EXTERNAL-IP>  80, 443   2m
wso2ei-pattern-2-integrator-gateway-tls-ingress       <RELEASE_NAME>-gateway              <EXTERNAL-IP>  80, 443   2m
wso2ei-pattern-2-integrator-ingress                   <RELEASE_NAME>-integrator           <EXTERNAL-IP>  80, 443   2m
wso2ei-pattern-2-mb-ingress                           <RELEASE_NAME>-broker               <EXTERNAL-IP>  80, 443   2m

b. Add the above host as an entry in /etc/hosts file as follows:

<EXTERNAL-IP>	<RELEASE_NAME>-analytics-dashboard
<EXTERNAL-IP>	<RELEASE_NAME>-gateway
<EXTERNAL-IP>	<RELEASE_NAME>-integrator
<EXTERNAL-IP>	<RELEASE_NAME>-broker

c. Try navigating to https://<RELEASE_NAME>-integrator/carbon, https://<RELEASE_NAME>-broker/carbon and https://<RELEASE_NAME>-analytics-dashboard/portal from your favorite browser.

Enabling Centralized Logging

Centralized logging with Logstash and Elasticsearch is disabled by default. However, if it is required to be enabled, the following steps should be followed.

Set centralizedLogging.enabled to true in the values.yaml file.
Add elasticsearch Helm repository to download sub-charts required for Centralized logging.

helm repo add elasticsearch https://helm.elastic.co

Add the following dependencies in the requirements.yaml file.

dependencies:
  - name: kibana
    version: "7.2.1-0"
    repository: "https://helm.elastic.co"
    condition: wso2.centralizedLogging.enabled
  - name: elasticsearch
    version: "7.2.1-0"
    repository: "https://helm.elastic.co"
    condition: wso2.centralizedLogging.enabled

Add override configurations for Elasticsearch in the values.yaml file.

wso2:
  ( ... )
  
elasticsearch:
  clusterName: wso2-elasticsearch

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Helm Chart for a deployment of Integrator and Broker profiles of WSO2 Enterprise Integrator with Analytics

Contents

Prerequisites

Quick Start Guide

1. Clone Kubernetes Resources for WSO2 Enterprise Integrator Git repository.

2. Provide configurations.

MySQL Configurations

WSO2 Subscription Configurations

Centralized Logging Configurations

Monitoring Configurations

Integrator Profile Configurations

Broker Profile Configurations

Analytics Dashboard Runtime Configurations

Analytics Worker Runtime Configurations

Analytics Worker Instance One Runtime Configurations

Analytics Worker Instance Two Runtime Configurations

Kubernetes Configurations

3. Deploy WSO2 Enterprise Integrator and Broker with Analytics.

4. Access product management consoles.

Enabling Centralized Logging

Files

README.md

Latest commit

History

README.md

File metadata and controls

Helm Chart for a deployment of Integrator and Broker profiles of WSO2 Enterprise Integrator with Analytics

Contents

Prerequisites

Quick Start Guide

1. Clone Kubernetes Resources for WSO2 Enterprise Integrator Git repository.

2. Provide configurations.

MySQL Configurations

WSO2 Subscription Configurations

Centralized Logging Configurations

Monitoring Configurations

Integrator Profile Configurations

Broker Profile Configurations

Analytics Dashboard Runtime Configurations

Analytics Worker Runtime Configurations

Analytics Worker Instance One Runtime Configurations

Analytics Worker Instance Two Runtime Configurations

Kubernetes Configurations

3. Deploy WSO2 Enterprise Integrator and Broker with Analytics.

4. Access product management consoles.

Enabling Centralized Logging