wso2/wso2am

WSO2 API Manager Docker镜像文档

1. 镜像概述和主要用途

WSO2 API Manager Docker镜像是WSO2官方提供的容器化部署方案，托管于https://hub.docker.com/u/wso2/%EF%BC%8C%E5%8C%85%E5%90%ABWSO2 API Manager的正式发布（GA）版本，但不含WSO2 Updates。

主要用途：提供便捷的容器化部署方式，简化WSO2 API Manager的安装、配置和管理，适用于开发、测试及演示环境。对于生产级部署，强烈推荐使用包含WSO2 Updates的镜像，此类镜像可从WSO2私有Docker仓库获取。

2. 核心功能和特性

WSO2 API Manager是开源的API全生命周期管理平台，核心功能和特性包括：

• 全生命周期管理：支持API设计、创建、发布、版本控制、退役的完整生命周期。
• 策略执行：内置API访问控制、限流、安全策略（如OAuth2、JWT）等策略 enforcement 机制。
• 商业化支持：提供API计费、套餐管理等商业化能力，支持API monetization。
• 可扩展与定制：开放源码架构，支持通过插件、扩展点定制功能，满足特定业务需求。
• 无供应商锁定：完全开源，避免技术锁定，用户可自由修改和扩展。
• 混合集成能力：作为WSO2集成敏捷平台的核心组件，支持传统系统与微服务环境的混合集成。

3. 使用场景和适用范围

• 企业API治理：需统一管理内部、合作伙伴及第三方API的企业环境。
• 微服务架构：在微服务体系中，作为API网关和管理中心，协调服务间通信。
• 混合IT环境：适用于同时包含传统应用和云原生服务的混合架构，简化跨环境API集成。
• 定制化API策略：需要自定义安全策略、流量控制或业务规则的场景。
• 开发与测试：快速搭建API管理环境，支持开发团队高效测试API功能。

4. 支持的标签及Dockerfile链接

5. 快速参考

• 获取帮助：
  Docker社区论坛、Docker社区Slack、Stack Overflow 或发送邮件至 WSO2开发者邮件列表。

• 问题反馈：
  产品功能问题请提交至WSO2 API Manager产品https://github.com/wso2/product-apim/issues%EF%BC%9BDocker%E8%B5%84%E6%BA%90%E4%BD%BF%E7%94%A8%E9%97%AE%E9%A2%98%E8%AF%B7%E6%8F%90%E4%BA%A4%E8%87%B3%E4%BA%A7%E5%93%81Docker%E8%B5%84%E6%BA%90https://github.com/wso2/docker-apim/issues%E3%80%82

• 维护方：
  WSO2 Inc.

• 支持的Docker版本：
  Docker v17.09.0及以上。

6. 使用方法和配置说明

6.1 启动API Manager实例

以下命令启动基于Ubuntu的WSO2 API Manager容器：

console
$ docker run -it -p 8280:8280 -p 8243:8243 -p 9443:9443 --name api-manager wso2/wso2am:4.0.0

端口说明：

• 8280：HTTP协议API端口
• 8243：HTTPS协议API端口
• 9443：管理控制台及Web应用端口

可根据需求映射其他容器端口至主机（如JMX端口、调试端口等）。

6.2 访问管理控制台

容器启动后，通过以下URL访问Web控制台（需替换{DOCKER_HOST}为Docker主机IP或域名）：

• Carbon管理控制台：
  https://{DOCKER_HOST}:9443/carbon

• API Publisher（发布者控制台）：
  https://{DOCKER_HOST}:9443/publisher

• Developer Portal（开发者门户）：
  https://{DOCKER_HOST}:9443/devportal

6.3 容器Shell访问与日志查看

查看容器日志

通过Docker日志命令查看API Manager运行日志：

console
$ docker logs api-manager

进入容器Shell

通过docker exec命令进入运行中的容器：

console
$ docker exec -it api-manager bash

6.4 启动参数配置

6.4.1 调试模式运行

如需以调试模式启动容器（假设调试端口为5005），需映射调试端口并传递调试参数：

console
$ docker run -it -p 8280:8280 -p 8243:8243 -p 9443:9443 -p 5005:5005 --name another-api-manager wso2/wso2am:4.0.0 -debug *:5005

6.4.2 JMX端口监控

WSO2 Carbon平台默认启用JMX监控，需映射以下端口：

• 9999：RMI注册端口
• 11111：RMI服务器端口

启动命令：

console
$ docker run -it -p 8280:8280 -p 8243:8243 -p 9443:9443 -p 9999:9999 -p 11111:11111 --name jmx-apim wso2/wso2am:4.0.0

获取JMX服务URL

从容器日志中提取JMX服务URL，示例日志行：

INFO - JMXServerManager JMX Service URL  : service:jmx:rmi://localhost:11111/jndi/rmi://localhost:9999/jmxrmi

通过JConsole等工具连接该URL即可监控容器。详细步骤参见WSO2官方JMX监控文档。

注意：标签为2.5.0的Docker镜像不支持启动参数传递。

6.5 更新配置

通过卷挂载方式修改容器内配置文件（以修改端口偏移量为例）：

1. 准备配置文件：
   从API Manager安装包中复制deployment.toml（路径：{安装目录}/repository/conf）至主机目录（记为{SOURCE_CONFIGS}/deployment.toml），修改[server]->offset值为1（端口偏移量1）。

2. 设置文件权限：
   授予其他用户对配置文件的读权限：

   console
   $ chmod o+r {SOURCE_CONFIGS}/deployment.toml
   

3. 启动容器并挂载配置：

   console
   $ docker run -p 9444:9444 --volume {SOURCE_CONFIGS}/deployment.toml:/home/wso2carbon/wso2am-4.0.0/repository/conf/deployment.toml wso2/wso2am:4.0.0
   

   （容器内配置路径为/home/wso2carbon/wso2am-4.0.0/repository/conf，根据实际版本调整路径中的版本号）。

7. 镜像变体

WSO2 API Manager Docker镜像提供基于不同基础操作系统的变体：

wso2am:{version}

• 基础镜像：Ubuntu 20.04 LTS
• JDK：Temurin OpenJDK 11
• 说明：默认镜像，包含WSO2 API Manager完整安装。

wso2am:{version}-alpine

• 基础镜像：Alpine 3.15
• JDK：Temurin OpenJDK 11
• 说明：轻量级镜像，基于Alpine Linux，体积更小。

wso2am:{version}-centos

• 基础镜像：CentOS 7
• JDK：Temurin OpenJDK 11
• 说明：适用于CentOS环境的镜像。

wso2am:{version}-multiarch

• 基础镜像：Ubuntu 20.04
• JDK：Temurin OpenJDK 11（根据架构自动适配）
• 说明：支持amd64和arm64架构，建议仅用于测试环境。

8. 许可证

镜像中软件的许可信息参见https://github.com/wso2/product-apim/blob/master/LICENSE.txt%E3%80%82
与所有Docker镜像一样，本镜像可能包含其他软件（如Bash、基础系统组件等），其许可可能不同。用户需确保对镜像中所有软件的使用符合相关许可要求。