scholarshipowl/gcloud-helm-ko

gcloud-helm-ko

镜像概述与主要用途

gcloud-helm-ko是一个集成了Google Cloud SDK、Helm3、Ko及helmfile工具的Docker镜像，旨在简化CI/CD流水线中与GCP（Google Cloud Platform）和Kubernetes相关的构建、认证及部署流程。通过整合这些工具，用户可在CI环境中一站式完成Go应用容器化（Ko）、GCP资源操作（Google Cloud SDK）及Kubernetes应用部署（Helm3/helmfile）。

核心功能与特性

• 多工具集成：包含Google Cloud SDK（GCP操作）、Helm3（Kubernetes包管理）、Ko（Go应用容器快速构建工具）及helmfile（多Helm chart管理工具），满足CI流程中的多环节需求。
• GCP凭证支持：通过环境变量配置GCP认证信息，简化GCP资源访问授权。
• GKE环境配置：支持通过环境变量快速配置GKE（Google Kubernetes Engine）集群信息，直接对接Kubernetes集群。
• CI环境适配：优化用于CI场景，可直接作为Gitlab-CI等CI平台的运行环境镜像。

使用场景与适用范围

• CI/CD流水线中的构建阶段：使用Ko快速构建Go应用容器镜像并推送到仓库。
• CI/CD流水线中的部署阶段：通过Helm3或helmfile将应用部署到GKE集群。
• 需要与GCP、Kubernetes交互的自动化任务：如GCP资源查询、Kubernetes资源管理等。
• 多Helm chart的统一管理与部署场景（基于helmfile）。

配置说明（环境变量）

GCP凭证配置

• GOOGLE_APPLICATION_CREDENTIALS：当设置此变量时，镜像将使用其指定的凭证文件初始化GCP认证。

GKE环境配置

以下环境变量用于配置GKE集群信息，简化与Kubernetes集群的对接：

• CLOUDSDK_CONTAINER_CLUSTER：GKE集群名称。
• CLOUDSDK_COMPUTE_ZONE：GKE集群所在区域（如us-central1-a）。
• CLOUDSDK_CORE_PROJECT：GCP项目ID。

使用方法（Gitlab-CI示例）

在Gitlab-CI中使用时，需在.gitlab-ci.yaml中定义相关变量并配置作业阶段。

变量定义

yaml
variables:
  CLOUDSDK_COMPUTE_ZONE: {{区域}}          # GKE集群所在区域，如us-central1-a
  CLOUDSDK_CORE_PROJECT: {{项目ID}}        # GCP项目ID
  CLOUDSDK_CONTAINER_CLUSTER: {{集群名称}}  # GKE集群名称
  DEPLOYMENT_NAME: {{部署名称}}            # Helm部署名称
  KO_DOCKER_REPO: {{Go容器仓库前缀}}       # Ko构建的容器镜像仓库前缀（如gcr.io/[项目ID]）
  DOCKER_REPO: {{其他容器仓库前缀}}        # 非Go应用的容器镜像仓库前缀
  NAMESPACE: {{命名空间}}                  # Kubernetes命名空间

构建阶段（go-build）

使用Ko构建Go应用容器镜像：

yaml
go-build:
  stage: build
  image: scholarshipowl/gcloud-helm-ko
  script: ko publish -B -t ${CI_COMMIT_SHORT_SHA} .  # -B：构建平台无关镜像，-t：指定标签为Git提交短SHA

说明：此阶段将创建镜像 ${KO_DOCKER_REPO}/go-cmd:${CI_COMMIT_SHORT_SHA}（go-cmd为应用名称，由Ko根据项目自动生成）。

部署阶段（deploy）

使用Helm3将应用部署到GKE集群：

yaml
deploy:
  stage: deploy
  image: scholarshipowl/gcloud-helm-ko
  script: 
    # 注意：在k8s runner中存在入口点（entrypoint）被覆盖的问题，需手动执行入口点脚本
    # 若使用其他类型runner，可移除此行
    # 参考：https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4125
    - /docker-entrypoint.sh

    # 执行Helm部署命令
    - helm upgrade ${DEPLOYMENT_NAME} chart/
      --install  # 若部署不存在则安装，存在则升级
      --set image.tag=${CI_COMMIT_SHORT_SHA}  # 设置镜像标签为构建阶段的Git提交短SHA
      --namespace ${NAMESPACE}  # 指定Kubernetes命名空间

说明：此阶段通过helm upgrade --install命令将chart/目录下的Helm chart部署到${CLOUDSDK_CONTAINER_CLUSTER}集群的${NAMESPACE}命名空间。

Helmfile支持

镜像内置helmfile工具（https://github.com/roboll/helmfile%EF%BC%89%EF%BC%8C%E7%94%A8%E4%BA%8E%E7%AE%A1%E7%90%86%E5%A4%9AHelm chart的部署配置。通过编写helmfile.yaml，可实现更复杂的Helm chart版本控制、依赖管理及多环境部署。

使用示例（Gitlab-CI部署阶段）

yaml
deploy:
  stage: deploy
  image: scholarshipowl/gcloud-helm-ko
  script:
    - helmfile -e prod apply  # 应用prod环境的helmfile配置
      --set imageTag=${CI_COMMIT_SHORT_SHA}  # 覆盖镜像标签为Git提交短SHA