grafana/rollout-operator

Grafana Multi-AZ Rollout Operator 镜像文档

镜像概述

Grafana Multi-AZ Rollout Operator 是一个 Kubernetes Operator 镜像，专为协调多可用区（Multi-AZ）部署场景下的 StatefulSet 滚动更新而设计。该 Operator 通过自定义逻辑跨多个 StatefulSet 协调 Pod 滚动策略，确保多 AZ 环境中 Stateful 应用的更新过程有序、可控，避免因跨 AZ 同时中断导致的服务不可用风险。

主要用途

• 协调 Kubernetes 集群内特定命名空间中多个 StatefulSet 之间的 Pod 滚动更新流程
• 管理多 AZ 部署架构，确保每个 AZ 的专用 StatefulSet 在更新时遵循统一策略
• 保障 Stateful 应用（如分布式数据库、消息队列等）在跨 AZ 更新过程中的高可用性与数据一致性

核心功能与特性

1. 跨 StatefulSet 滚动协调

• 支持对同一命名空间内多个关联 StatefulSet 进行统一滚动更新调度
• 可配置 Pod 启停顺序、更新间隔、最大不可用 Pod 数等策略，避免跨 AZ 同时中断

2. 多 AZ 部署管理

• 原生适配多 AZ 架构，支持按 AZ 维度隔离 StatefulSet 资源
• 自动识别 AZ 拓扑标签（如 topology.kubernetes.io/zone），实现 AZ 级别的更新优先级控制

3. 命名空间级隔离

• 仅作用于指定命名空间内的 StatefulSet，避免对集群级资源造成干扰
• 支持通过 RBAC 权限控制，限制 Operator 对资源的访问范围

4. 声明式配置

• 基于 Kubernetes 自定义资源定义（CRD）实现声明式配置，支持通过 YAML 定义滚动策略
• 支持动态调整更新参数，无需重启 Operator 即可生效

使用场景与适用范围

适用场景

• 多 AZ 高可用 Stateful 应用：如分布式数据库（Cassandra、CockroachDB）、消息队列（Kafka、RabbitMQ）、分布式存储（Ceph、MinIO）等需要跨 AZ 部署以保障高可用的应用
• 严格更新顺序要求的场景：需按 AZ 或 StatefulSet 层级分批更新，避免数据不一致或服务中断的场景
• 大规模集群管理：简化多 StatefulSet 部署的更新流程，减少人工操作成本

适用范围

• Kubernetes 集群版本 ≥ 1.19（需支持 CRD v1 及 Operator SDK 依赖特性）
• 已启用 RBAC 的 Kubernetes 环境
• 多 AZ 部署的 StatefulSet 资源（每个 AZ 对应独立 StatefulSet，推荐通过拓扑标签区分）

使用方法

部署前提

• Kubernetes 集群（版本 ≥ 1.19）
• kubectl 工具已配置集群访问权限
• 集群支持自定义资源定义（CRD）

部署步骤

1. 安装 CRD

Operator 依赖自定义资源（CR）实现配置管理，需先部署 CRD：

bash
kubectl apply -f https://github.com/grafana/rollout-operator/releases/latest/download/crd.yaml

2. 部署 Operator

通过 Kubernetes Deployment 部署 Operator 控制器（镜像为 grafana/rollout-operator:<tag>，需替换 <tag> 为具体版本）：

部署清单示例（deployment.yaml）：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: rollout-operator
  namespace: grafana-rollout-operator  # 建议使用独立命名空间
spec:
  replicas: 1
  selector:
    matchLabels:
      app: rollout-operator
  template:
    metadata:
      labels:
        app: rollout-operator
    spec:
      serviceAccountName: rollout-operator  # 需提前创建 RBAC 权限
      containers:
      - name: operator
        image: docker.xuanyuan.run/grafana/rollout-operator:latest  # 替换为实际版本标签
        resources:
          limits:
            cpu: 500m
            memory: 512Mi
          requests:
            cpu: 200m
            memory: 256Mi
        env:
        - name: WATCH_NAMESPACE
          value: "default"  # 指定监听的命名空间，为空则监听所有命名空间
        - name: LOG_LEVEL
          value: "info"  # 日志级别：debug/info/warn/error
        - name: OPERATOR_NAME
          value: "rollout-operator"

应用部署清单：

bash
kubectl apply -f deployment.yaml

3. 创建滚动更新配置（CR 示例）

通过自定义资源（CR）定义多 AZ 滚动策略，示例如下：

CR 清单示例（rollout-config.yaml）：

yaml
apiVersion: rollout.grafana.com/v1alpha1
kind: MultiAZRollout
metadata:
  name: example-multiaz-rollout
  namespace: default  # 需与监听命名空间一致
spec:
  # StatefulSet 选择器：匹配需协调的 StatefulSet
  statefulSetSelector:
    matchLabels:
      app: my-stateful-app  # 替换为实际 StatefulSet 标签
  # 滚动更新策略
  rollingUpdate:
    maxUnavailable: 1  # 每次更新最大不可用 Pod 数
    intervalSeconds: 30  # 批次更新间隔（秒）
    azTopologyKey: "topology.kubernetes.io/zone"  # AZ 拓扑标签键
  # AZ 更新顺序（可选，默认按字母序）
  azOrder:
  - "us-west-2a"
  - "us-west-2b"
  - "us-west-2c"

应用 CR 配置：

bash
kubectl apply -f rollout-config.yaml

配置说明

自定义资源（CR）核心参数

环境变量配置

参考链接

• https://github.com/grafana/rollout-operator
• https://github.com/grafana/rollout-operator/blob/main/README.md