xiaopal/helm-app-operator

helm-app-operator

镜像概述

helm-app-operator是基于Kubernetes Operator模式的工具，通过自定义资源定义（CRD）实现Helm Chart的自动化部署与生命周期管理，帮助用户在K8s集群中高效完成应用的安装、更新和卸载流程。

核心功能

• 声明式部署：通过CRD资源绑定Helm Chart，实现应用的声明式管理
• 钩子支持：提供pre-install、post-install等钩子操作，自定义部署前后逻辑
• 灵活配置：通过注解覆盖Chart路径、参数等，适配不同场景需求
• 本地调试：支持本地构建与测试命令，便于开发与调试

使用场景

• 自动化部署Redis、Redis-HA等常见应用到K8s集群
• 多环境下的应用版本管理与批量部署
• 自定义Chart的生命周期管理，简化运维流程

配置说明

环境变量

• CRD_RESOURCE：指定关联的CRD资源（格式：Kind,Group/Version）
• OPERATOR_NAME：操作器名称，通常从Pod标签获取

注解配置

• redis-operator/post-install：部署后执行的命令
• redis-operator/pre-install：部署前执行的命令
• redis-operator/chart：覆盖使用的Chart路径

部署示例

Redis Operator部署

yaml
kubectl -n kube-system create -f- <<\EOF
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: redis-operator

---
kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1beta1
metadata:
  name: redis-operator
subjects:
- kind: ServiceAccount
  name: redis-operator
roleRef:
  kind: ClusterRole
  name: admin
  apiGroup: rbac.authorization.k8s.io

---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: redisapps.xiaopal.github.com
spec:
  group: xiaopal.github.com
  names:
    kind: RedisApp
    plural: redisapps
  scope: Namespaced
  version: v1beta1

---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: redis-operator
spec:
  replicas: 1
  selector:
    matchLabels:
      app: redis-operator
  template:
    metadata:
      labels:
        app: redis-operator
    spec:
      serviceAccountName: redis-operator
      containers:
        - name: operator
          image: xiaopal/helm-app-operator
          command: 
            - /bin/bash
            - -c
            - helm fetch stable/redis --untar && 
              exec helm-app-operator --chart=/redis
          env:
            - name: CRD_RESOURCE
              value: RedisApp,redisapps.xiaopal.github.com/v1beta1
            - name: OPERATOR_NAME
              valueFrom: {fieldRef: {fieldPath: "metadata.labels['app']"}}

---
apiVersion: xiaopal.github.com/v1beta1
kind: RedisApp
metadata:
  name: redis-app
  namespace: default
spec:
  nameOverride: redis-app
EOF

钩子使用示例

yaml
apiVersion: xiaopal.github.com/v1beta1
kind: RedisApp
metadata:
  name: redis-ha-app
  namespace: default
  annotations:
    redis-operator/post-install: |
      echo $EVENT_RELEASE
    redis-operator/pre-install: |
      [ -d /redis-ha ] || helm fetch stable/redis-ha
    redis-operator/chart: /redis-ha
spec:
  nameOverride: redis-ha-app

构建与测试命令

bash
# 构建二进制文件
CGO_ENABLED=0 GOOS=linux go build -o bin/helm-app-operator -ldflags '-s -w' cmd/*.go

# 初始化CRD
bin/helm-app-operator --crd Test,tests.xiaopal.github.com/v1 --kubeconfig ~/.kube/config init

# 安装测试资源
bin/helm-app-operator --crd Test,tests.xiaopal.github.com/v1 --kubeconfig ~/.kube/config install test

# 指定Chart路径运行
bin/helm-app-operator --crd Test,tests.xiaopal.github.com/v1 --kubeconfig ~/.kube/config --chart=$PWD

# 卸载测试资源
bin/helm-app-operator --crd Test,tests.xiaopal.github.com/v1 --kubeconfig ~/.kube/config uninstall test