【GitOps系列】使用 ArgoCD 快速打造GitOps工作流

news2024/9/25 13:19:40

文章目录

      • ArgoCD简介
      • ArgoCD安装
      • 访问ArgoCD
      • GitOps 工作流总览
        • 创建 ArgoCD 应用
        • 检查 ArgoCD 同步状态
        • 访问应用
      • 连接 GitOps 工作流
      • 体验 GitOps 工作流
      • 生产建议
        • 1)修改默认密码
        • 2)配置 Ingress 和 TLS
        • 3)使用 Webhook 触发 ArgoCD
        • 4)将源码仓库和应用定义仓库分离
        • 5)加密 GitOps 中存储的秘钥

ArgoCD简介

官网:https://argo-cd.readthedocs.io/en/stable/

ArgoCD安装

$ kubectl create namespace argocd

$ kubectl apply -n argocd -f https://ghproxy.com/https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml

~# kubectl wait --for=condition=Ready pods --all -n argocd --timeout 300s
pod/argocd-application-controller-0 condition met
pod/argocd-applicationset-controller-6dd887f766-gv2gk condition met
pod/argocd-dex-server-89774cfc6-v2dhc condition met
pod/argocd-notifications-controller-79c985586c-xkt7q condition met
pod/argocd-redis-74f98b85f-dvhjc condition met
pod/argocd-repo-server-9cb997c7b-vjzrn condition met
pod/argocd-server-749879d78d-hcc6v condition met

访问ArgoCD

可以通过ingress或者nodeport方式进行访问
user:admin
passwd:

$ kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d

GitOps 工作流总览

在这里插入图片描述
我们可以把这个完整的 GitOps 工作流分成三个部分来看。
第一部分:开发者推送代码到 GitHub 仓库,然后触发 GitHub Action 自动构建。
第二部分:GitHub Action 自动构建,它包括下面三个步骤:

  1. 构建示例应用的镜像。
  2. 将示例应用的镜像推送到 Docker Registry 镜像仓库。
  3. 更新代码仓库中 Helm Chart values.yaml 文件的镜像版本。

第三部分:核心是 ArgoCD,它包括下面两个步骤:

  1. 通过定期 Poll 的方式持续拉取 Git 仓库,并判断是否有新的 commit。
  2. 从 Git 仓库获取 Kubernetes 对象,与集群对象进行实时比较,自动更新集群内有差异的资源。

前边的环境已经准备好,现在准备创建 GitOps 工作流中的第三部分,也就是创建 ArgoCD 应用,实现 Kubernetes 资源的自动同步。

创建 ArgoCD 应用

以示例应用为例子来创建 ArgoCD 应用,这里主要分成两个步骤。

  1. 配置仓库访问权限。
  2. 创建 ArgoCD 应用。

其中,如果你的示例应用仓库是公开的,可以跳过第一步。
配置 ArgoCD 仓库访问权限(可选)

$ argocd login 127.0.0.1:8080 --insecure
Username: admin
Password:
'admin:login' logged in successfully

添加示例应用仓库:

~# argocd repo add https://github.com/xxxx/kubernetes-example.git --username $USERNAME  --password $PASSWORD

将 $USERNAME 替换为 GitHub 账户 ID,将 $PASSWORD 替换为 GitHub Personal Token,密码创建链接:https://github.com/settings/tokens/new

创建 ArgoCD 应用
ArgoCD 同时支持使用 Helm Chart、Kustomize 和 Manifest 来创建应用,以示例应用的 Helm Chart 为例。
通过argocd app create命令来创建应用

$ argocd app create example --sync-policy automated --repo https://github.com/xxxx/kubernetes-example.git --revision main --path helm --dest-namespace gitops-example --dest-server https://kubernetes.default.svc --sync-option CreateNamespace=true
application 'example' created

