jumplao/rancher-gitlab-deploy

Rancher GitLab部署工具

镜像概述和主要用途

rancher-gitlab-deploy 是一个用于在GitLab CI工作流中部署容器到Rancher基础设施的工具。它可无缝集成到 gitlab-ci.yml 流程中，配置需求少，能作为CI工作流的一部分升级现有服务。支持GitLab内置Docker仓库和外部Docker仓库，可自动从GitLab CI运行器设置的环境变量中获取大部分配置。

注意：该工具不适用于在Rancher中创建新服务，仅用于升级已存在的服务。如需创建服务，应在CI工作流中使用 rancher-compose，但这需要在Git仓库中存储敏感环境变量。

核心功能和特性

• GitLab CI集成：无缝融入GitLab CI/CD流程，作为部署阶段工具使用
• 自动配置：从GitLab CI环境变量自动获取部分配置，减少手动设置
• 多仓库支持：兼容GitLab内置Docker仓库和外部Docker仓库
• 灵活的升级策略：支持调整升级批次大小、间隔时间、容器启停顺序等
• 服务定位：默认使用GitLab项目组名和项目名作为Rancher堆栈和服务名，可手动指定
• 扩展功能：支持升级sidekicks服务、修改镜像标签、设置服务标签和环境变量等

使用场景和适用范围

适用于已在Rancher中创建服务，需要通过GitLab CI/CD流程自动化部署和升级这些服务的场景。特别适合DevOps团队在GitLab中管理代码并自动部署到Rancher基础设施的工作流。

安装

推荐使用预构建容器：

https://hub.docker.com/r/cdrx/rancher-gitlab-deploy/

如需本地安装，可使用 pip：

bash
pip install rancher-gitlab-deploy

使用方法和配置说明

必要准备

需在Rancher中创建API密钥，并在GitLab项目中保存为保密变量，至少需要以下三个变量：

• RANCHER_URL：Rancher服务器URL（例如 https://rancher.example.com）
• RANCHER_ACCESS_KEY：Rancher API访问密钥
• RANCHER_SECRET_KEY：Rancher API密钥密码

Rancher支持环境级和账户级API密钥：

• 使用环境API密钥：直接使用即可
• 使用账户API密钥（可访问多个环境）：需通过 --environment 标志指定环境名

基本使用

默认服务定位

工具默认使用GitLab项目组名作为Rancher堆栈名，项目名作为服务名。例如，项目 http://gitlab.example.com/acme/webservice 会升级Rancher中 acme 堆栈下的 webservice 服务。

手动指定堆栈和服务

若服务名与GitLab仓库名不一致，可通过 --stack 和 --service 标志指定：

yaml
deploy:
  stage: deploy
  image: cdrx/rancher-gitlab-deploy
  script:
    - upgrade --stack acmeinc --service website

修改部署镜像

通过 --new-image 选项指定新镜像（或标签），可结合GitLab环境变量 $CI_BUILD_TAG 使用：

yaml
deploy:
  stage: deploy
  image: cdrx/rancher-gitlab-deploy
  script:
    - upgrade --new-image registry.example.com/acme/widget:$CI_BUILD_TAG

升级策略

默认升级策略：

• 每次升级1个容器，间隔2秒
• 先停止现有容器再启动新容器（避免端口冲突）
• 等待Rancher升级完成后标记为已结束

可通过命令行选项调整策略（详见下方 帮助 部分）。

GitLab CI示例

简单示例

完整 gitlab-ci.yml：

yaml
image: docker:latest
services:
  - docker:dind

stages:
  - build
  - deploy

build:
  stage: build
  script:
    - docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN registry.example.com
    - docker build -t registry.example.com/group/project .
    - docker push registry.example.com/group/project

deploy:
  stage: deploy
  image: cdrx/rancher-gitlab-deploy
  script:
    - upgrade

复杂示例

yaml
deploy:
  stage: deploy
  image: cdrx/rancher-gitlab-deploy
  script:
    - upgrade --environment production --stack acme --service web --new-image alpine:3.4 --no-finish-upgrade

帮助

bash
$ rancher-gitlab-deploy --help

主要选项说明：

历史

[1.6] - 2018-09-09

• 新增 --rollback-on-error 选项（感谢 @TZK- 的PR）
• 新增 --label、--variables、--variable 选项（感谢 @tsteenkamp 的PR）

[1.5] - 2017-11-25

• 修复认证时的UnicodeError错误（感谢 @evilmind 的修复）

[1.4] - 2017-07-18

• 修复错误处理和sidekicks相关bug，将 --no-start-before-stopping 设为默认行为

[1.3] - 2017-03-16

• 新增 --new-sidekick-image 标志，支持升级sidekicks镜像（感谢 @kariae 的PR）

[1.2] - 2017-01-03

• 新增 --sidekicks 标志，支持同时升级sidekicks服务（感谢 @kiesiu 的PR）

[1.1] - 2016-09-29

• 修复使用 --environment 时的崩溃问题（感谢 @mvriel 的PR）

[1.0] - 2016-09-14

• 首次发布，功能可用

许可证

MIT