Deploying Choreo Connect as a Standalone Gateway on Docker Compose

Let's deploy an API, using WSO2 API Controller (apictl), on Choreo Connect, which running on Docker Compose as a Standalone Gateway.

Before you begin...

Install and set up Docker.

Step 1 - Download and setup Choreo Connect distribution zip and APICTL (Command Line Tool)

Step 1.1 - Download and install APICTL

APICTL is a CLI tool which can be used to deploy undeploy APIs into Choreo Connect clusters. Refer Download and initialize the CTL Tool to setup the APICTL in your development environment.

Step 1.2 - Download and extract Choreo Connect distribution .zip file

Latest Choreo Connect distribution can be downloaded from Extract the Choreo Connect distribution zip. Extracted folder will be called as <CHOREO-CONNECT_HOME> hereafter.

Step 2 - Initialize an API project

Navigate to a preferred workspace folder using the command line. This is the location that is used to store the Choreo Connect project. Run the following command to create a project named "petstore".  This will create the folder structure for the artifacts to be included. Use the -oas option to include the API definition to the project as follows.

apictl init petstore --oas <api definition path>

Let's use the Petstore sample OpenAPI definition

apictl init petstore --oas

The project is now initialized. A directory with the name "petstore" has been created.


The folder structure is similar to the following.

├── Client-certificates
├── Definitions
│   └── swagger.yaml
├── Docs
├── Endpoint-certificates
├── Image
├── Interceptors
├── Sequences
│   ├── fault-sequence
│   ├── in-sequence
│   └── out-sequence
├── api.yaml
├── api_meta.yaml
└── libs


Step 3 - Start Choreo Connect

Start Choreo Connect on Docker Compose by executing the Docker Compose script inside the CHOREO-CONNECT_HOME. Navigate to <CHOREO-CONNECT_HOME>/docker-compose/choreo-connect/ and execute the following command.

Click here if you are using an ARM64 based machine (e.g., Apple M1)

If you are trying this out in an ARM64 based machine (e.g., Apple M1), update the Docker image names with the following:

  • docker-compose.yaml files
    • <CHOREO-CONNECT_HOME>/docker-compose/choreo-connect/docker-compose.yaml
    • <CHOREO-CONNECT_HOME>/docker-compose/choreo-connect-with-apim/docker-compose.yaml
Existing (Default) image name Image name for tryout in ARM64 (e.g.: Apple M1)
wso2/choreo-connect-adapter:1.0.0 wso2/choreo-connect-adapter:1.0.0-ubuntu
wso2/choreo-connect-enforcer:1.0.0 wso2/choreo-connect-enforcer:1.0.0-ubuntu
wso2/choreo-connect-router:1.0.0 wso2/choreo-connect-router:1.0.0-ubuntu
wso2/wso2am:4.0.0-alpine wso2am/wso2am:4.0.0-ubuntu

Note that the above Ubuntu based (*-ubuntu) images are for tryout purpose only, not recommended for a production deployment.

docker-compose up -d

Once containers are up and running, we can monitor the status of the containers using the following command

docker ps | grep choreo-connect-

Step 4 - Deploy the API Project

Step 4.1 - Add Choreo Connect Cluster as Environment to APICTL

To use APICTL with Choreo Connect, we need to add the Choreo Connect cluster as an environment in the APICTL. Basically the adapter URL will be added as the gateway environment, and the added environment can be used in the subsequent commands.

apictl mg add env <ENVIRONMENT_NAME> --adapter <ADAPTER_URL>
apictl mg add env dev --adapter https://localhost:9843

Step 4.2 - Login to Choreo Connect Cluster

Next you need to log in to the Choreo Connect environment (log in to the adapter) in order to deploy the API in Choreo Connect.

apictl mg login dev -u <AUTHORIZED_USER_USERNAME> -p <USER_PASSWORD> -k
apictl mg login dev -u admin -p admin -k


Following apictl commands are being executed with -k flag to avoid SSL verification with the Choreo Connect. To communicate via https without skipping SSL verification (without -k flag), add the cert of Choreo Connect into /home/<your-pc-username>/.wso2apictl/certs.

Step 4.3 - Deploy the API in Choreo Connect

Now let's deploy our first API to Choreo Connect using the project created in the step 3. Navigate to the location where the petstore project was initialized. Execute the following command to deploy the API in the Choreo Connect.

apictl mg deploy api -f <PROJRECT_NAME> -e <ENVIRONMENT_NAME> -k
apictl mg deploy api -f petstore -e dev -k

Step 5 - Invoke the sample API

Step 5.1 - Obtain a token

After the APIs are exposed via WSO2 Choreo Connect, you can invoke an API with a valid token(JWT) or using a test key.
Let's use WSO2 Choreo Connect's test key endpoint to obtain an test key in order to access the API. Refer Generate a Test JWT for more details.

TOKEN=$(curl -X POST "https://localhost:9095/testkey" -d "scope=read:pets" -H "Authorization: Basic YWRtaW46YWRtaW4=" -k -v)


More information - You can obtain a JWT token from any third-party secure token service or via the WSO2 API Manager.

Step 5.2 - Invoke the API

Execute the following command to Invoke the API using the test key: You can now invoke the API running on the WSO2 Choreo Connect using the following cURL command.

curl -X GET "<Docker-hostname>:<Docker-port>/<API-context>/<API-resource>" -H "Authorization: Bearer $TOKEN" -k
curl -X GET "https://localhost:9095/v2/pet/findByStatus?status=available" -H "accept: application/json" -H "Authorization:Bearer $TOKEN" -k