GitLab CI 与 Kubernetes 集成：实现自动化部署到 K8s – wiki基地

GitLab CI 与 Kubernetes 集成：实现自动化部署到 K8s

在现代软件开发中，持续集成和持续部署 (CI/CD) 流程至关重要，它们能够加速软件交付、提高代码质量并减少部署风险。GitLab CI/CD 提供了一个强大的平台，可以自动构建、测试和部署代码。而 Kubernetes (K8s) 作为一个容器编排平台，能够提供高度可扩展、弹性和自修复能力。将 GitLab CI/CD 与 Kubernetes 集成，可以实现自动化部署到 K8s 集群，极大地简化部署流程，提升效率。

本文将详细介绍如何将 GitLab CI 与 Kubernetes 集成，实现自动化部署到 K8s 集群，涵盖以下内容：

1. 集成前的准备：

• Kubernetes 集群准备： 包括搭建 Kubernetes 集群、配置 Kubernetes API 服务器访问权限、创建 Kubernetes 命名空间等。
• GitLab 项目准备： 包括创建 GitLab 项目、配置 Git 仓库、定义 Dockerfile 文件等。
• CI/CD 工具准备： 包括安装和配置 kubectl 工具、Helm 工具（可选）、Docker 工具等。

2. 配置 GitLab CI/CD：

• 创建 .gitlab-ci.yml 文件： 定义 CI/CD 流水线，包括构建、测试、打包和部署阶段。
• 配置 GitLab CI/CD 变量： 定义 Kubernetes 集群的连接信息、Docker 镜像仓库的凭证等。
• 定义 GitLab Runner： 选择合适的 GitLab Runner，如 shell executor 或 Docker executor，并配置访问 Kubernetes 集群的权限。

3. 实现自动化部署：

• 使用 kubectl 部署： 通过 kubectl 命令与 Kubernetes API 服务器交互，创建、更新和删除 Kubernetes 资源。
• 使用 Helm 部署： 通过 Helm 工具管理 Kubernetes 应用，简化部署和升级流程。
• 配置滚动更新： 实现平滑更新 Kubernetes 应用，减少停机时间。

4. 最佳实践和注意事项：

• 安全性： 保护 Kubernetes 集群的访问权限，避免敏感信息泄露。
• 可观察性： 监控 Kubernetes 应用的运行状态，及时发现和解决问题。
• 版本控制： 管理 Kubernetes 资源的版本，方便回滚和审计。
• 日志记录： 记录 Kubernetes 应用的日志，方便排查问题。

1. 集成前的准备

在开始集成 GitLab CI 与 Kubernetes 之前，需要先做好以下准备工作：

1.1 Kubernetes 集群准备

• 搭建 Kubernetes 集群： 你可以使用各种工具来搭建 Kubernetes 集群，例如：

  • Minikube： 一个轻量级的 Kubernetes 实现，适合本地开发和测试。
  • Kind： 使用 Docker 容器运行 Kubernetes 集群，适合 CI/CD 环境。
  • kubeadm： 一个用于引导 Kubernetes 集群的工具，适合生产环境。
  • 云服务提供商： 如 Google Kubernetes Engine (GKE)、Amazon Elastic Kubernetes Service (EKS) 和 Azure Kubernetes Service (AKS)，提供托管的 Kubernetes 服务。

  选择合适的 Kubernetes 集群搭建方式，取决于你的需求和资源。对于开发测试环境，Minikube 或 Kind 是不错的选择。对于生产环境，建议使用 kubeadm 或云服务提供商提供的托管服务。

• 配置 Kubernetes API 服务器访问权限： 你需要配置 Kubernetes API 服务器的访问权限，以便 GitLab Runner 可以访问 Kubernetes 集群。这通常涉及创建 Kubernetes Service Account，并授予该 Service Account 适当的权限，例如 cluster-admin 或 namespace-admin。

• 创建 Kubernetes 命名空间： 建议为你的 GitLab 项目创建一个独立的 Kubernetes 命名空间，以便更好地隔离和管理资源。

1.2 GitLab 项目准备

• 创建 GitLab 项目： 如果你还没有 GitLab 项目，你需要创建一个新的项目，用于存储你的代码和 CI/CD 配置。

• 配置 Git 仓库： 将你的代码提交到 Git 仓库中，并确保代码可以构建和运行。

• 定义 Dockerfile 文件： Dockerfile 文件用于定义如何构建你的应用程序的 Docker 镜像。 Dockerfile 应该包含所有必要的依赖项和配置，以便能够成功构建和运行你的应用程序。 例如：

