Skip to main content
Version: 2.6.0

Docker部署

本文介绍使用 docker 来部署 Apache ShenYu 网关。

在阅读本文档前，你需要先阅读部署先决条件文档来完成部署 shenyu 前的环境准备工作。

创建 Docker Network#

docker network create shenyu

启动 Apache ShenYu Admin#

docker pull apache/shenyu-admin:${current.version}

在 2.5.1 版本之后，在 docker run 时，可以通过添加 -e ADMIN_JVM="xxxx" 来自定义 JVM 启动参数

  • 使用 h2 来存储后台数据：
docker run -d -p 9095:9095 --name shenyu-admin --net shenyu apache/shenyu-admin:${current.version}
docker run --name shenyu-admin -v /${your_work_dir}/ext-lib:/opt/shenyu-admin/ext-lib -e "SPRING_PROFILES_ACTIVE=mysql" -e "spring.datasource.url=jdbc:mysql://${your_ip_port}/shenyu?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai&zeroDateTimeBehavior=convertToNull" -e "spring.datasource.username=${your_username}" -e "spring.datasource.password=${your_password}" -d -p 9095:9095 --net shenyu apache/shenyu-admin:${current.version}

另外一种方式, 从 配置文件地址 中把 application.yml、application-mysql.yml配置放到${your_work_dir}/conf ， 调整application.yml中的配置spring.profiles.active = mysql，然后执行以下语句：

docker run --name shenyu-admin -v ${your_work_dir}/conf:/opt/shenyu-admin/conf -v /${your_work_dir}/ext-lib:/opt/shenyu-admin/ext-lib -d -p 9095:9095 --net shenyu apache/shenyu-admin:${current.version}
  • 使用 PostgreSql 来存储后台数据, 按照 指引文档 初始化数据库, 执行以下语句：
docker run --name shenyu-admin -e "SPRING_PROFILES_ACTIVE=pg" -e "spring.datasource.url=jdbc:postgresql://${your_ip_port}/shenyu?useUnicode=true&characterEncoding=utf-8&useSSL=false" -e "spring.datasource.username=${your_username}" -e "spring.datasource.password=${your_password}" -d -p 9095:9095 --net shenyu apache/shenyu-admin:${current.version}

另外一种方式, 从 配置文件地址 中把 application.yml、application-pg.yml配置放到${your_work_dir}/conf， 调整application.yml中的配置spring.profiles.active = pg，然后执行以下语句：

docker run --name shenyu-admin -v ${your_work_dir}/conf:/opt/shenyu-admin/conf -d -p 9095:9095 --net shenyu apache/shenyu-admin:${current.version}
  • 使用 Oracle 来存储后台数据, 按照 指引文档 初始化数据库, 执行以下语句：
docker run --name shenyu-admin -e "SPRING_PROFILES_ACTIVE=oracle" -e "spring.datasource.url=jdbc:oracle:thin:@localhost:1521/shenyu" -e "spring.datasource.username=${your_username}" -e "spring.datasource.password=${your_password}" -d -p 9095:9095 --net shenyu apache/shenyu-admin:${current.version}

另外一种方式, 从 配置文件地址 中把 application.yml、application-oracle.yml 配置放到${your_work_dir}/conf， 调整application.yml中的配置spring.profiles.active = oracle，然后执行以下语句：

docker run --name shenyu-admin -v ${your_work_dir}/conf:/opt/shenyu-admin/conf -d -p 9095:9095 --net shenyu apache/shenyu-admin:${current.version}
  • 使用 OpenGauss 来存储后台数据, 按照 指引文档 初始化数据库, 执行以下语句：
docker run --name shenyu-admin -e "SPRING_PROFILES_ACTIVE=opengauss" -e "spring.datasource.url=jdbc:opengauss://localhost:5432/shenyu" -e "spring.datasource.username=${your_username}" -e "spring.datasource.password=${your_password}" -d -p 9095:9095 --net shenyu apache/shenyu-admin:${current.version}

另外一种方式, 从 配置文件地址 中把 application.yml、application-og.yml 配置放到${your_work_dir}/conf， 调整application.yml中的配置spring.profiles.active = og，然后执行以下语句：

docker run --name shenyu-admin -v ${your_work_dir}/conf:/opt/shenyu-admin/conf -d -p 9095:9095 --net shenyu apache/shenyu-admin:${current.version}

启动Apache ShenYu Bootstrap#

在 2.5.1 版本之后，在 docker run 时，可以通过添加 -e BOOT_JVM="xxxx" 来自定义 JVM 启动参数

首先拉取 Docker 镜像

docker pull apache/shenyu-bootstrap:${current.version}

如果不需要修改配置，可以直接使用以下命令启动

docker run -d \  -p 9195:9195 \  --name shenyu-bootstrap \  --net shenyu \  --env SHENYU_SYNC_WEBSOCKET_URLS=ws://shenyu-admin:9095/websocket \  apache/shenyu-bootstrap:${current.version}

使用 SHENYU_SYNC_WEBSOCKET_URLS 环境变量可以为 bootstrap 指定与 admin 通信的 Websocket 地址

如果需要修改配置，可以从 Github 中拉取 bootstrap 的配置文件，将其所在目录记为 $BOOTSTRAP_CONF，并进行配置修改。修改完毕后，使用以下命令启动

docker run -d \  -p 9195:9195 \  -v $BOOTSTRAP_CONF:/opt/shenyu-bootstrap/conf \  --name shenyu-bootstrap \  --net shenyu \  --env SHENYU_SYNC_WEBSOCKET_URLS=ws://shenyu-admin:9095/websocket \  apache/shenyu-bootstrap:${current.version}