wso2/wso2am-tm repository overview

⁠About WSO2 Traffic Manager

WSO2 Traffic Manager is responsible for handling traffic control and policy enforcement within the WSO2 API Manager architecture.

It manages rate limiting, throttling decisions, and quota enforcement across APIs and applications, ensuring fair usage and system stability.

As part of a distributed API management setup, the Traffic Manager works alongside the Control Plane and Universal Gateway to provide a scalable and reliable API management platform.

Designed for high scalability, it processes traffic events and enforces policies in real time to support high-volume API deployments.

⁠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 Traffic Manager Docker Images

WSO2 Traffic Manager Docker images are built for running the traffic control and policy enforcement component of 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⁠

⁠Start a WSO2 Traffic Manager instance:

docker run -it -p 9711:9711 \
  --name api-traffic-manager wso2/wso2am-tm:4.7.0

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

⁠Logs & Shell Access

• View logs:

  docker logs api-traffic-manager
  

  Copy

• Access container shell:

  docker exec -it api-traffic-manager bash
  

  Copy

⁠Debug Mode

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

docker run -it -p 9711:9711 -p 5005:5005 \
  --name api-traffic-manager-debug \
  wso2/wso2am-tm:4.7.0 -debug *:5005

⁠Configuration Override

You can override Traffic 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 9712:9712 \
     --volume {SOURCE_CONFIGS}/deployment.toml:{TARGET_CONFIGS}/deployment.toml \
     wso2/wso2am-tm:4.7.0
   

   Copy

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

⁠Image Variants

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

Each image includes a pre-installed WSO2 Traffic 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.