“`dockerfile
FROM node:16

WORKDIR /app

COPY package*.json ./

RUN npm install

COPY . .

EXPOSE 3000

CMD [“npm”, “start”]
“`

1.3 CI/CD 工具准备

• 安装和配置 kubectl 工具： kubectl 是 Kubernetes 的命令行工具，用于与 Kubernetes API 服务器交互。 你需要在 GitLab Runner 上安装和配置 kubectl，以便它可以访问 Kubernetes 集群。

• 安装和配置 Helm 工具 (可选)： Helm 是 Kubernetes 的包管理工具，可以帮助你管理 Kubernetes 应用。 如果你使用 Helm 来部署你的应用程序，你需要安装和配置 Helm 工具。

• 安装和配置 Docker 工具： 如果你使用 Docker executor 作为 GitLab Runner，你需要安装和配置 Docker 工具。

2. 配置 GitLab CI/CD

2.1 创建 .gitlab-ci.yml 文件

.gitlab-ci.yml 文件是 GitLab CI/CD 的核心配置文件，用于定义 CI/CD 流水线。 .gitlab-ci.yml 文件位于你的 Git 仓库的根目录中。

一个典型的 .gitlab-ci.yml 文件可能包含以下阶段：

• build: 构建你的应用程序的 Docker 镜像。
• test: 运行你的应用程序的单元测试和集成测试。
• deploy: 将你的应用程序部署到 Kubernetes 集群。

以下是一个简单的 .gitlab-ci.yml 文件示例：

“`yaml
image: docker:latest

services:
– docker:dind

stages:
– build
– test
– deploy

variables:
DOCKER_IMAGE: your-docker-registry/your-image-name
KUBE_NAMESPACE: your-kubernetes-namespace

before_script:
– docker login -u $DOCKER_USER -p $DOCKER_PASSWORD

build:
stage: build
script:
– docker build -t $DOCKER_IMAGE:$CI_COMMIT_SHA .
– docker push $DOCKER_IMAGE:$CI_COMMIT_SHA

test:
stage: test
script:
– echo “Running tests…”
– # Add your test commands here

deploy:
stage: deploy
image: bitnami/kubectl:latest
script:
– kubectl config use-context your-kubernetes-context
– kubectl apply -n $KUBE_NAMESPACE -f kubernetes/deployment.yaml
– kubectl apply -n $KUBE_NAMESPACE -f kubernetes/service.yaml
only:
– main
“`

解释:

• image: docker:latest: 指定用于运行 CI/CD 作业的 Docker 镜像。 在这个例子中，我们使用 docker:latest 镜像，它包含了 Docker 工具。
• services: - docker:dind: 指定需要运行的 Docker 服务。 在这个例子中，我们使用 docker:dind 服务，它提供了 Docker-in-Docker 功能，允许在容器中运行 Docker 命令。
• stages: 定义 CI/CD 流水线的阶段。
• variables: 定义全局变量，可以在 CI/CD 流水线中使用。
• before_script: 在每个作业之前执行的脚本。 在这个例子中，我们使用 docker login 命令登录到 Docker 镜像仓库。
• build: 构建 Docker 镜像的阶段。 我们使用 docker build 命令构建镜像，并使用 docker push 命令将镜像推送到 Docker 镜像仓库。
• test: 运行测试的阶段。
• deploy: 将应用程序部署到 Kubernetes 集群的阶段。 我们使用 kubectl config use-context 命令选择 Kubernetes 上下文，并使用 kubectl apply 命令部署 Kubernetes 资源。
• only: - main: 指定只有在 main 分支上提交代码时才运行 deploy 阶段。

2.2 配置 GitLab CI/CD 变量

你需要配置 GitLab CI/CD 变量，以便在 CI/CD 流水线中使用。 你可以在 GitLab 项目的 Settings > CI/CD > Variables 页面中配置 CI/CD 变量。

你需要配置以下变量：

• DOCKER_USER: Docker 镜像仓库的用户名。
• DOCKER_PASSWORD: Docker 镜像仓库的密码。
• KUBE_NAMESPACE: Kubernetes 命名空间。
• KUBE_CONFIG: Kubernetes 的配置文件，包含连接到 Kubernetes 集群的信息，也可以通过设置 KUBE_HOST, KUBE_TOKEN 等变量替代。
• KUBE_CONTEXT: Kubernetes 上下文，用于指定要连接的 Kubernetes 集群。

