Setting Up¶

This guide provides detailed instructions for deploying the API Platform Event Gateway in production environments. Choose the infrastructure option that matches your environment.

Quick Start

If you're just getting started, see the Getting Started guide for a quick setup.

Setup Instructions¶

Virtual MachineDockerKubernetes

Prerequisites¶

cURL installed
unzip installed
A Docker-compatible container runtime such as:
- Docker Desktop (Windows / macOS)
- Rancher Desktop (Windows / macOS)
- Colima (macOS)
- Docker Engine + Compose plugin (Linux)

Ensure docker and docker compose commands are available:

docker --version
docker compose version

Step 1: Download the Gateway¶

Run this command in your terminal to download the gateway:

curl -sLO https://github.com/wso2/api-platform/releases/download/event-gateway/v0.5.0/wso2apip-event-gateway-0.5.0.zip && \
unzip wso2apip-event-gateway-0.5.0.zip

Step 2: Configure the Gateway¶

Run this command to create event-gateway/configs/keys.env with the required environment variables:

cat > wso2apip-event-gateway-0.5.0/configs/keys.env << 'ENVFILE'
MOESIF_KEY=<your-moesif-key>
GATEWAY_CONTROLPLANE_HOST=connect.bijira.dev
GATEWAY_REGISTRATION_TOKEN=<your-gateway-token>
ENVFILE

Step 3: Start the Gateway¶

Navigate to the gateway folder:
```
cd wso2apip-event-gateway-0.5.0
```
Run this command to start the gateway using the configs/keys.env file created in Step 2:
```
docker compose --env-file configs/keys.env up
```

To run in detached mode (background):

docker compose --env-file configs/keys.env up -d

Step 4: Verify the Gateway¶

Check that the gateway is running:

docker compose ps

Stopping the Gateway¶

To stop the gateway:

docker compose down

Prerequisites¶

cURL installed
unzip installed
Docker Compose installed

Step 1: Download the Gateway¶

Run this command in your terminal to download the gateway:

curl -sLO https://github.com/wso2/api-platform/releases/download/event-gateway/v0.5.0/wso2apip-event-gateway-0.5.0.zip && \
unzip wso2apip-event-gateway-0.5.0.zip

Step 2: Configure the Gateway¶

Run this command to create wso2apip-event-gateway-0.5.0/configs/keys.env with the required environment variables:

cat > wso2apip-event-gateway-0.5.0/configs/keys.env << 'ENVFILE'
MOESIF_KEY=<your-moesif-key>
GATEWAY_CONTROLPLANE_HOST=connect.bijira.dev
GATEWAY_REGISTRATION_TOKEN=<your-gateway-token>
ENVFILE

Important

Replace <your-gateway-token> with the Gateway Registration Token from the API Platform Console. This token is shown only once, so ensure you copy it before leaving the page.

Step 3: Start the Gateway¶

Navigate to the gateway folder:
```
cd wso2apip-event-gateway-0.5.0
```
Run this command to start the gateway using the configs/keys.env file created in Step 2:
```
docker compose --env-file configs/keys.env up
```

To run in detached mode (background):

docker compose --env-file configs/keys.env up -d

Step 4: Verify the Gateway¶

Check that the gateway is running:

docker compose ps

Stopping the Gateway¶

To stop the gateway:

docker compose down

Prerequisites¶

cURL installed
Kubernetes 1.32+ cluster
Helm 3.18+ installed
Either permissions to install cert-manager in the cluster or an existing cert-manager installation
Kafka as a Managed Service

Install cert-manager (optional)¶

If cert-manager is not already installed, run these commands before installing the gateway chart:

helm repo add jetstack https://charts.jetstack.io --force-update
helm repo update

helm install cert-manager jetstack/cert-manager \
  --namespace cert-manager \
  --create-namespace \
  --set crds.enabled=true

Installing the Chart¶

Run this command to install the event gateway chart with control plane configurations:

helm install event-gateway oci://ghcr.io/wso2/api-platform/helm-charts/event-gateway --version 1.0.0 \
  --set gateway.controller.controlPlane.host="connect.bijira.dev" \
  --set gateway.controller.controlPlane.port=443 \
  --set gateway.controller.controlPlane.token.value="your-gateway-token" \
  --set gateway.config.analytics.publishers.moesif.application_id="your-moesif-key" \
  --set gateway.config.analytics.enabled=true

Important

Replace your-gateway-token with the Gateway Registration Token from the API Platform Console. This token is shown only once, so ensure you copy it before leaving the page.

Verifying the Installation¶

Check that the gateway pods are running:

kubectl get pods

Upgrading the Gateway¶

To upgrade to a new version:

helm upgrade event-gateway oci://ghcr.io/wso2/api-platform/helm-charts/event-gateway --version <new-version> \
  -f values.yaml

Uninstalling the Gateway¶

To remove the gateway from your cluster:

helm uninstall event-gateway

What's Next?¶

Troubleshooting: Common issues and solutions