Pattern 1: All-in-One HA Setup

This pattern deploys WSO2 API Manager as a highly available active-active cluster with two nodes, each running all components — Control Plane, Gateway, Traffic Manager, and Key Manager. It is suitable for production environments that require high availability and can handle moderate traffic.

How Pattern 1 Differs from Pattern 0

	Pattern 0	Pattern 1
Nodes	1	2 (active-active)
Database	Embedded H2	External database required
Docker image	Default WSO2 image	Custom image with JDBC driver required
High availability	No	Yes

Complete these before running helm install

Pattern 1 requires three things that Pattern 0 does not:

1. An external database — H2 is not supported. Set up an external database before deploying.
2. A custom Docker image — the default WSO2 image does not include JDBC drivers. Build and push a custom image before deploying.
3. Database schema initialised — run the WSO2 schema scripts against both databases before the pods start.

---

Quick Start

Step 1 — Install Required Tools

1. Ensure the following tools are installed on your machine:

   Tool	Purpose	Install Guide
   kubectl	Kubernetes CLI for managing cluster resources	Install
   helm (v3)	Package manager for deploying WSO2 Helm charts	Install
   docker	Required to build and push custom WSO2 images	Install

2. Verify all tools are installed and check their versions:

   kubectl version --client
   helm version
   docker info
   

   Version Compatibility

   Ensure your tool versions are within the supported ranges listed in the Prerequisites page before proceeding.

Step 2 — Verify Your Cluster is Running

1. Ensure your Kubernetes cluster is up and running:

   kubectl cluster-info
   kubectl get nodes
   

   All nodes should show a Ready status.

Step 3 — Add the WSO2 Helm Repository

1. Add the WSO2 Helm repository and update it:

   helm repo add wso2 https://helm.wso2.com && helm repo update
   

Step 4 — Install a Routing Controller

WSO2 API Manager 4.7.0 uses Envoy Gateway by default for routing and it is the recommended option. NGINX Ingress Controller is also available for users who require it.

Envoy Gateway (Recommended)NGINX Ingress Controller (Deprecated)

1. Install Envoy Gateway:

   helm install envoy-gateway oci://docker.io/envoyproxy/gateway-helm \
     --version v1.7.0 -n envoy-gateway-system \
     --set config.envoyGateway.extensionApis.enableBackend=true \
     --set envoyGateway.gateway.experimentalFeatures.enabled=true \
     --create-namespace
   

2. Create the apim namespace and apply the sample Gateway manifest:

   kubectl create namespace apim
   kubectl apply \
     -f https://raw.githubusercontent.com/wso2/helm-apim/4.7.x/resources/assets/sample-gateway.yaml \
     -n apim
   

3. Verify the gateway is ready:

   kubectl get gateway -n apim
   

See Section 4 — Routing Controller for full Envoy Gateway values configuration.

1. Install the NGINX ingress controller into your cluster:

   Local cluster (Minikube / Rancher Desktop)Managed cluster (AKS / GKE)

   helm upgrade --install ingress-nginx ingress-nginx \
     --repo https://kubernetes.github.io/ingress-nginx \
     --namespace ingress-nginx --create-namespace
   

   helm upgrade --install ingress-nginx ingress-nginx \
     --repo https://kubernetes.github.io/ingress-nginx \
     --namespace ingress-nginx --create-namespace \
     --set controller.service.externalTrafficPolicy=Local
   

   Note

   externalTrafficPolicy=Local is required on managed Kubernetes services. Without it, the cloud load balancer health probes fail and traffic never reaches the ingress controller.

2. Verify the controller is running:

   kubectl get pods -n ingress-nginx
   

   The NGINX pod should show 1/1 Running before proceeding.

Step 5 — Build and Push a Custom Docker Image

WSO2 API Manager needs to connect to an external database at runtime, but the default WSO2 Docker image does not include third-party JDBC drivers. You must build a custom image that adds the appropriate driver for your database.

Any other customisations — additional JARs, patches, or environment-specific libraries — can also be baked into the image at this stage rather than mounted at deployment time.

Choosing a base image

• DockerHub (wso2/wso2am:4.7.0) — packages the GA release. Suitable for evaluation and development.
• WSO2 Private Registry (registry.wso2.com/wso2-apim/am:4.7.0.0) — includes WSO2 Updates and is recommended for production. Requires an active WSO2 Subscription.