–sync-policy 参数代表设置自动同步策略。automated 的含义是自动同步,也就是说当集群内的资源和 Git 仓库 Helm Chart 定义的资源有差异时,ArgoCD 会自动执行同步操作,实时确保集群资源和 Helm Chart 的一致性。
–repo 参数表示 Helm Chart 的仓库地址。这里的值是示例应用的仓库地址,注意需要替换成你实际的 Git 仓库地址。
–revision 参数表示需要跟踪的分支或者 Tag,这里我们让 ArgoCD 跟踪 main 分支的改动。
–path 参数表示 Helm Chart 的路径。在示例应用中,存放 Helm Chart 的目录是 helm 目录。
–dest-namespace 参数表示命名空间。这里指定了 gitops-example 命名空间,注意,这是一个不存在的命名空间,所以我们额外通过--sync-option参数来让 ArgoCD 自动创建这个命名空间。
最后,–dest-server 参数表示要部署的集群, https://kubernetes.default.svc 表示 ArgoCD 所在的集群。

检查 ArgoCD 同步状态

在这里插入图片描述
在应用详情页面,需要重点关注三个状态。

  1. APP HEALTH: 应用整体的健康状态,它包含下面三个值。
    1. Progressing:处理中
    2. Healthy:健康状态
    3. Degraded:宕机
  2. CURRENT SYNC STATUS: 应用定义和集群对象的差异状态,也包含下面三个值。
    1. Synced:完全同步
    2. OutOfSync:存在差异
    3. Unknown:未知
  3. LAST SYNC RESULT: 最后一次同步到 Git 仓库的信息,包括 Commit ID 和提交者信息。

访问应用

当应用健康状态变为 Healthy 之后,我们就可以访问应用了。

连接 GitOps 工作流

在完成 ArgoCD 的应用配置之后,我们就已经将示例应用的 Helm Chart 定义和集群资源关联起来了,但整个 GitOps 工作流还缺少非常重要的一部分,就是上面提到的自动更新 Helm Chart values.yaml 文件镜像版本的部分,在下面这张示意图中用“❌”把这个环节标记了出来。
在这里插入图片描述
在这部分工作流没有打通之前,提交的新代码虽然会构建出新的镜像,但是 Helm Chart 定义的镜像版本并不会产生变化, 这会导致 ArgoCD 不能自动更新集群内工作负载的镜像版本。
要解决这个问题,我们还需要在 GitHub Action 中添加自动修改 Helm Chart 并重新推送到仓库操作。
接下来,我们修改示例应用的.github/workflows/build.yaml文件,在“Build frontend and push”阶段后面添加一个新的阶段,代码如下:

- name: Update helm values.yaml
  uses: fjogeleit/yaml-update-action@main
  with:
    valueFile: 'helm/values.yaml'
    commitChange: true
    branch: main
    message: 'Update Image Version to ${{ steps.vars.outputs.sha_short }}'
    changes: |
      {
        "backend.tag": "${{ steps.vars.outputs.sha_short }}",
        "frontend.tag": "${{ steps.vars.outputs.sha_short }}"
      }

使用了 GitHub Action 中yaml-update-action插件来修改 values.yaml 文件并把它推送到仓库。如果你是使用 GitLab 或者 Tekton 构建镜像,可以调用 jq 命令行工具来修改 YAML 文件,再使用 git 命令行将变更推送到仓库。
到这里, 一个完整的 GitOps 工作流就建立好了。

体验 GitOps 工作流

尝试修改 frontend/src/App.js 文件,例如修改文件第 49 行的“Hi! I am a geekbang”。修改完成后, 将代码推送到 GitHub 仓库 main 分支,此时,GitHub Action 会自动构建镜像,并且还会更新代码仓库中 Helm values.yaml 文件的镜像版本。

ArgoCD 默认每 3 分钟会拉取仓库检查是否有新的提交,你也可以在 ArgoCD 控制台手动点击 Sync 按钮来触发同步。
在这里插入图片描述
ArgoCD 同步完成后,我们可以在“LAST SYNC RESULT”一栏中看到 GitHub Action 修改 values.yaml 的提交记录,当应用状态为 Healthy 时,我们就可以访问新的应用版本了。