注意: 为了安全起见，建议将敏感信息 (例如 Docker 密码和 Kubernetes API 令牌) 存储为 masked variables，这样它们就不会在 CI/CD 日志中显示。

2.3 定义 GitLab Runner

GitLab Runner 是用于执行 CI/CD 作业的代理程序。 你需要选择合适的 GitLab Runner，并配置访问 Kubernetes 集群的权限。

你可以选择以下 GitLab Runner：

• Shell executor: Shell executor 在运行 GitLab Runner 的同一台机器上执行 CI/CD 作业。 这种类型的 Runner 简单易用，但安全性较低。

• Docker executor: Docker executor 在 Docker 容器中执行 CI/CD 作业。 这种类型的 Runner 更加安全和可移植。

• Kubernetes executor: Kubernetes executor 在 Kubernetes 集群中执行 CI/CD 作业。 这种类型的 Runner 可以利用 Kubernetes 集群的资源。

建议使用 Docker executor 或 Kubernetes executor，以提高安全性和可移植性。

如果使用 shell executor 或 Docker executor，你需要确保 GitLab Runner 具有访问 Kubernetes 集群的权限。 这通常涉及将 Kubernetes 配置文件 (kubeconfig) 复制到 GitLab Runner 的机器上，并配置 kubectl 工具。

3. 实现自动化部署

3.1 使用 kubectl 部署

kubectl 是与 Kubernetes 集群交互的主要工具。 你可以使用 kubectl 命令创建、更新和删除 Kubernetes 资源。

在 .gitlab-ci.yml 文件中，你可以使用 kubectl apply 命令部署 Kubernetes 资源，例如 Deployment、Service 和 Ingress。

例如：

yaml
deploy:
stage: deploy
image: bitnami/kubectl:latest
script:
- kubectl config use-context your-kubernetes-context
- kubectl apply -n $KUBE_NAMESPACE -f kubernetes/deployment.yaml
- kubectl apply -n $KUBE_NAMESPACE -f kubernetes/service.yaml
only:
- main

3.2 使用 Helm 部署

Helm 是 Kubernetes 的包管理工具，可以帮助你管理 Kubernetes 应用。 Helm 使用 Chart 来定义 Kubernetes 应用的配置。

如果你使用 Helm 来部署你的应用程序，你需要在 .gitlab-ci.yml 文件中安装和配置 Helm 工具，并使用 helm upgrade --install 命令部署你的应用程序。

例如：

yaml
deploy:
stage: deploy
image: alpine/helm:latest
script:
- helm upgrade --install your-app ./helm/your-app -n $KUBE_NAMESPACE
only:
- main

3.3 配置滚动更新

滚动更新是一种逐步更新 Kubernetes 应用的策略，可以减少停机时间。 你可以使用 Kubernetes Deployment 的 strategy 字段来配置滚动更新。

例如：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: your-app
spec:
replicas: 3
selector:
matchLabels:
app: your-app
strategy:
type: RollingUpdate
rollingUpdate:
maxSurge: 25%
maxUnavailable: 25%
template:
metadata:
labels:
app: your-app
spec:
containers:
- name: your-app
image: your-docker-registry/your-image-name:latest
ports:
- containerPort: 3000

4. 最佳实践和注意事项

• 安全性： 保护 Kubernetes 集群的访问权限，避免敏感信息泄露。 使用 Kubernetes RBAC 来控制用户和 Service Account 的权限。

• 可观察性： 监控 Kubernetes 应用的运行状态，及时发现和解决问题。 使用 Prometheus 和 Grafana 等工具来监控 Kubernetes 集群和应用程序。

• 版本控制： 管理 Kubernetes 资源的版本，方便回滚和审计。 使用 GitOps 来管理 Kubernetes 资源的版本。

• 日志记录： 记录 Kubernetes 应用的日志，方便排查问题。 使用 Fluentd 或 Elasticsearch 等工具来收集和分析 Kubernetes 应用的日志。

总结

通过将 GitLab CI/CD 与 Kubernetes 集成，你可以实现自动化部署到 K8s 集群，极大地简化部署流程，提升效率。 本文详细介绍了如何将 GitLab CI 与 Kubernetes 集成，包括集成前的准备、配置 GitLab CI/CD、实现自动化部署以及最佳实践和注意事项。 希望本文能够帮助你更好地理解和应用 GitLab CI/CD 和 Kubernetes，从而提高软件开发和交付效率。