marcb1/argocd-bot

Argocd Bot

一个帮助通过GitHub PR自动化https://github.com/argoproj/argo-cd%E5%8F%98%E6%9B%B4%E7%9A%84%E6%9C%BA%E5%99%A8%E4%BA%BA%E3%80%82%E7%9B%AE%E5%89%8D%E6%94%AF%E6%8C%81%E5%9C%A8%E5%BC%80%E6%94%BE%E7%9A%84Pull Request上运行diff检查，可查看工作流部分了解更多，或在开放PR上评论argo help获取帮助。

核心功能

简化部署/减少错误

• 在开放PR上评论argo diff，查看本地分支与Kubernetes集群之间的差异。
• PR差异可被团队所有人轻松审查。
• 在应用变更前捕获argo diff输出中的错误。
• 评论argo sync [应用名称]以部署变更并合并PR。

锁定部署

• 用户无需集群凭证，可通过GitHub提交变更（需PR审批）。
• 通过GitHub PR/服务器日志审计集群变更。

使用场景

适用于团队协作管理Kubernetes部署的场景：用户在Kubernetes仓库提交部署文件变更的PR后，通过Bot的命令进行差异检查、同步部署等操作，确保部署流程规范且可审计。

配置说明

创建GitHub App

在https://github.com/settings/apps/new%E5%88%9B%E5%BB%BA%E6%96%B0%E7%9A%84GitHub App：

• Webhook URL：Bot运行的主机地址。
• Webhook Secret：可选密钥，需与配置一致。
• 私钥：生成新密钥并放置在根目录，更新下方配置。
• 记录GitHub生成的APP_ID。 更多创建GitHub App的信息见https://probot.github.io/docs/development/#manually-configuring-a-github-app%E3%80%82

GitHub App所需权限

为Argo CD App授予以下权限：

读取管理和元数据权限
读写提交状态、问题和拉取请求权限

更新配置

将.env_example文件重命名为.env，NodeJS运行时会读取该文件并向Bot暴露变量。在Kubernetes中，可使用辅助脚本从该文件创建k8s密钥。参数说明：

• PORT：Bot监听的HTTP端口。
• LOG_LEVEL：可设置为trace、debug、info、warn、error或fatal。
• KUBECTL_EXTERNAL_DIFF：用于argocd diff的辅助脚本，美化PR上的差异输出。
• APP_ID：GitHub App对应的应用ID（创建时生成）。
• GHE_HOST：GitHub企业版安装的主机名（否则留空，使用GitHub.com）。
• GITHUB_REPO：Bot操作的仓库。
• GITHUB_TOKEN：为Bot生成的GitHub令牌（无需权限），用于克隆仓库。
• WEBHOOK_SECRET：创建GitHub App时配置的密钥（无则留空）。
• PRIVATE_KEY_PATH：GitHub App生成的私钥路径（通常为.pem文件）。
• ARGOCD_SERVER：ArgoCD服务器的IP地址/主机名。
• ARGOCD_AUTH_TOKEN：推荐使用/api/v1/projects/{project}/roles/{role}/token API生成自动化令牌，详情见https://github.com/argoproj/argo-cd/blob/master/docs/security.md#authentication%E3%80%82

部署示例

Docker运行

bash
docker run -d \
  -p 3000:3000 \
  -v /path/to/your/private-key.pem:/app/private-key.pem \
  -v /path/to/your/.env:/app/.env \
  marcb1/argocd-bot

Kubernetes部署

1. 确保.env文件已填充正确值，运行辅助脚本创建k8s密钥：

bash
./helper_scripts/create_kubectl_secrets.sh

该脚本生成名为argocd-bot-secret的k8s密钥。

2. 使用kustomize构建清单：

bash
npm run manifests

3. 从清单创建部署：

bash
kubectl create -f deployment/install.yaml

手动部署

详见文档。

开发/贡献

详见文档