wuyfeehub/nacos-ci

Nacos Pipeline Docker镜像文档

1. 镜像概述和主要用途

Nacos Pipeline 是一款基于 Nacos 平台的自动化流水线工具镜像，旨在简化微服务架构中 Nacos 相关的配置管理、服务注册与发现流程，实现 CI/CD 流水线与 Nacos 的无缝集成。通过该镜像，用户可在 CI/CD 流程中自动化完成 Nacos 配置发布、服务注册、配置版本控制、多环境同步等操作，提升微服务部署效率与配置一致性。

2. 核心功能和特性

• Nacos 配置自动化管理：支持配置的创建、更新、删除、版本控制及回滚，无需手动操作 Nacos 控制台。
• 服务注册与发现集成：自动完成微服务实例的注册、注销及健康状态同步，简化服务治理流程。
• 多环境配置同步：支持跨 Nacos 命名空间（Namespace）或分组（Group）的配置同步，适配开发、测试、生产等多环境场景。
• 主流 CI/CD 工具兼容：可无缝集成 Jenkins、GitLab CI、GitHub Actions 等主流 CI/CD 平台，支持流水线脚本化调用。
• 轻量级设计：基于 Alpine 基础镜像构建，体积小、启动快，资源占用低。
• 安全认证支持：兼容 Nacos 内置的用户名密码认证及 LDAP 认证机制。

3. 使用场景和适用范围

• 微服务 CI/CD 流水线：在微服务构建部署流程中，自动更新 Nacos 配置（如数据库地址、限流规则等），避免手动操作风险。
• 多环境配置一致性管理：需保证开发、测试、生产环境 Nacos 配置同步或差异化管理的场景。
• 配置版本化与审计：需要对 Nacos 配置变更进行版本记录、审计追踪及快速回滚的团队。
• 自动化运维：通过脚本化调用实现 Nacos 服务注册状态监控、异常服务自动注销等运维场景。

4. 使用方法和配置说明

4.1 镜像拉取

bash
docker pull nacos/pipeline:latest  # 拉取最新版本
# 或指定版本：docker pull nacos/pipeline:v1.0.0

4.2 基本使用（docker run 命令）

示例 1：发布 Nacos 配置

bash
docker run --rm \
  -e NACOS_SERVER_ADDR="http://nacos-server:8848" \
  -e NACOS_NAMESPACE="dev" \
  -e NACOS_USERNAME="nacos" \
  -e NACOS_PASSWORD="nacos" \
  -e OPERATION="CONFIG_PUBLISH" \
  -e CONFIG_GROUP="DEFAULT_GROUP" \
  -e CONFIG_DATA_ID="service-user.properties" \
  -e CONFIG_CONTENT="spring.datasource.url=jdbc:mysql://db-dev:3306/user_db\nspring.datasource.username=dev_user" \
  nacos/pipeline:latest

示例 2：注册服务到 Nacos

bash
docker run --rm \
  -e NACOS_SERVER_ADDR="http://nacos-server:8848" \
  -e NACOS_NAMESPACE="prod" \
  -e NACOS_USERNAME="admin" \
  -e NACOS_PASSWORD="Admin@123" \
  -e OPERATION="SERVICE_REGISTER" \
  -e SERVICE_NAME="service-order" \
  -e SERVICE_IP="10.0.0.10" \
  -e SERVICE_PORT="8080" \
  -e SERVICE_GROUP="DEFAULT_GROUP" \
  -e SERVICE_HEALTH_CHECK_URL="http://10.0.0.10:8080/actuator/health" \
  nacos/pipeline:latest

4.3 docker-compose 配置示例

yaml
version: '3.8'
services:
  nacos-pipeline:
    image: nacos/pipeline:latest
    environment:
      # Nacos 服务地址（必填）
      NACOS_SERVER_ADDR: "http://nacos-server:8848"
      # Nacos 命名空间（可选，默认 public）
      NACOS_NAMESPACE: "prod"
      # Nacos 认证信息（若开启认证则必填）
      NACOS_USERNAME: "admin"
      NACOS_PASSWORD: "Admin@123"
      # 操作类型（必填，支持 CONFIG_PUBLISH/CONFIG_DELETE/SERVICE_REGISTER/SERVICE_DEREGISTER）
      OPERATION: "CONFIG_PUBLISH"
      # 配置发布相关参数（OPERATION=CONFIG_PUBLISH 时必填）
      CONFIG_GROUP: "ORDER_SERVICE"
      CONFIG_DATA_ID: "order-service.yaml"
      CONFIG_CONTENT: |
        server:
          port: 8081
        spring:
          application:
            name: order-service
    depends_on:
      - nacos-server

  nacos-server:
    image: nacos/nacos-server:v2.3.0
    ports:
      - "8848:8848"
    environment:
      - MODE=standalone

4.4 配置参数说明

4.4.1 通用参数（必填）

4.4.2 认证参数（Nacos 开启认证时必填）

4.4.3 配置管理参数（OPERATION 为 CONFIG_* 时必填）

4.4.4 服务管理参数（OPERATION 为 SERVICE_* 时必填）

5. 注意事项

• 镜像需与 Nacos 服务端版本兼容（推荐 Nacos 2.0+），低版本 Nacos 可能存在接口差异。
• 配置内容中包含特殊字符（如换行、引号）时，建议使用 Docker 环境变量的多行字符串语法（如示例中的 CONFIG_CONTENT: |）。
• 生产环境中建议通过 Docker Secrets 或环境变量管理工具（如 Kubernetes ConfigMap）传递敏感信息（如 NACOS_PASSWORD）。
• 执行批量操作（如多配置同步）时，建议通过脚本循环调用镜像，或使用 docker-compose 编排多任务。

注：以上文档基于 Nacos 流水线工具的常见功能推断，具体以实际镜像版本及官方说明为准。