Docker st2web 镜像文档

镜像概述和主要用途

Docker st2web 镜像是 StackStorm Web UI（st2web）的容器化版本，基于 React 构建，底层使用 Nginx 作为反向代理服务器。该镜像用于提供 StackStorm 自动化平台的 Web 管理界面，通过代理请求至 StackStorm 核心服务（认证服务 st2auth、API 服务 st2api、流服务 st2stream），实现对 StackStorm 的可视化操作与管理。

核心功能和特性

• 容器化部署：简化 st2web 应用的安装与运维，支持跨环境一致部署。
• Nginx 反向代理：内置 Nginx 服务，自动代理请求至 StackStorm 的认证、API 和流服务。
• 环境变量配置：通过环境变量动态指定 StackStorm 核心服务地址，适配不同部署架构。
• SSL 加密支持：集成 Nginx SSL 模块，需配合有效 SSL 证书实现 HTTPS 访问，保障数据传输安全。

使用场景和适用范围

适用于需要通过 Web 界面管理 StackStorm 自动化平台的场景，包括但不限于：

• 开发环境：快速部署 StackStorm Web UI 进行功能测试与流程调试。
• 生产环境：作为 StackStorm 平台的标准 Web 管理入口，供管理员配置规则、执行动作、监控任务等。
• 混合架构：配合 Kubernetes、Docker Compose 等编排工具，实现 StackStorm 分布式部署中的 Web 界面集成。

详细使用方法和配置说明

环境变量配置

容器支持通过以下环境变量配置 StackStorm 核心服务地址，默认值适用于容器与服务同网络的场景（如 Docker Compose 或 Kubernetes Pod 内）：

密钥与 SSL 配置

st2web 依赖 Nginx 进行 SSL 协议协商，需提供有效的 SSL 证书及密钥文件，否则容器无法正常启动。

必要文件

容器需挂载以下 SSL 文件至指定路径：

• /etc/ssl/st2/st2.crt：SSL 证书文件（对应 Nginx ssl_certificate 指令），必填。
• /etc/ssl/st2/st2.key：SSL 证书私钥文件（对应 Nginx ssl_certificate_key 指令），必填。

生成自签名 SSL 证书（测试用）

若暂无有效 SSL 证书，可通过以下命令生成自签名证书（仅建议测试环境使用）：

bash
sudo openssl req \
  -x509 \
  -newkey rsa:2048 \
  -keyout /etc/ssl/st2/st2.key \
  -out /etc/ssl/st2/st2.crt \
  -days 365 \
  -nodes \
  -subj "/C=US/ST=California/L=Palo Alto/O=StackStorm/OU=Information Technology/CN=$(hostname)"

生成后，证书和密钥文件将保存至 /etc/ssl/st2/ 目录。

部署示例

1. Docker Run 命令

通过以下命令启动 st2web 容器，需替换 <本地证书路径> 为实际 SSL 证书目录，并根据部署环境调整服务地址（若核心服务地址非默认）：

bash
docker run -d \
  --name st2web \
  --env ST2_AUTH_URL="[***]" \  # 若核心服务地址不同，需修改此处
  --env ST2_API_URL="[***]" \
  --env ST2_STREAM_URL="[***]" \
  -v <本地证书路径>:/etc/ssl/st2 \  # 挂载本地 SSL 证书目录至容器内路径
  -p 443:443 \  # 映射容器 443 端口（Nginx SSL 默认端口）至主机
  stackstorm/st2web

2. Docker Compose 配置

若与 StackStorm 其他服务（如 st2auth、st2api）通过 Docker Compose 协同部署，示例配置如下：

yaml
version: '3'
services:
  st2web:
    image: stackstorm/st2web
    container_name: st2web
    environment:
      - ST2_AUTH_URL=[***]
      - ST2_API_URL=[***]
      - ST2_STREAM_URL=[***]
    volumes:
      - ./ssl:/etc/ssl/st2  # 本地 SSL 证书目录（包含 st2.crt 和 st2.key）
    ports:
      - "443:443"
    depends_on:
      - st2auth
      - st2api
      - st2stream
    networks:
      - stackstorm-net  # 确保与核心服务在同一网络，实现通信

  # 其他 StackStorm 服务（st2auth、st2api、st2stream）配置省略...
networks:
  stackstorm-net:

注意事项

• 服务网络可达性：st2auth、st2api、st2stream 三个核心服务必须对 st2web 容器网络可达（如通过同一 Docker 网络或 Kubernetes Pod 内通信），否则容器无法正常启动。
• SSL 证书安全性：生产环境中需使用由可信 CA 签发的 SSL 证书，避免使用自签名证书；证书文件权限需限制为仅 root 可读写，防止密钥泄露。
• 端口映射：默认通过 443 端口提供 HTTPS 访问，若主机 443 端口被占用，可修改 -p 参数映射至其他端口（如 -p 8443:443）。