wso2/wso2am-acp

About WSO2 API Control Plane

WSO2 API Control Plane is responsible for API design, lifecycle management, and governance within the WSO2 API Manager architecture.

It provides capabilities to create, manage, version, and publish APIs, as well as handle subscriptions, applications, and developer interactions.

As part of a distributed API management setup, the Control Plane works alongside components such as the Universal Gateway and Traffic Manager to enable scalable and secure API-driven ecosystems.

It supports extensibility and customization while maintaining a clear separation between API management and runtime traffic handling.

About WSO2 Docker Images

WSO2 provides Docker images on https://hub.docker.com/u/wso2/ for multiple products. These images contain General Availability (GA) versions without WSO2 Updates.

For production deployments, it is recommended to use updated images from the WSO2 Private Docker Registry, which include WSO2 Updates.

About WSO2 API Control Plane Docker Images

WSO2 API Control Plane Docker images are built for running WSO2 API Control Plane in containerized environments.

They support multiple base OS variants and are designed for development, testing, and deployment of API-driven architectures.

Supported Tags

• 4.7.0
  https://github.com/wso2/docker-apim/blob/v4.7.0.1/dockerfiles/ubuntu/apim-acp/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.7.0.1/dockerfiles/alpine/apim-acp/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.7.0.1/dockerfiles/rocky/apim-acp/Dockerfile

• 4.6.0
  https://github.com/wso2/docker-apim/blob/v4.6.0.5/dockerfiles/ubuntu/apim-acp/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.6.0.5/dockerfiles/alpine/apim-acp/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.6.0.5/dockerfiles/rocky/apim-acp/Dockerfile

• 4.5.0
  https://github.com/wso2/docker-apim/blob/v4.5.0.1/dockerfiles/ubuntu/apim-acp/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.5.0.1/dockerfiles/alpine/apim-acp/Dockerfile, https://github.com/wso2/docker-apim/blob/v4.5.0.1/dockerfiles/rocky/apim-acp/Dockerfile

Start a WSO2 API Control Plane instance:

bash
docker run -it -p 9443:9443 \
  --name api-control-plane wso2/wso2am-acp:4.7.0

By default, port 9443 is exposed. You can map additional ports as needed.

Access the UIs

Use the Docker host IP:

• Management Console → https://{HOST}:9443/carbon
• Admin Portal → https://{HOST}:9443/admin
• Publisher → https://{HOST}:9443/publisher
• Developer Portal → https://{HOST}:9443/devportal

Logs & Shell Access

• View logs:

  bash
  docker logs api-control-plane
  

• Access container shell:

  bash
  docker exec -it api-control-plane bash
  

Debug Mode

Run the container with remote debugging enabled (port 5005):

bash
docker run -it -p 9443:9443 -p 5005:5005 \
  --name api-control-plane-debug \
  wso2/wso2am-acp:4.7.0 -debug *:5005

JMX Monitoring

WSO2 API Control Plane exposes JMX by default for monitoring via tools like JConsole.

Run with JMX Ports

bash
docker run -it -p 9443:9443 \
  -p 9999:9999 -p 11111:11111 \
  --name jmx-apim wso2/wso2am-acp:4.7.0

Get JMX Service URL

Check container logs:

bash
docker logs jmx-apim

Look for:

service:jmx:rmi://localhost:11111/jndi/rmi://localhost:9999/jmxrmi

Connect via JConsole

Use the above service URL to connect from your JMX client.

For detailed steps, refer to: [***]

Configuration Override

You can override API Control Plane configurations by mounting files from the host.

Example: Update deployment.toml

1. Copy the config file from the product: {DISTRIBUTION_HOME}/repository/conf/deployment.toml

2. Update required values (e.g., set port offset):

   toml
   [server]
   offset = 1
   

3. Grant read permission:

   bash
   chmod o+r {SOURCE_CONFIGS}/deployment.toml
   

4. Run the container with the mounted config:

   bash
   docker run -p 9444:9444 \
     --volume {SOURCE_CONFIGS}/deployment.toml:{TARGET_CONFIGS}/deployment.toml \
     wso2/wso2am-acp:4.7.0
   

{TARGET_CONFIGS} refers to: /home/wso2carbon/wso2am-acp-4.7.0/repository/conf

Image Variants

WSO2 API Control Plane Docker images are available with different base operating systems.

Each image includes a pre-installed WSO2 API Control Plane distribution on top of the respective base OS.

Quick reference

• Where to get help: Docker Community Forums, Docker Community Slack, Stack Overflow or mail to WSO2 Developer mailing list

• Where to file issues: Product specific issues at WSO2 API Manager product https://github.com/wso2/api-manager/issues and Docker resource usage issues at WSO2 API Manager product Docker resource https://github.com/wso2/docker-apim/issues

• Maintained by: WSO2 LLC.

• Supported Docker versions: Docker v17.09.0 or above

License

View https://github.com/wso2/product-apim/blob/master/api-control-plane/LICENSE.txt for the software contained in this image.

As with all Docker images, these are likely to contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.