kiwicom/crane

crane

!crane logo - an origami crane

一个适用于GitLab CI的镜像，用于在Rancher中升级服务。查看我们博客上的完整介绍!

]([]

镜像概述

crane是专为GitLab CI设计的镜像，旨在简化Rancher环境中的服务升级流程。它支持与多种工具集成，帮助团队实现自动化部署并获取实时部署状态通知，提升部署效率与透明度。

核心功能

1. GitLab CI无缝集成：直接融入GitLab CI流水线，实现自动化部署。
2. Rancher服务升级：支持主服务与sidekick服务升级，提供批量升级、间隔设置等灵活选项。
3. 多工具集成：与Slack、Sentry、Datadog及通用webhook集成，发送部署通知、同步版本信息至监控工具。
4. 灵活配置：通过CLI参数或环境变量自定义部署参数，适配不同场景需求。

使用场景

1. GitLab CI流水线中的生产/测试环境部署阶段。
2. 需要自动化升级Rancher上服务的团队。
3. 希望通过Slack获取部署通知的团队。
4. 需要将部署信息同步至Sentry（版本跟踪）或Datadog（事件监控）的场景。

配置说明

使用步骤

1. 在Rancher上手动部署应用，镜像标签使用Git引用（推荐提交SHA或Git标签）。
2. 获取Rancher环境API密钥，在GitLab项目中添加为秘密变量：RANCHER_ACCESS_KEY和RANCHER_SECRET_KEY。
3. 添加RANCHER_URL和RANCHER_ENV_ID（可作为秘密变量或写入.gitlab-ci.yml）。例如，URL https://rancher.example.com/env/1a81/apps/stacks/1e551/services/1s1456/containers中的环境ID为1a81（以1a开头）。
4. 在.gitlab-ci.yml中添加部署阶段：

   yaml
   stages:
     # [...]
     - deploy
   
   deploy-production:
     stage: deploy
     image: kiwicom/crane:3.2.1
     script:
       - crane --stack my-app --service api --service worker
     environment:
       name: production
       url: https://my-app.example.com/
     when: manual
   

基础配置参数

集成与扩展

Slack

设置--slack-token后，crane可向指定频道发送部署通知，并添加Datadog仪表板、Sentry问题等链接。

Sentry

通过--sentry-webhook同步版本信息至Sentry，补充错误跟踪的上下文。

Datadog

设置--datadog-key后，将部署结果发送至Datadog事件流，用于图表标记和仪表盘展示。

通用Webhook

通过--webhook-url指定接收部署信息的URL，用于分析部署与业务指标的关联。