生产建议

1)修改默认密码

注:
修改密码前,先使用 argocd login 登录到 ArgoCD 服务端。
$ argocd account update-password
*** Enter password of currently logged in user (admin):
*** Enter new password for user admin:

2)配置 Ingress 和 TLS

前提:
需要安装 Cert-manager!!!
> ingress.yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: argocd-server-ingress
  namespace: argocd
  annotations:
    cert-manager.io/cluster-issuer: letsencrypt-prod
    kubernetes.io/ingress.class: nginx
    kubernetes.io/tls-acme: "true"
    nginx.ingress.kubernetes.io/ssl-passthrough: "true"
    nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
spec:
  rules:
  - host: argocd.example.com
    http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: argocd-server
            port:
              name: https
  tls:
  - hosts:
    - argocd.example.com
    secretName: argocd-secret # do not change, this is provided by Argo CD

3)使用 Webhook 触发 ArgoCD

我们在创建应用的时候提供了参数 --sync-policy=automated。这时候,ArgoCD 会默认以 3 分钟一次的频率来自动拉取仓库的更改,在生产环境下,这个同步频率可能并不能满足快速发布的要求。
如果 ArgoCD 可以在公网进行访问,建议使用 ArgoCD 提供的 Webhook 触发方式来解决这个问题了,如下图所示:
在这里插入图片描述
和主动 Poll 模型不同的是,源码仓库在收到开发者推送代码的事件后,将实时通过 HTTP 请求来通知 ArgoCD,也就是图中红色字体的部分。
要使用 Webhook 通知的方式,首先你需要在源码仓库进行配置。以 GitHub 为例,首先进入仓库的“Settings”页面,点击左侧的“Webhook”菜单进入配置页面,如下图:
在这里插入图片描述
在 Payload URL 中输入你的 ArgoCD Server 外网访问域名,/api/webhook ArgoCD 专门用于接收外部 Webhook 消息的固定路径。
Content type 选择 application/json,并在 Secret 中输入你要配置的 Webhook 的密钥,这个密钥需要提供给 ArgoCD 来校验 Webhook 来源是否合法?
接下来,你还需要为 ArgoCD 提供 GitHub Webhook 密钥,使用下面的命令来编辑 argocd-secret 对象。

$ kubectl edit secret argocd-secret -n argocd
apiVersion: v1
kind: Secret
metadata:
  name: argocd-secret
  namespace: argocd
type: Opaque
data:
...
stringData:
  # 加入这一项
  webhook.github.secret: my-secret

注意,stringData 可以直接输入 Webhook Secret 内容而不需要进行 Base64 编码。
如果你使用的是其他的代码托管平台,例如 GitLab,可以参考 https://argo-cd.readthedocs.io/en/stable/operator-manual/webhook/进行配置。

4)将源码仓库和应用定义仓库分离

本次实践将示例应用的源码和 Helm Chart 存储在了同一个 Git 仓库,实际上, 这并不是一个好的实践。
这种方案有两个比较大的问题。首先,当我们手动修改 Helm Chart 并推送到 Git 仓库之后,在业务代码不变的情况下也会触发应用镜像构建,这个过程是没有必要的。
其次,在有一定规模的团队中,开发和发布过程是分开的,应用定义仓库一般只有基础架构部门或者 SRE 部门具有修改权限,将源码和应用定义放在同一个 Git 仓库不利于权限控制,开发者也很容易误操作。
所以,基于上面这两个问题,强烈建议将业务代码和应用定义分开存储管理。

5)加密 GitOps 中存储的秘钥

本次实践使用的是 DockerHub 公开仓库,所以 Kubernetes 集群不需要镜像拉取凭据就可以拉取到镜像。
在实际生产环境下,一般我们会使用内部自建例如 Harbor 私有仓库。所以在大部分情况下,我们会在 Helm Chart 里增加一个包含镜像拉取凭据的 Secret 对象。

