entigolabs/entigo-k8s-gitops

GitOps工具

这是一个GitOps辅助CLI工具，用于简化Kubernetes部署变更和ArgoCD应用管理。

• 源码编译
• 使用方法
• 示例
• ArgoCD命令
  • argocd-get
  • argocd-sync
  • argocd-update
  • argocd-delete

源码编译

bash
go build -o bin/gitops cmd/gitops/main.go

使用方法

该GitOps工具支持7个命令：

• run - 执行更新和复制逻辑
• update - 更新指定镜像
• copy - 从master分支复制到指定分支
• argocd-get - 获取ArgoCD应用的JSON输出
• argocd-sync - 同步ArgoCD应用
• argocd-update - 更新ArgoCD应用（结合argocd-get、Git更新和argocd-sync）
• argocd-delete - 删除ArgoCD应用

示例

Update命令示例

带应用路径参数的示例

bash
./gitops update \
    --git-repo=<repository-ssh-url> \
    --git-branch=<repository-branch> \
    --git-key-file=<key-file-location> \
    --images=<image:tag,image2:tag> \ 
    --app-path=<app-path>

带 tokenized 路径参数的示例

Tokenized路径参数：

1. --app-prefix=<app-prefix>
2. --app-namespace=<app-namespace>
3. --app-name=<app-name>

bash
./gitops update \
    --git-repo=<repository-ssh-url> \
    --git-branch=<repository-branch> \
    --git-key-file=<key-file-location> \
    --images=<image:tag,image2:tag> \ 
    --app-prefix=<app-prefix> \
    --app-namespace=<app-namespace> \
    --app-name=<app-name>

注意：若--app-path参数设置为非默认值，将覆盖tokenized路径参数

ArgoCD命令

argocd-get

获取ArgoCD应用的JSON输出到标准输出。

选项：

• app-name - 必填，ArgoCD应用名称 [$APP_NAME]
• server - 必填，服务器TCP地址（含端口） [$ARGO_CD_SERVER]
• auth-token - 必填，认证令牌 [$ARGO_CD_TOKEN]
• insecure - 不安全连接（默认：false） [$ARGO_CD_INSECURE]
• timeout - 单个ArgoCD操作超时时间（默认：300） [$ARGO_CD_TIMEOUT]
• grpc-web - 启用gRPC-web协议（适用于ArgoCD服务器在不支持HTTP2的代理后）（默认：false） [$ARGO_CD_GRPC_WEB]

最小示例：

bash
./gitops argocd-get --app-name='application-name' --server='localhost:443' --auth-token='auth-token'

完整示例：

bash
./gitops argocd-get --app-name='application-name' --server='localhost:443' --auth-token='auth-token' --timeout=300 --insecure=false --grpc-web=false

argocd-sync

同步ArgoCD应用并等待其达到同步且健康状态。

选项：

• app-name - 必填，ArgoCD应用名称 [$APP_NAME]
• server - 必填，服务器TCP地址（含端口） [$ARGO_CD_SERVER]
• auth-token - 必填，认证令牌 [$ARGO_CD_TOKEN]
• insecure - 不安全连接（默认：false） [$ARGO_CD_INSECURE]
• timeout - 单个ArgoCD操作超时时间（默认：300） [$ARGO_CD_TIMEOUT]
• grpc-web - 启用gRPC-web协议（适用于ArgoCD服务器在不支持HTTP2的代理后）（默认：false） [$ARGO_CD_GRPC_WEB]
• async - 不等待同步完成（默认：false） [$ARGO_CD_ASYNC]
• wait-failure - 同步超时则命令失败（默认：true） [$ARGO_CD_WAIT_FAILURE]

最小示例：

bash
./gitops argocd-sync --app-name='application-name' --server='localhost:443' --auth-token='auth-token'

完整示例：

bash
./gitops argocd-sync --app-name='application-name' --server='localhost:443' --auth-token='auth-token' --timeout=300 --insecure=false --grpc-web=false --async=false --wait-failure=true

argocd-update

更新ArgoCD应用，结合argocd-get、Git更新和argocd-sync命令。

选项：

• app-name - 必填，ArgoCD应用名称 [$APP_NAME]
• server - 必填，服务器TCP地址（含端口） [$ARGO_CD_SERVER]
• auth-token - 必填，认证令牌 [$ARGO_CD_TOKEN]
• git-key-file - 必填，SSH私钥路径 [$GIT_KEY_FILE]
• images [-i] - 必填，带标签的镜像列表（逗号分隔） [$IMAGES]
• insecure - 不安全连接（默认：false） [$ARGO_CD_INSECURE]
• timeout - 单个ArgoCD操作超时时间（默认：300） [$ARGO_CD_TIMEOUT]
• grpc-web - 启用gRPC-web协议（适用于ArgoCD服务器在不支持HTTP2的代理后）（默认：false） [$ARGO_CD_GRPC_WEB]
• git-strict-host-key-checking - 严格主机密钥检查（默认：false） [$GIT_STRICT_HOST_KEY_CHECKING]
• git-push - 推送变更（默认：true） [$GIT_PUSH]
• git-author-name value - Git作者名称（默认：jenkins） [$GIT_AUTHOR_NAME]
• git-author-email value - Git作者***（默认：jenkins@localhost） [$GIT_AUTHOR_EMAIL]
• keep-registry [-k] - 保留镜像的 registry 部分（默认：false） [$KEEP_REGISTRY]
• deployment-strategy [-s] - 变更部署策略（RollingUpdate | Recreate）（默认：不定义则保持不变） [$DEPLOYMENT-STRATEGY]
• recursive - 递归更新目录及其内容（默认：false） [$RECURSIVE]
• async - 不等待ArgoCD同步完成（默认：false） [$ARGO_CD_ASYNC]
• wait-failure - 同步超时则命令失败（默认：true） [$ARGO_CD_WAIT_FAILURE]

最小示例：

bash
./gitops argocd-update --app-name='application-name' --server='localhost:443' --auth-token='auth-token' --git-key-file='file' --images='image:1'

argocd-delete

删除ArgoCD应用。

选项：

• app-name - 必填，ArgoCD应用名称 [$APP_NAME]
• server - 必填，服务器TCP地址（含端口） [$ARGO_CD_SERVER]
• auth-token - 必填，认证令牌 [$ARGO_CD_TOKEN]
• insecure - 不安全连接（默认：false） [$ARGO_CD_INSECURE]
• timeout - 单个ArgoCD操作超时时间（默认：300） [$ARGO_CD_TIMEOUT]
• grpc-web - 启用gRPC-web协议（适用于ArgoCD服务器在不支持HTTP2的代理后）（默认：false） [$ARGO_CD_GRPC_WEB]
• cascade - 级联删除所有应用资源（默认：true） [$ARGO_CD_CASCADE]

最小示例：

bash
./gitops argocd-delete --app-name='application-name' --server='localhost:443' --auth-token='auth-token'

完整示例：

bash
./gitops argocd-delete --app-name='application-name' --server='localhost:443' --auth-token='auth-token' --timeout=300 --insecure=false --grpc-web=false --cascade=true