1. Create a directory for the custom image:

   mkdir wso2am-custom && cd wso2am-custom
   

2. Create a file named Dockerfile with the following content. The example below adds the MySQL JDBC driver — adjust the URL for other databases:

   FROM wso2/wso2am:4.7.0
   
   ADD --chown=wso2carbon:wso2 \
     https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.28/mysql-connector-java-8.0.28.jar \
     /home/wso2carbon/wso2am-4.7.0/repository/components/lib/
   

3. Build the image, replacing <CONTAINER_REGISTRY>, <IMAGE_REPO>, and <TAG> with your values:

   docker buildx build --platform linux/amd64 -t <CONTAINER_REGISTRY>/<IMAGE_REPO>:<TAG> .
   

   Matching your cluster architecture

   The --platform flag ensures the image is built for the architecture your cluster nodes run on. Most managed clusters (AKS, GKE) and Linux servers use linux/amd64. If you are building on Apple Silicon (M1/M2/M3/M4) without this flag, the image will be built for linux/arm64 and the pod will fail to start with no match for platform in manifest.

   To check your cluster node architecture before building:

   kubectl get nodes -o jsonpath='{.items[*].status.nodeInfo.architecture}'
   

4. Push the image to your container registry:

   docker push <CONTAINER_REGISTRY>/<IMAGE_REPO>:<TAG>
   

5. Get the image digest — you will need it when configuring values.yaml:

   docker inspect <CONTAINER_REGISTRY>/<IMAGE_REPO>:<TAG> \
     --format='{{index .RepoDigests 0}}'
   

   The digest will look like docker.io/<your-org>/<image>@sha256:abcdef....

Step 6 — Set Up the Database

Pattern 1 requires two databases: apim_db and shared_db. Both must be reachable from inside the Kubernetes cluster before the pods start.

Follow the Setting Up Databases guide to:

1. Set up a database instance accessible from your cluster
2. Obtain the schema scripts for your database type
3. Run the scripts to initialise both databases

Note

The JDBC driver for your database is already included in the custom Docker image you built in Step 5. You do not need to follow the JDBC driver steps in the VM-oriented sections of that guide.

Once the scripts have been run, verify that both databases are set up correctly before proceeding:

• Connect to your database instance and confirm that apim_db and shared_db both exist
• Check that tables have been created in each database (the shared_db script creates UM_* and REG_* tables; the apim_db script creates AM_* tables)

Step 7 — Create the Keystore Secret

The Helm chart mounts a Kubernetes secret named apim-keystore-secret as a volume into the pods. The pods will not start if this secret does not exist — you will see a MountVolume.SetUp failed: secret "apim-keystore-secret" not found error.

1. WSO2 API Manager ships with default keystores inside the Docker image. Extract them:

   mkdir -p keystores
   
   docker run --rm -v "$(pwd)/keystores:/keystores" --entrypoint bash <CONTAINER_REGISTRY>/<IMAGE_REPO>:<TAG> -c "cp /home/wso2carbon/wso2am-4.7.0/repository/resources/security/wso2carbon.jks /home/wso2carbon/wso2am-4.7.0/repository/resources/security/client-truststore.jks /keystores/"
   

2. Create the Kubernetes secret:

   kubectl create secret generic apim-keystore-secret \
     --from-file=keystores/wso2carbon.jks \
     --from-file=keystores/client-truststore.jks \
     -n apim
   

3. Verify the secret was created:

   kubectl get secret apim-keystore-secret -n apim
   

Note

The commands above use the default WSO2 keystores which are suitable for evaluation only. For production-level keystore setup, refer to Configuring Keystores in WSO2 API Manager.

Step 8 — Deploy WSO2 API Manager

Pattern 1 uses a single Helm chart release with two pod replicas forming the active-active cluster. Before deploying, you must configure your custom image and database connection in a values.yaml file.

1. Download the default values file as a starting point:

   curl -L https://raw.githubusercontent.com/wso2/helm-apim/4.7.x/resources/am-pattern-1-all-in-one-HA/default_values.yaml \
     -o values.yaml
   