apiVersion: v1
kind: Secret
metadata:
  name: regcred
type: kubernetes.io/dockerconfigjson
data:
  .dockerconfigjson: >-
    eyJhdXRocyI6eyJodHRwczovL2luZGV4LmRvY2tlcxxxxS8iOnsidXNlcm5hbWUiOiJseXpoYW5nMTk5OSIsInBhc3N3b3JkIjoibXktdG9rZW4iLCJhdXRoIjoiYkhsNmFHRnVaekU1T1RrNmJYa3RkRzlyWlc0PSJ9fX0=

当 ArgoCD 部署应用时,会一并将拉取凭据部署到集群中,这就解决了镜像拉取权限的问题。
但是,Secret 对象并没有加密功能, 这可能会导致凭据泄露。 所以,我们需要对这些敏感信息进行加密处理。关于如何加密秘钥,是一个遗留项!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/797997.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【C++】开源:Boost网络库Asio配置使用

😏★,:.☆( ̄▽ ̄)/$:.★ 😏 这篇文章主要介绍Asio网络库配置使用。 无专精则不能成,无涉猎则不能通。——梁启超 欢迎来到我的博客,一起学习,共同进步。 喜欢的朋友可以关注一下,下次…

手机怎么把网址转二维码?网址活码手机端制作教学

相信很多小伙伴都知道电脑生成网址二维码方法,只需要利用二维码生成器(二维码生成器-手机二维码制作生成器-免费在线生成二维码-机智熊二维码)的网址生成二维码功能,就可以轻松将网址生成二维码。那么大家知道在手机上怎么操作吗&…

兴达易控CANopn 主站转 profinet 网关的网关配置及操作

兴达易控CANopn 主站转 profinet 网关(XD-COPNm20)做为 PROFINET 网络的 Device 设备(即从站),带 2 个 RJ45 以太网接口,支持100BASE-TX,MDI/MDIX 自检测,集成以太网交换机&#xff…

Jenkins 拉取 GitHub 私有仓库失败问题

添加仓库的时候提示 stderr: fatal: Cannot prompt because user interactivity has been disabled. 把在 GitHub账户设置中生成的个人访问令牌填到地址里

使用docker搭建nacos

使用docker搭建nacos docker搭建最新版nacosMySQL下简历nacos配置数据表拉取镜像创建挂载目录启动容器访问nacos docker搭建nacos 2.0版本 docker搭建最新版nacos 最近想在自己服务器上搭建一个nacos服务,以前一直在本地的windows上使用,而且使用着naco…

Rabbitmq的安装与使用(Linux版)

目录 Rabbitmq安装 1.在Ubuntu上安装RabbitMQ: 打开终端,运行以下命令以更新软件包列表: 安装RabbitMQ: 安装完成后,RabbitMQ服务会自动启动。你可以使用以下命令来检查RabbitMQ服务状态: 2.在CentOS…

湖南大学师生一行到访麒麟信安参观交流

7月6日下午,湖南大学信息科学与工程学院师生一行百余人到访麒麟信安参观交流。 在公司展厅,同学们详细了解了麒麟信安的发展历程、产业布局、生态圈建设等方面情况,观摩麒麟信安在国产操作系统等领域的各项研发成果,并参观了麒麟…

【数据结构】二叉树前中后层序遍历代码实现以及各种操作与二叉树OJ题目

目录 一、二叉树的遍历 1、前序遍历 2、后续遍历 3、中序遍历 二、二叉树简单的操作 1、计算节点个数 1.二叉树所有节点个数 2.二叉树叶子节点个数 3.二叉树第K层节点个数 2、二叉树的高度 3、二叉树是否存在key 1.二叉树中是否存在key 2.寻找二叉树中key节点 三、…

这些你值得拥有的音频转文字软件推荐给你

小明是一个音乐爱好者,他热爱听歌。然而,有一天,他突然失去了听力,这令他感到沮丧和无助,他再也无法知晓音乐的内容了。正当小明陷入困境时,他听说了一个神奇的技术——音频转文字。这项技术据说可以将音频…

