vikyai/tools-gitlab-auto-deploy-image

tools-gitlab-auto-deploy-image

镜像概述

本Docker镜像用于在GitLab CI/CD流程中实现Docker镜像构建与Kubernetes集群部署的自动化。注意：从v2.0版本开始，需依赖Helm 3。

核心功能

Kubernetes相关命令

• kube_setup：初始化Kubernetes环境，包括设置kubectl（基于KUBECONFIG或KUBECONFIG_URL）、创建命名空间（基于KUBE_NAMESPACE）、初始化Helm及创建镜像拉取密钥。
• kube_cleanup：清理Kubernetes环境，包括删除Helm release、Tiller服务、Pod/ConfigMap/Secret及命名空间（非GitLab托管集群时）。
• kube_get_pods：根据选择器获取Pod名称。

Docker相关命令

• docker_build：根据CI_COMMIT_REF_SLUG构建、打标签并推送镜像。
• docker_tag_latest：将指定镜像标签为latest并推送。
• docker_digest_tag：拉取镜像并返回带摘要的完整标签（用于部署时固定镜像版本）。
• docker_gitlab_login：使用GitLab CI默认变量登录GitLab镜像仓库。
• docker_external_login：使用EXTERNAL_REGISTRY系列变量登录外部镜像仓库。
• docker_push_gitlab_to_external：将GitLab仓库镜像同步至外部仓库。

其他命令

• check_version：显示docker、kubectl、helm版本。
• notify_deployment：向Grafana监控服务发送部署通知。

使用场景

适用于GitLab CI/CD流水线中的构建、部署阶段，实现从代码到Kubernetes集群的自动化交付。

配置说明

需配置相关环境变量（如KUBECONFIG、KUBE_NAMESPACE、EXTERNAL_REGISTRY等）以适配不同部署场景。

部署示例

在.gitlab-ci.yml中添加以下配置：

image: vikyai/tools-gitlab-auto-deploy-image:latest
before_script:
  - . /auto-deploy.sh

stages:
  - build
  - deploy

build:
  stage: build
  script:
    - docker_build       ${CI_REGISTRY_IMAGE}
    - docker_tag_latest  ${CI_REGISTRY_IMAGE}

kube:
  stage: deploy
  environment:
    name: ${CI_COMMIT_REF_NAME}
  script:
    - kube_setup
    - helm upgrade --wait --install "${RELEASE_NAME}" stable/redis

cleanup:
  stage: deploy
  environment:
    name: ${CI_COMMIT_REF_NAME}
    action: stop
  variables:
      GIT_STRATEGY: none
  script:
    - kube_setup
    - kube_cleanup
  when: manual
  allow_failure: true