2. Open values.yaml and update the two sections below before deploying.

   Custom image — point to the image you built and pushed in Step 5. The registry and repository together form the full image name. For Docker Hub, registry is docker.io and repository is <your-username>/<image-name>.

   Set both tag (the tag you used in docker build) and digest (from docker inspect in Step 5):

   wso2:
     deployment:
       image:
         registry: "docker.io"                       # your container registry
         repository: "<your-username>/wso2am"  # your Docker Hub username + image name
         tag: "<TAG>"                                 # tag used in docker build
         digest: "sha256:abcdef..."                  # sha256 digest from docker inspect in Step 5
   

   Database connection — point to the database you set up in Step 6:

     apim:
       configurations:
         databases:
           apim_db:
             url: "<JDBC_URL_FOR_APIM_DB>"
             username: "<DB_USERNAME>"
             password: "<DB_PASSWORD>"
           shared_db:
             url: "<JDBC_URL_FOR_SHARED_DB>"
             username: "<DB_USERNAME>"
             password: "<DB_PASSWORD>"
   

   Replace <JDBC_URL_FOR_APIM_DB> and <JDBC_URL_FOR_SHARED_DB> with the JDBC connection URL for your database. For URL formats per database type, see Setting Up Databases.

3. Deploy WSO2 API Manager:

   helm install apim wso2/wso2am-all-in-one \
     --version 4.7.0-1 \
     --namespace apim --create-namespace \
     --dependency-update \
     -f values.yaml \
     --set wso2.apim.configurations.encryption.key=$(openssl rand -hex 32)
   

   Encryption key is mandatory

   WSO2 API Manager 4.7.0 requires a 256-bit encryption key before first startup. In an HA deployment, both nodes must use the same key — generate it once, store it securely, and set it explicitly in your values.yaml under wso2.apim.configurations.encryption.key rather than relying on the auto-generated value above.

   openssl is not available on Windows by default. Windows users can generate the key using PowerShell's System.Security.Cryptography.RandomNumberGenerator class.

4. Wait for both pods to be ready:

   kubectl get pods -n apim -w
   

   Both pods should show 1/1 Running before proceeding. This may take several minutes on the first run.

Step 9 — Configure Local DNS

Envoy Gateway users

If you installed Envoy Gateway (the default), get the external address from the Gateway resource:

kubectl get gateway -n apim

Then map the kubernetes.gatewayAPI.* hostnames from your values.yaml to the external address.

Windows users

On Windows, the hosts file is at C:\Windows\System32\drivers\etc\hosts. Open Notepad (or another text editor) as Administrator to edit it.

MinikubeRancher DesktopManaged cluster (AKS / GKE)

1. Run the following command in a separate terminal and keep it running:

   minikube tunnel
   

   Note

   minikube tunnel requires sudo privileges to expose ports 80 and 443. You will be prompted for your system password. Once entered, the tunnel will stay running silently — this is expected. Do not close this terminal. Open a new terminal for the next steps.

2. Get the external IP:

   Envoy Gateway (Recommended)NGINX Ingress Controller (Deprecated)

   kubectl get gateway -n apim
   

   kubectl get ing -n apim
   

   The ADDRESS column should now show 127.0.0.1.

3. Add the following entry to your /etc/hosts file:

   127.0.0.1 am.wso2.com gw.wso2.com websocket.wso2.com websub.wso2.com
   

1. Get the external IP:

   Envoy Gateway (Recommended)NGINX Ingress Controller (Deprecated)

   kubectl get gateway -n apim
   

   kubectl get ing -n apim
   

2. Add the following entry to your /etc/hosts file, replacing <EXTERNAL-IP> with the value from the output above:

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

1. Get the external IP:

   Envoy Gateway (Recommended)NGINX Ingress Controller (Deprecated)

   kubectl get gateway -n apim
   

   kubectl get ing -n apim
   

2. For quick testing, add the ADDRESS value to your /etc/hosts:

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

   For a production setup, create a DNS record in your DNS provider (e.g. Route 53, Azure DNS, Cloud DNS) mapping the hostnames to the external IP instead of using /etc/hosts.

Note

These are the default hostnames. If you customised the hostnames in your values.yaml, use those values here instead:

