ArgoCD 简明教程

作者：Se7en

2021 年 12 月 19 日
本文字数：5055 字
阅读完需：约 17 分钟

1 Argo CD 简介

Argo CD 是一个为 Kubernetes 而生的，遵循声明式 GitOps 理念的持续部署（CD）工具，它的配置和使用非常简单，并且自带一个简单易用的 Dashboard 页面，并且支持多种配置管理/模板工具（例如 Kustomize、Helm、Ksonnet、Jsonnet、plain-YAML）。Argo CD 被实现为一个 Kubernetes 控制器，它持续监控正在运行的应用程序并将当前的实时状态与所需的目标状态（例如 Git 仓库中的配置）进行比较，在 Git 仓库更改时自动同步和部署应用程序。

2 架构图

Argo CD 在 CI/CD 流程中的位置如下图所示，Argo CD 的主要职责是 CD（Continuous Delivery，持续交付），将应用部署到 Kubernetes 等环境中，而 CI（Continuous Integration，持续集成）主要是交给 Jenkins，Gitlab CI 等工具来完成。

这里简单介绍一下 GitOps 的概念，GitOps 这个词出现于 2017 年，是由 Weaveworks 公司根据多年云计算基础设施和应用程序管理经验而提出的一个概念，它是一种进行 Kubernetes 集群管理和应用程序交付的方式，GitOps 使用 Git 作为声明性基础设施和应用程序的单一事实来源。

GitOps 的核心思想是拥有一个 Git 仓库，包含目标环境中当前所需基础设施的声明性描述，以及使目标环境与 Git 仓库中描述的状态相匹配的自动化过程，Argo CD 就是一个遵循了 GitOps 理念的持续部署（CD）工具。

在 GitOps 模式的 CI/CD 流水线包含以下几个流程：

1.将应用的 Git 仓库分为 Application Deployment file 和 Docker file 两个库。 Docker file 用于存放应用的核心代码以及 Docker build file，后续将会直接打包成 Docker image；Application Deployment file 可以 Kustomize、Helm、Ksconnet、Jsonnet 等多种 Kubernetes 包管理工具来定义；以 Helm 为例，Chart 中所使用到的 Image 由 Docker file Code 打包完成后提供。
2.使用 Jenkins 或 Gitlab 等 CI 工具进行自动化构建打包，并将 Docker image push 到 Harbor 镜像仓库。
3.使用 Argo CD 部署应用。Argo CD 可以独立于集群之外，并且支持管理多个 Kubernetes 集群。在 Argo CD 上配置好应用部署的相关信息后 Argo CD 便可以正常工作，Argo CD 会自动和代码仓库 Application deployment file 的内容进行校验，当代码仓库中应用属性等信息发生变化时，Argo CD 会自动同步更新 Kubernetes 集群中的应用；应用启动时，会从 Harbor 镜像仓库拉取 Docker image。

本文主要介绍第 3 部分 Argo CD 部署应用，关于 GitOps 的完整实践后续会发文进行介绍。

3 快速开始

3.1 前提条件

1.准备好一套 Kubernetes 集群，参见使用 ezctl 工具部署和管理 Kubernetes 集群。
2.搭建好 Gitlab 代码仓库，参见 Gitlab 安装指南。

3.2 安装 Argo CD

使用以下命令在 argocd 命名空间部署 Argo CD。

# 创建命名空间kubectl create namespace argocd # 部署 argo cdwget https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yamlkubectl apply -n argocd -f install.yaml

复制代码

3.3 安装 Argo CD CLI

Argo CD CLI 是用于管理 Argo CD 的命令行工具，不同操作系统具体的安装方式可以参考 Argo CD CLI Installation

Mac 系统可以直接使用 brew install 进行安装。

brew install argocd

复制代码

3.4 发布 Argo CD 服务

默认情况下， Argo CD 服务不对外暴露服务，可以通过 LoadBalancer 或者 NodePort 类型的 Service、Ingress、Kubectl 端口转发等方式将 Argo CD 服务发布到 Kubernetes 集群外部。

这里使用以下命令通过 NodePort 服务的方式暴露 Argo CD 到集群外部。

kubectl patch svc argocd-server -n argocd -p '{"spec": {"type": "NodePort"}}'

复制代码

现在我们已经将名字为 argocd-server 的 Service 改成 NodePort 类型了，可以在集群外部通过 <节点 IP>:<随机生成的 NodePort 端口> 来访问 Argo CD，我这里随机生成的 NodePort 端口是 32313。

$ kubectl get svc -n argocd NAME                    TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)                      AGEargocd-dex-server       ClusterIP   10.68.51.140    <none>        5556/TCP,5557/TCP,5558/TCP   5m11sargocd-metrics          ClusterIP   10.68.76.255    <none>        8082/TCP                     5m11sargocd-redis            ClusterIP   10.68.223.131   <none>        6379/TCP                     5m11sargocd-repo-server      ClusterIP   10.68.1.35      <none>        8081/TCP,8084/TCP            5m11sargocd-server           NodePort    10.68.49.24     <none>        80:30582/TCP,443:32313/TCP   5m11sargocd-server-metrics   ClusterIP   10.68.107.188   <none>        8083/TCP                     5m10s

复制代码

浏览器输入 https://<节点 IP>:32313 访问 Argo CD。

3.5 获取 Argo CD 密码

默认情况下 admin 帐号的初始密码是自动生成的，会以明文的形式存储在 Argo CD 安装的命名空间中名为 argocd-initial-admin-secret 的 Secret 对象下的 password 字段下，我们可以用下面的命令来获取：

