Helm chart for the deployment of WSO2 Streaming Integrator

This module contains the Helm resources required to deploy WSO2 Streaming Integrator in a Kubernetes environment.

Prerequisites

• WSO2 Product Docker images required for the deployment.
• It is recommended to push your own images to the cloud provider's container registry (ACR, ECR, etc.) as a best practice. Refer U2 documentation for any additional information.

Note that you need a valid WSO2 subscription to obtain the U2 updated docker images from the WSO2 private registry.

• A running Kubernetes cluster (AKS, EKS, etc.)

• Ingress controller for routing traffic. The recommendation is to use NGINX Ingress Controller suitable for your cloud environment. Basic configurations for the NGINX Ingress Controller are as follows. Other supported ingress controllers specific to provider can be fount at Supported Cluster providers.

wso2:
  ingress:
    enabled: true
    ingressClassName: "nginx"
    annotations:
      nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"

• If you are enabling secure vault configurations for the product, you need to configure the secret manager service of the respective cloud provider. Since the secrets are encrypted using the internal keystore password, that password should be included in the key vault so that it can be resolved using a CSI driver when the helm charts are deployed.

  For AWS, you need to deploy the secrets-store-csi-driver-provider and create the necessary IAM policies, OIDC providers, and IAM service accounts. Please refer the documentation for more information and steps to follow.

Supported Cluster providers

Currently, the MI helm charts are tested with the following cluster providers,

• Amazon Elastic Kubernetes Service (EKS)

  Refer EKS Configs section to configure the required parameters to run MI in EKS.

• Azure Kubernetes Service (AKS)

  Refer AKS Configs section to configure the required parameters to run MI in AKS.

• Google Kubernetes Engine (GKE)

  Refer GKE Configs section to configure the required parameters to run MI in GKE.

Contributing

1. Update the necessary k8s template file in templates or the configuration file in confs. If the new parameter is optional, make sure to add the necessary check conditions.

2. Update the values.yaml accordingly.

3. Run the following command to generate the docs.

Note: If helm-docs is not installed, refer Installation first.

helm-docs -f values.yaml -o CONFIG.md