• Envoy Gateway: kubernetes.gatewayAPI.management.hostname, kubernetes.gatewayAPI.gateway.hostname, etc.
• NGINX: ingress.controlPlane.hostname, ingress.gateway.hostname, etc.

Step 10 — Access the Portals

1. Once DNS is configured, open the following URLs in your browser:

   Envoy Gateway (Recommended)NGINX Ingress Controller (Deprecated)

   Portal	URL
   Publisher	https://<kubernetes.gatewayAPI.management.hostname>/publisher
   Developer Portal	https://<kubernetes.gatewayAPI.management.hostname>/devportal
   Carbon Console	https://<kubernetes.gatewayAPI.management.hostname>/carbon
   Gateway	https://<kubernetes.gatewayAPI.gateway.hostname>

   Portal	URL
   Publisher	https://<kubernetes.ingress.management.hostname>/publisher
   Developer Portal	https://<kubernetes.ingress.management.hostname>/devportal
   Carbon Console	https://<kubernetes.ingress.management.hostname>/carbon
   Gateway	https://<kubernetes.ingress.gateway.hostname>

   Replace the hostname placeholders with the actual values from your values.yaml. With default values, all hostnames resolve to am.wso2.com (management) and gw.wso2.com (gateway).

   Chrome may block access

   Chrome enforces HSTS preloading for *.wso2.com domains, which removes the option to bypass the self-signed certificate warning entirely. Use Firefox or Safari instead, and click through the certificate warning when prompted.

   Default credentials: admin / admin

---

Customized Configurations

All configurations in this section are made by editing your values.yaml file.

Note

Once all changes are in place, deploy using Deploy with Custom Values.

The Helm charts for WSO2 API Manager are available in the WSO2 Helm Chart Repository.

Resource Naming Convention

Kubernetes resources created by the Helm charts follow this naming pattern:

<RELEASE_NAME>-<CHART_NAME>-<RESOURCE_NAME>

1. Image and Registry

1.1 Private Registry Authentication

The image registry and repository are configured in Step 8. If your registry is private and requires authentication, enable imagePullSecrets:

wso2:
  deployment:
    image:
      imagePullSecrets:
        enabled: true
        username: ""
        password: ""

2. Database and Credentials

2.1 Configure Admin Credentials

The default admin credentials are admin/admin. Change these before deploying to any shared or production environment.

wso2:
  apim:
    configurations:
      adminUsername: ""
      adminPassword: ""

2.2 Update Keystore Passwords

If you are mounting custom keystores (see section 3.1), update the passwords here to match.

wso2:
  apim:
    configurations:
      security:
        keystores:
          primary:
            password: ""
            keyPassword: ""
          internal:
            password: ""
            keyPassword: ""
          tls:
            password: ""
            keyPassword: ""
        truststore:
          password: ""

Note

keyPassword must equal password for each keystore. WSO2 API Manager requires these to be identical due to a limitation in internal third-party components — setting them to different values will cause startup failures.

2.3 Configure the Internal Encryption Key

In a distributed or HA deployment, all API Manager nodes must use the same internal encryption key to encrypt and decrypt shared data. Set this before the first startup — changing it afterwards will cause decryption failures for any data already encrypted.

1. Generate a unique 256-bit key:

   openssl rand -hex 32
   

   Note

   openssl is not available on Windows by default. Windows users can generate the key using PowerShell's System.Security.Cryptography.RandomNumberGenerator class.

2. Add the key to all your values files:

   wso2:
     apim:
       configurations:
         encryption:
           key: "<generated-64-char-hex-key>"
   

   If you encrypt secrets using the cipher tool and secure vault (see Section 3.2), also encrypt the internal encryption key and set the encrypted value here instead of the plaintext key.

Warning

All nodes in the deployment must use the exact same key. A mismatch will cause decryption failures across the cluster.

2.4 Component Configuration References

• All-in-One Helm chart
• Universal Gateway Helm chart

3. Security

3.1 Mount Keystore and Truststore

In Step 7 of the Quick Start, you created apim-keystore-secret using the default WSO2 keystores extracted from the Docker image. Those are self-signed certificates suitable for evaluation only.

For production-level keystore setup, refer to Configuring Keystores in WSO2 API Manager. Then recreate the secret with your own certificates:

