wso2/wso2am repository overview

⁠About WSO2 API Manager

WSO2 API Manager is an open source approach that addresses full API lifecycle management, monetization, and policy enforcement. It allows extensibility and customization, and ensures freedom from lock-in.

As part of the larger WSO2 Integration Agile Platform, it is a central component used to deploy and manage API-driven ecosystems. Its hybrid integration capabilities further simplify projects that span traditional as well as microservice environments. And unlike other API and lifecycle management products, it is fully open-source allowing for extensibility and customization.

⁠About WSO2 Docker Images

WSO2 provides Docker images on DockerHub⁠ 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 Manager Docker Images

WSO2 API Manager Docker images are built for running WSO2 API Manager 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
  4.7.0⁠, 4.7.0-alpine⁠, 4.7.0-rocky⁠

• 4.6.0
  4.6.0⁠, 4.6.0-alpine⁠, 4.6.0-rocky⁠

• 4.5.0
  4.5.0⁠, 4.5.0-alpine⁠, 4.5.0-rocky⁠

• 4.4.0
  4.4.0⁠, 4.4.0-alpine⁠, 4.4.0-rocky⁠

• 4.3.0
  4.3.0⁠, 4.3.0-alpine⁠, 4.3.0-rocky⁠

• 3.2.0
  3.2.0⁠, 3.2.0-alpine⁠, 3.2.0-centos⁠

⁠Run the Container

⁠Start a WSO2 API Manager instance:

docker run -it -p 8243:8243 -p 9443:9443 \
  --name api-manager wso2/wso2am:4.7.0

By default, ports 8243 and 9443 are exposed. You can map additional ports as needed.

⁠Access the UIs

Use the Docker host IP:

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

⁠Logs & Shell Access

• View logs:

  docker logs api-manager
  

  Copy

• Access container shell:

  docker exec -it api-manager bash
  

  Copy

⁠Debug Mode

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

docker run -it -p 8243:8243 -p 9443:9443 -p 5005:5005 \
  --name api-manager-debug \
  wso2/wso2am:4.7.0 -debug *:5005

⁠JMX Monitoring

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

⁠Run with JMX Ports

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

⁠Get JMX Service URL

Check container logs:

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: https://apim.docs.wso2.com/en/4.7.0/monitoring/observability/metrics/jmx-based-monitoring/⁠

Note: Passing startup arguments is not supported in Docker image tag 2.5.0.

⁠Configuration Override

You can override API Manager 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):

   [server]
   offset = 1
   

   Copy

3. Grant read permission:

   chmod o+r {SOURCE_CONFIGS}/deployment.toml
   

   Copy

4. Run the container with the mounted config:

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

   Copy

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

⁠Image Variants

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

Each image includes a pre-installed WSO2 API Manager 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 repository⁠ and Docker resource usage issues at WSO2 API Manager product Docker resource repository⁠

• Maintained by: WSO2 LLC.⁠

• Supported Docker versions: Docker v17.09.0 or above

⁠License

View license information⁠ 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.