Leetcode周赛 | 2023-7-24

2023-7-24 题1体会我的代码 题2这道题是一点都不会重点我的代码 题3重点我的代码 题二题三都不会621. 任务调度器思路 题1 体会 想到倒序遍历就可以。 我的代码 class Solution:def maxArrayValue(self, nums: List[int]) -> int:n len(nums)i n-1while i > 0 :if n…

CSS背景虚化

.mark{background-color: rgba(0,0,0,.1);-webkit-backdrop-filter: blur(3px);backdrop-filter: blur(3px); }backdrop-filter CSS 属性可以让你为一个元素后面区域添加图形效果(如模糊或颜色偏移)。 因为它适用于元素背后的所有元素,为了看…

MYSQL 高级SQL语句(二)

目录 一、表连接查询 1.1 left join(左连接) 1.2 right join(右连接) 1.3 inner join(内连接) 二、视图 2.1 视图表与派生表比较 一、表连接查询 MYSQL数据库中的三种连接: inner join(内…

pytorch分类和回归:阿里天池宠物年龄预测

文章目录 dog年龄预测论文Deep expectation of real and apparent age from a single image without facial landmarks分类的损失函数1.多分类交叉熵损失函数:2.KLDiv Loss: 分布差异3.facenet 三元组损失函数 timm and torchvisiontorchvision 尝试一&a…

刚创业,租什么类型办公场地比较合适

对于刚创业的公司,选择哪种类型的办公场地取决于公司的规模、预算和业务需求。以下是一些选择办公场地的考虑因素: 1. 灵活性:初创企业可能需要随着业务的发展和变化而快速调整办公空间。因此,选择一个灵活的办公场地&#xff0c…

深入学习 Redis - 深挖经典数据类型之 zset

目录 前言 一、zset 类型 1.1、操作命令 zadd / zrange(添加 / 查询) zcard(个数) zcount(区间元素个数) zrevrange(逆序展示) zrangebyscore(按分数找元素&#…

服务器(容器)开发指南——SSH打洞开发

文章目录 SSH容器服务打包测试服务文件镜像打包 SSH打洞开发部署带SSH的容器SSH连接服务器(容器内部)SSH访问容器内的缺陷 IDE远程SSH开发VSCode远程SSH开发Jetbrains系列产品SSH远程开发 在进行定制化的服务开发时,我们有时候只能在固定的服…

页面设计—GridRow栅格行组件

1、何时使用 在栅格布局基础上,一般需要通过行(GridRow)和列(GridCol)来定义信息区块的外部框架,以保证页面的每个区域能够稳健地排布起来。 2、如何使用 (1)找到GridRow组件&…

乙酰基四肽-2--------增加肌肤紧实度,重建表皮结构

简介 为了避免皮肤下垂和松弛,以下几种重要蛋白共同参与,维持皮肤结构的粘着和紧致:Fibulin 5亦称FBLN-5,是细胞外基质蛋白Fibulin家族中的最新成员。它广泛分布于富含弹性纤维的组织,能直接与原弹性蛋白结合&#xf…

【矩特征】图像矩特征

every blog every motto: You can do more than you think. https://blog.csdn.net/weixin_39190382?typeblog 0. 前言 cv2.moments() 矩特征 1. 正文 (1). 空间矩 零阶矩:m00一阶矩:m10,m01二阶矩:m20,m11,m02三阶矩:m30,m…

配置Tomcat远程调试

配置Tomcat远程调试 1.Tomcat开启远程访问调试1.1 编写脚本,开启配置1.2 重启Tomcat服务 2. IDEA配置远程调试Tomcat2.1 IDEA右上角更改配置2.2 添加一个remote jvm debug2.3 进行配置2.4 配置后进行启动连接至此在本地打断点即可调试远程服务器 1.Tomcat开启远程访问调试 1.1…