kubectl create secret generic apim-keystore-secret \
  --from-file=wso2carbon.jks \
  --from-file=client-truststore.jks \
  -n apim

Keep the following in mind:

• The secret must be created in the same namespace as the deployment (e.g. apim).
• Use the same secret name in both the kubectl command above and in your values.yaml.
• If you are using different keystore filenames or aliases, update the helm chart configurations accordingly.
• You can also include keystores for HTTPS transport.

For more details on configuring keystores, see Configuring Keystores in WSO2 API Manager.

3.2 Encrypt Secrets

By default, database passwords and other sensitive values are stored as plain text in the values files. This is acceptable for local testing but a security risk in production.

Option 1: Cipher Tool

Use the cipher tool from the product pack to encrypt secrets:

sh ciphertool.sh -Dconfigure -Dsymmetric -Dkey.based.encryption

Option 2: apictl

You can also use apictl to encrypt secrets. For further guidance, refer to Encrypting Secrets with apictl.

1. Initialize apictl using the trust store:

   apictl secret init
   

   Example:

   apictl secret init
   Enter Key Store location: /home/wso2carbon/wso2am-4.7.0/repository/resources/security/wso2carbon.jks
   Enter Key Store password: 
   Enter Key alias: wso2carbon
   Enter Key password: 
   
   Key Store initialization completed
   

2. Encrypt each of the following values using apictl secret create:

   • admin_password
   • keystore_password
   • keystore_key_password
   • ssl_keystore_password
   • ssl_key_password
   • internal_keystore_password
   • internal_keystore_key_password
   • truststore_password
   • apim_db_password
   • shared_db_password

   Example:

   apictl secret create
   Enter plain alias for secret: db_password
   Enter plain text secret: 
   Repeat plain text secret: 
   
   db_password : eKALmLVA+HFVl7vxxxxxxxxxxxxxxxxxxxxxxxxxxxjakhHN
   

3. Replace the plain text values in your values files with the encrypted values.

4. Enable secure vault:

   # -- Secure vault enabled
   secureVaultEnabled: true
   

5. If you are using a cloud provider secret manager, store the secret encryption key there and reference it so the runtime can fetch and use it to decrypt secrets:

   aws:
     secretsManager:
       secretIdentifiers:
         secretEncryptionKey:
           # -- Secret name in the cloud provider's secret manager
           secretName: ""
           # -- Secret key in the cloud provider's secret manager
           secretKey: ""
   

   Note

   Currently, AWS, Azure, and GCP Secrets Managers are supported.

3.3 Configure SSL

For WSO2 recommended SSL best practices when exposing services outside the cluster, refer to the WSO2 container guide.

3.4 Configure JWKS URL

Important for multi-pod deployments

In Pattern 1, two pods share the same hostname am.wso2.com. Using localhost for the JWKS URL will only resolve to the pod handling the request, causing token verification failures on the other pod. Use the Kubernetes service name instead so both pods can resolve it correctly:

wso2:
  apim:
    configurations:
      oauth_config:
        oauth2JWKSUrl: "https://<service-name>:9443/oauth2/jwks"

4. Routing Controller

4.1 Configure Envoy Gateway (Default in 4.7.x)

Envoy Gateway is the default routing controller in WSO2 API Manager 4.7.0. It uses the Kubernetes Gateway API, which provides more flexibility than traditional Ingress resources.

Step 1: Create a TLS secret

kubectl create secret tls apim-tls-secret \
  --key <private-key-file> \
  --cert <certificate-file> \
  -n apim

Step 2: Install Envoy Gateway (if not already done in Step 4 of the Quick Start)

helm install envoy-gateway oci://docker.io/envoyproxy/gateway-helm \
  --version v1.7.0 -n envoy-gateway-system \
  --set config.envoyGateway.extensionApis.enableBackend=true \
  --set envoyGateway.gateway.experimentalFeatures.enabled=true \
  --create-namespace

Step 3: Apply the Gateway manifest

kubectl apply \
  -f https://raw.githubusercontent.com/wso2/helm-apim/4.7.x/resources/assets/sample-gateway.yaml \
  -n apim

Step 4: (Optional) Create a CA ConfigMap for backend TLS

