karolisr/keel

Keel - Kubernetes部署自动化工具

概述

Keel 是一款用于自动化 Kubernetes 部署更新的工具，具有无状态、健壮和轻量级的特点。它无需命令行界面（CLI）或 API，通过标签、注解和 Helm 图表即可实现部署更新管理，支持多种容器 registry 触发器和通知方式，为 Kubernetes 环境提供灵活高效的持续部署能力。

官网：[]
Slack 社区：kubernetes.（频道 #keel）

核心功能

• Kubernetes 与 Helm 集成：直接与 Kubernetes 部署和 Helm 发布集成，支持原生 Kubernetes 资源和 Helm 图表的自动化更新。

• 无 CLI/API 设计：无需额外命令行工具，通过标签、注解和图表即可完成配置，简化操作流程。

• 语义化版本策略：支持为每个部署或 Helm 发布单独指定更新策略，精确控制版本更新范围（如补丁、次要版本、主要版本）。

• 容器 registry 支持：

  • 自动配置 Google Container Registry (GCR)，通过定期扫描环境设置主题和订阅
  • 原生支持 DockerHub、Quay、Azure Container Registry 等的 webhook 触发器
  • 轮询机制：当 webhook 不可用时，可检查 registry 中的标签更新（语义化版本）或镜像 SHA 摘要变化（如 latest 标签）

• 通知功能：内置 Slack、Hipchat、Mattermost 和标准 webhook 通知，实时推送更新信息。

使用场景

• 自动化部署更新：适用于需要自动更新 Kubernetes 部署或 Helm 发布的场景，减少手动操作。
• 多环境版本控制：通过语义化版本策略，在开发、测试、生产环境中实现差异化版本更新。
• 混合 registry 环境：支持多种容器 registry（GCR、DockerHub、Quay 等），满足复杂基础设施需求。
• DevOps 流程集成：与 CI/CD 流水线配合，实现镜像推送后自动触发部署更新，加速交付流程。

安装方法

前置条件

• 已安装 Helm（参考 Helm 安装文档）
• 已配置 Kubernetes 集群

Helm 快速启动

1. 添加 Helm 仓库：

   bash
   helm repo add keel https://keel-hq.github.io/keel/ 
   helm repo update
   

2. 默认安装（启用 Helm 提供者）：

   bash
   helm upgrade --install keel --namespace=kube-system keel/keel
   

3. 仅使用 Kubernetes 清单（禁用 Helm 提供者）：

   bash
   helm upgrade --install keel --namespace=keel keel/keel --set helmProvider.enabled="false" 
   

4. 支持 Helm v3：

   bash
   helm install keel keel/keel --set helmProvider.version="v3" 
   

5. Terraform 配置示例：

   terraform
   resource "helm_release" "keel" {
     provider   = helm.helm
     name       = "keel"
     namespace  = "keel"
     repository = "https://keel-hq.github.io/keel"
     chart      = "keel"
     version    = "v1.0.4"
   
     set {
       name  = "basicauth.enabled"
       value = "true"
     }
   
     set {
       name  = "basicauth.user"
       value = "admin"
     }
   
     set {
       name  = "basicauth.password"
       value = "admin"
     }
   
     set {
       name  = "image.repository"
       value = "keelhq/keel"
     }
   
     set {
       name  = "image.tag"
       value = "0.19.1"
     }
   }
   

配置说明

Keel 通过 Kubernetes 部署或 Helm 发布的注解（annotations）进行配置，无需额外 CLI 或 API。以下是部署配置示例：

部署配置示例

yaml
apiVersion: apps/v1
kind: Deployment
metadata: 
  name: webhook-demo
  namespace: default
  annotations:
    keel.sh/policy: minor  # 语义化版本策略：更新次要版本（如 1.2.x → 1.3.0）
    keel.sh/trigger: poll  # 触发方式：轮询（可选：webhook、gcr）
spec:
  replicas: 1
  selector:
    matchLabels:
      app: webhook-demo
  template:
    metadata:
      labels:
        app: webhook-demo        
    spec:
      containers:                    
        - image: karolisr/webhook-demo:0.0.8  # 目标镜像
          imagePullPolicy: Always            
          name: webhook-demo
          ports:
            - containerPort: 8090

注解说明

• keel.sh/policy：版本更新策略，可选值：
  • major：更新主要版本（如 1.x.x → 2.0.0）
  • minor：更新次要版本（如 1.2.x → 1.3.0）
  • patch：更新补丁版本（如 1.2.3 → 1.2.4）
  • all：接受任何版本更新
  • force：强制更新（即使标签相同，检测 SHA 摘要变化）
• keel.sh/trigger：触发方式，可选值：poll（轮询）、webhook（Webhook）、gcr（GCR Pub/Sub）等。

文档与支持

完整文档请参考 Keel 官方文档。
社区支持：Kubernetes Slack 频道 #keel。