kubectl -n argocd get secret \argocd-initial-admin-secret \-o jsonpath="{.data.password}" | base64 -d
# 返回结果kj8bDMiDTnsEfnjg

复制代码

在浏览器输入密码登录 Argo CD。

登录后的界面如下所示。

命令行可以使用以下方式登录。

❯ argocd login <节点 IP>:32313# 接收证书风险WARNING: server certificate had error: x509: cannot validate certificate for 11.8.38.43 because it doesn't contain any IP SANs. Proceed insecurely (y/n)? yUsername:  # 输入用户名Password: # 输入密码'admin:login' logged in successfully

复制代码

3.6 准备 Git 仓库

在 Gitlab 上创建项目，取名为 argocd-lab，为了方便实验将仓库设置为 public 公共仓库。在仓库中创建 quickstart 目录，在目录中创建两个 yaml 资源文件，分别是 myapp-deployment.yaml 和 myapp-service.yaml。

yaml 资源文件内容如下：

# myapp-deployment.yamlapiVersion: apps/v1kind: Deploymentmetadata:  name: myappspec:  replicas: 1  selector:    matchLabels:      app: myapp  template:    metadata:      labels:        app: myapp    spec:      containers:      - image: registry.cn-shanghai.aliyuncs.com/public-namespace/myapp:v1        name: myapp        ports:        - containerPort: 80 # myapp-service.yamlapiVersion: v1kind: Servicemetadata:  name: myappspec:  ports:  - port: 80    targetPort: 80    nodePort: 32060  type: NodePort  selector:    app: myapp

复制代码

实验所需的镜像我已经在阿里云的镜像仓库中准备好了，大家可以直接使用。

3.7 创建 Argo CD App

首先创建一个命名空间 devops 用于 Argo CD 部署应用。

kubectl create ns devops

复制代码

3.7.1 方式一：使用 UI 创建 App

Application Name: 自定义的应用名。
Project: 使用默认创建好的 default 项目。
SYNC POLICY：同步方式，可以选择自动或者手动，这里我们选择手动同步。

Repository URL: 项目的 Git 地址。
Revision: 分支名。
Path: yaml 资源文件所在的相对路径。

Cluster URL: Kubernetes API Server 的访问地址，由于 Argo CD 和下发应用的 Kubernetes 集群是同一个，因此可以直接使用 http://kubernetes.default.svc 来访问。关于 Kubernetes 中 DNS 解析规则可以查看 Pod 与 Service 的 DNS。
Namespace: 部署应用的命名空间。

创建完成后如下图所示，此时处于 OutOfSync 的状态：

由于我设置的是手动同步，因此需要点一下下面的 SYNC 进行同步。

在弹出框点击 SYNCHRONIZE，确认同步。

等待同步完成。

在 Argo CD 上点击应用进入查看详情。

在 Kubernetes 查看部署的资源。

root@cluster01-1:/root #kubectl get all -n devops NAME                         READY   STATUS    RESTARTS   AGEpod/myapp-865f9f464f-qpjbc   1/1     Running   0          2m25s
NAME            TYPE       CLUSTER-IP   EXTERNAL-IP   PORT(S)        AGEservice/myapp   NodePort   10.68.93.5   <none>        80:32060/TCP   2m25s
NAME                    READY   UP-TO-DATE   AVAILABLE   AGEdeployment.apps/myapp   1/1     1            1           2m25s
NAME                               DESIRED   CURRENT   READY   AGEreplicaset.apps/myapp-865f9f464f   1         1         1       2m25s

复制代码

在集群外部通过 <节点 IP>:<NodePort> 端口访问 myapp 程序，可以看到此时是 v1 版本。

3.7.2 方式二：使用 CLI 创建 APP

argocd app create myapp2 \--repo http://11.8.36.29/root/argocd-lab.git \--path quickstart --dest-server \https://kubernetes.default.svc \--dest-namespace devops

复制代码

使用 argocd 命令查看创建的应用。

# 列出应用❯ argocd app listNAME   CLUSTER                         NAMESPACE  PROJECT  STATUS  HEALTH   SYNCPOLICY  CONDITIONS  REPO                                   PATH        TARGETmyapp  https://kubernetes.default.svc  devops     default  Synced  Healthy  <none>      <none>      http://11.8.36.29/root/argocd-lab.git  quickstart  main
# 查看 myapp 应用❯ argocd app get myappName:               myappProject:            defaultServer:             https://kubernetes.default.svcNamespace:          devopsURL:                https://11.8.36.159:32313/applications/myappRepo:               http://11.8.36.29/root/argocd-lab.gitTarget:             mainPath:               quickstartSyncWindow:         Sync AllowedSync Policy:        <none>Sync Status:        Synced to main (82baed1)Health Status:      Healthy
GROUP  KIND        NAMESPACE  NAME   STATUS  HEALTH   HOOK  MESSAGE       Service     devops     myapp  Synced  Healthy        service/myapp createdapps   Deployment  devops     myapp  Synced  Healthy        deployment.apps/myapp created

复制代码

3.7.3 方式三：使用 YAML 文件创建

apiVersion: argoproj.io/v1alpha1kind: Applicationmetadata:  name: myapp  namespace: argocdspec:  destination:    namespace: devops # 部署应用的命名空间    server: https://kubernetes.default.svc # API Server 地址  project: default # 项目名  source:    path: quickstart # 资源文件路径    repoURL: http://11.8.36.29/root/argocd-lab.git # Git 仓库地址    targetRevision: main # 分支名