cdrx/rancher-gitlab-deploy

Rancher GitLab部署工具

镜像概述

rancher-gitlab-deploy是一款用于将GitLab CI构建的容器部署到Rancher基础设施的工具，可无缝融入GitLab CI工作流，配置需求少，能在CI流程中升级现有服务。它支持GitLab内置Docker registry和外部Docker registry，并会尽可能从GitLab CI runner设置的环境变量中自动获取配置。

核心功能

• 集成GitLab CI工作流，支持现有服务升级
• 兼容GitLab内置及外部Docker registry
• 自动从GitLab CI环境变量读取配置参数
• 可灵活调整升级策略（如批量大小、间隔时间、启动停止顺序等）
• 支持指定Rancher环境、栈、服务名称及升级用新镜像
• 提供标签、环境变量、服务链接、密钥等扩展配置选项

使用场景

• GitLab CI流水线的部署阶段，自动将构建镜像推送到Rancher集群
• 批量升级Rancher中已存在的服务，替代手动操作
• 针对生产、测试等不同环境实现差异化部署配置

配置说明

前提条件

1. 在Rancher中创建API密钥（环境或账户级别）
2. 在GitLab项目中设置以下秘密变量：
   • RANCHER_URL：Rancher服务器地址（例如https://rancher.example.com）
   • RANCHER_ACCESS_KEY：Rancher API访问密钥
   • RANCHER_SECRET_KEY：Rancher API秘密密钥

部署示例

基础GitLab CI配置

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

常用命令选项

• --environment：指定Rancher环境名称（使用账户API密钥时需设置）
• --stack：指定Rancher栈名称（默认取GitLab项目组名）
• --service：指定Rancher服务名称（默认取GitLab项目名）
• --new-image：设置升级使用的新镜像（如registry.example.com/acme/widget:1.2）
• --batch-size：单次升级的容器数量
• --batch-interval：升级批次间的等待时间（单位：秒）
• --finish-upgrade/--no-finish-upgrade：是否标记升级完成

帮助信息

执行以下命令查看详细帮助：

bash
rancher-gitlab-deploy --help

版本历史

[1.7] - 2020-12-16

修复现有服务变量更新bug；新增--rancher-label-separator、--service-links、--secret选项。

[1.6] - 2018-09-09

新增--rollback-on-error、--label、--variables、--variable选项。

[1.5] - 2017-11-25

修复认证时的UnicodeError问题。

[1.4] - 2017-07-18

修复错误及sidekick处理bug，将--no-start-before-stopping设为默认行为。

[1.3] - 2017-03-16

新增--new-sidekick-image标志以升级sidekick镜像。

[1.2] - 2017-01-03

新增--sidekicks标志以同时升级sidekicks。

[1.1] - 2016-09-29

修复--environment参数导致的崩溃bug。

[1.0] - 2016-09-14

首次发布，功能稳定可用。

许可证

MIT