keelhq/keel

Keel - 面向所有人的自动化Kubernetes部署工具

镜像概述和主要用途

Keel是一个用于自动化Kubernetes部署更新的工具，具有无状态、健壮和轻量级的特点。它无需CLI或API，通过标签、注解和图表即可实现部署更新，支持Kubernetes和Helm直接集成，提供灵活的更新策略和多容器仓库支持，旨在简化Kubernetes环境中的持续部署流程。

核心功能和特性

• Kubernetes与Helm集成：直接支持Kubernetes部署和Helm发布的自动化更新。
• 无CLI/API设计：无需命令行工具或接口，通过标签、注解和图表完成配置。
• 语义化版本策略：可为每个部署或Helm发布单独指定更新策略（如补丁、次要版本、主要版本等）。
• 自动GCR配置：定期扫描环境，自动为部署镜像设置Google Container Registry的主题和订阅。
• 多仓库网络钩子支持：原生支持DockerHub、Quay、Azure容器仓库和GCR的网络钩子，接收钩子后自动更新受影响的部署。
• 轮询机制：当网络钩子不可用时，可主动检查容器仓库的新版本（语义化标签）或相同标签的SHA digest变化（如latest标签）。
• 通知功能：内置Slack、Hipchat、Mattermost和标准网络钩子通知，实时反馈更新状态。

使用场景和适用范围

• Kubernetes持续部署：适用于需要自动化更新Kubernetes部署的团队或个人。
• Helm用户：使用Helm管理Kubernetes应用，需自动更新Helm发布的场景。
• 多容器仓库环境：使用DockerHub、GCR、Quay或Azure容器仓库，需通过网络钩子或轮询触发更新的场景。
• 简化配置需求：希望通过标签和注解而非复杂命令配置自动更新策略的用户。

使用方法和配置说明

快速开始（kubectl安装）

本地Minikube环境

1. 启动Minikube：

   bash
   minikube start
   

2. 通过kubectl安装Keel（可自定义命名空间、凭据和版本标签）：

   bash
   # 如需覆盖默认语义化版本标签，可添加&tag=x.x.x参数（示例使用latest获取最新UI）
   kubectl apply -f https://sunstone.dev/keel?namespace=default&username=admin&password=admin&tag=latest
   

3. 获取Keel访问地址：

   bash
   minikube service --namespace default keel --url
   # 示例输出：http://192.168.99.100:3199
   

远程访问配置

结合Webhook Relay sidecar实现远程访问：

1. 获取Webhook Relay的令牌并创建隧道。
2. 安装命令：

   bash
   kubectl apply -f https://sunstone.dev/keel?namespace=default&username=admin&password=admin&relay_key=TOKEN_KEY&relay_secret=TOKEN_SECRET&relay_tunnel=TUNNEL_NAME&tag=latest
   

Helm安装

前提条件

• 已安装Helm
• 运行中的Kubernetes集群

安装步骤

1. 添加Helm仓库：

   bash
   helm repo add keel https://charts.keel.sh 
   helm repo update
   

2. 默认安装（启用Helm provider）：

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

3. 禁用Helm provider（适用于主要使用Kubernetes清单的场景）：

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

4. Helm v3支持（默认支持v2，需指定版本）：

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

配置说明

Keel通过部署清单或Helm发布的注解（annotations）配置更新策略，无需额外配置文件。示例如下：

yaml
apiVersion: extensions/v1beta1
kind: Deployment
metadata: 
  name: wd
  namespace: default
  labels: 
    name: "wd"
  annotations:
    keel.sh/policy: minor  # 语义化版本策略（minor/patch/major等，遵循semver.org）
    keel.sh/trigger: poll  # 触发方式：poll（轮询）或默认webhook（网络钩子）
spec:
  template:
    metadata:
      name: wd
      labels:
        app: wd        
    spec:
      containers:                    
        - image: karolisr/webhook-demo:0.0.8
          imagePullPolicy: Always            
          name: wd
          command: ["/bin/webhook-demo"]
          ports:
            - containerPort: 8090

文档与资源

• 官方网站：[***]
• 详细文档：[***]
• 社区支持：Slack频道 #keel（在kubernetes.***中搜索）

贡献

开发新功能或修复前，建议先在https://github.com/keel-hq/keel/issues%E6%8F%90%E5%87%BA%E9%9C%80%E6%B1%82%E4%BB%A5%E5%8D%8F%E8%B0%83%E5%B7%A5%E4%BD%9C%E3%80%82%E8%B4%A1%E7%8C%AE%E6%B5%81%E7%A8%8B%EF%BC%9A

1. Fork本仓库
2. 创建功能分支
3. 提交变更并推送到Fork仓库
4. 提交Pull Request