文章目录
Argo CD钩子
Argo CD 是一个用于部署和管理 Kubernetes 应用程序的工具,它提供了一种声明式的方式来定义和自动化应用程序的部署过程。Argo CD 钩子(Hooks)是一种机制,允许在部署过程中执行自定义的操作。
Argo CD 钩子可以在以下几个阶段执行:
- PreSync 钩子:在同步操作之前执行。可以用于在同步应用程序之前执行一些准备工作,例如创建必要的资源或检查先决条件。(可以在部署应用前,执行数据库迁移或初始化)
- Sync 钩子:在同步操作期间执行。可以用于在同步应用程序期间执行一些操作,例如修改配置、应用变换或执行其他自定义逻辑。
- PostSync 钩子:在同步操作之后执行。可以用于在同步应用程序之后执行一些清理工作或触发其他操作。(集成监控和健康检查等)
- SyncFaild钩子:在同步失败后执行,可以数据清理、逻辑终结、应用回滚等操作
如何定义钩子
参考https://github.com/ppsite/argocd-in-action
argocd.argoproj.io/hook: PreSync定义钩子执行阶段,多个阶段用","逗号分隔
yaml
apiVersion: batch/v1
kind: Job
metadata:
name: app-wxwork
annotations:
# 指定钩子阶段
argocd.argoproj.io/hook: PostSync
# 钩子删除策略
argocd.argoproj.io/hook-delete-policy: HookSucceeded
spec:
template:
spec:
containers:
- name: wxwork-notification
image: curlimages/curl
# 下述钩子通知企业微信发布完成
command:
- "curl"
- "--request"
- "POST"
- "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=b291a492-62be-406a-9b65-13cd2061045b"
- "--header"
- "'Content-Type: application/json'"
- "--data-raw"
- "{\"msgtype\": \"text\",\"text\": {\"content\": \"hello world\"}}"
restartPolicy: Never
backoffLimit: 1
钩子删除策略
在 Argo CD 中,可以使用钩子(hook)来在应用程序部署的不同阶段执行自定义操作。钩子可以用于在部署之前或之后运行脚本、命令或其他操作。当应用程序被删除时,也可以使用钩子来执行清理操作。删除钩子的策略可以通过 Argo CD 应用程序的配置进行设置。
Argo CD 提供了以下几种钩子删除策略选项:
- BeforeHookCreation: 在创建钩子之前删除旧的钩子。这是默认的删除策略,它会在创建新钩子之前删除先前的钩子。
- HookSucceeded: 仅当钩子成功执行后才删除旧的钩子。这种策略适用于需要确保钩子成功执行后再删除旧钩子的情况。
- HookFailed: 仅当钩子执行失败后才删除旧的钩子。这种策略适用于需要在钩子执行失败时保留旧钩子的情况。
- HookSucceededOrFailed: 无论钩子成功还是失败,都删除旧的钩子。这种策略适用于无论钩子执行结果如何,都希望删除旧钩子的情况。
钩子删除策略可以在 Argo CD 应用程序的配置文件(例如 YAML 文件)中设置。例如,以下是一个应用程序配置文件的示例,其中设置了钩子删除策略为 HookSucceeded:
yaml
apiVersion: batch/v1
kind: Job
metadata:
name: app-wxwork
annotations:
# 指定钩子阶段
argocd.argoproj.io/hook: PostSync
# 钩子删除策略
argocd.argoproj.io/hook-delete-policy: HookSucceeded