If you want Envoy Gateway to verify backend TLS certificates, create a ConfigMap with your CA certificate:

kubectl create configmap wso2-ca-cert \
  --from-file=ca.crt=<path-to-ca-cert> \
  -n apim

Step 5: Configure Envoy Gateway in values.yaml

kubernetes:
  gatewayAPI:
    enabled: true
    gatewayName: "wso2-apim-gateway"
    defaultConfigMapCreation: false
    management:
      enabled: true
      hostname: "am.wso2.com"
    gateway:
      enabled: true
      hostname: "gw.wso2.com"
    websocket:
      enabled: true
      hostname: "websocket.wso2.com"
    websub:
      enabled: true
      hostname: "websub.wso2.com"
    backendTLSPolicy:
      enabled: true
      caCertificateConfigMap: "wso2-ca-cert"
      hostname: "<hostname used in the TLS certificate>"
    backendTrafficPolicy:
      enabled: true
      cookie:
        name: "WSO2_CP_STICKY_SESSION"
        ttl: "0s"

4.2 Configure NGINX Ingress Controller

Use this section if you are using NGINX Ingress Controller instead of Envoy Gateway.

Configure ingress annotations

You may need to customise these if you want to enable sticky sessions, change the backend protocol, or apply rate limiting.

ingressClass: "nginx"
ingress:
  tlsSecret: ""
  ratelimit:
    enabled: false
    zoneName: ""
    burstLimit: ""
  controlPlane:
    hostname: "am.wso2.com"
    annotations:
      nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
      nginx.ingress.kubernetes.io/affinity: "cookie"
      nginx.ingress.kubernetes.io/session-cookie-name: "route"
      nginx.ingress.kubernetes.io/session-cookie-hash: "sha1"

Refer to the NGINX ingress annotations documentation for the full list of supported options.

Configure TLS for Ingress

kubectl create secret tls my-tls-secret \
  --key <private-key-file> \
  --cert <certificate-file> \
  -n apim

Then set the secret name in your values.yaml under ingress.tlsSecret. Refer to the Kubernetes ingress TLS documentation for more details.

5. Gateway, High Availability, and User Management

5.1 Configure Multiple Gateways

gateway:
  environments:
    - name: "Default"
      type: "hybrid"
      gatewayType: "Regular"
      provider: "wso2"
      displayInApiConsole: true
      description: "Handles both production and sandbox token traffic."
      showAsTokenEndpointUrl: true
      serviceName: "apim-gw-wso2am-gateway-service"
      servicePort: 9443
      wsHostname: "websocket.wso2.com"
      httpHostname: "gw.wso2.com"
      websubHostname: "websub.wso2.com"
    - name: "Default_apk"
      type: "hybrid"
      gatewayType: "APK"
      provider: "wso2"
      displayInApiConsole: true
      description: "Handles both production and sandbox token traffic."
      showAsTokenEndpointUrl: true
      serviceName: "apim-gw-wso2am-gateway-service"
      servicePort: 9443
      wsHostname: "websocket.wso2.com"
      httpHostname: "default.gw.wso2.com:9095"
      websubHostname: "websub.wso2.com"

See Deploy through multiple API Gateways for more details.

5.2 Configure User Store Properties

userStore:
  type: "database_unique_id"
  properties:
    ReadGroups: true

Warning

If you do not need to set any custom properties, remove the properties block entirely. An empty properties block will cause the deployment to fail.

See Working with user store properties for the full list of options.

5.3 Configure High Availability

High availability is enabled by default in Pattern 1, which deploys two pods. For local testing where resources are limited, you can disable it to run a single pod:

wso2:
  deployment:
    highAvailability: false

6. Deploy with Custom Values

Once your values.yaml is configured, deploy with:

helm install <release-name> <helm-chart-path> \
  --version 4.7.0-1 \
  --namespace <namespace> --create-namespace \
  --dependency-update \
  -f values.yaml

Deployment Parameters

• <release-name> — Name for your Helm release (e.g. apim-1)
• <namespace> — Kubernetes namespace to deploy into (e.g. apim)
• <helm-chart-path> — Path to the Helm chart, either the repository chart (wso2/wso2am-all-in-one) or a local clone (e.g. ./all-in-one)