用 KubeBlocks 管理 RabbitMQ

RabbitMQ 是可靠且成熟的消息和流处理中间件，支持在云环境、本地数据中心或个人计算机上部署。

本文档展示了如何通过 kbcli、kubectl 等方式创建和管理 RabbitMQ 集群。您可以在 GitHub 仓库查看 YAML 示例。

备注

当前，KubeBlocks 仅支持通过 kubectl 管理 RabbitMQ 集群.

开始之前

安装 KubeBlocks，可通过 kbcli 或 Helm 安装.
安装并启用 rabbitmq 引擎，可通过 kbcli 或 Helm操作.

创建集群

KubeBlocks 通过 Cluster 定义集群。以下是创建 RabbitMQ 集群的示例。Pod 默认分布在不同节点。如果您只有一个节点可用于部署多副本集群，可设置 spec.schedulingPolicy 或 spec.componentSpecs.schedulingPolicy，具体可参考 API 文档。但生产环境中，不建议将所有副本部署在同一个节点上，因为这可能会降低集群的可用性。

cat <<EOF | kubectl apply -f -
apiVersion: apps.kubeblocks.io/v1
kind: Cluster
metadata:
  name: mycluster
  namespace: demo
spec:
  terminationPolicy: Delete
  componentSpecs:
    - name: rabbitmq
      componentDef: rabbitmq
      serviceVersion: 3.13.7
      serviceAccountName: kb-rabbitmq-cluster
      replicas: 3
      resources:
        limits:
          cpu: "0.5"
          memory: "0.5Gi"
        requests:
          cpu: "0.5"
          memory: "0.5Gi"
      volumeClaimTemplates:
        - name: data
          spec:
            storageClassName: ""
            accessModes:
              - ReadWriteOnce
            resources:
              requests:
                storage: 20Gi
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: rabbitmq-cluster-peer-discovery
  namespace: demo
rules:
- apiGroups:
  - ""
  resources:
  - endpoints
  verbs:
  - get
- apiGroups:
  - ""
  resources:
  - events
  verbs:
  - create
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: kb-rabbitmq-cluster
  namespace: demo
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: kb-rabbitmq-cluster
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: rabbitmq-cluster-peer-discovery
subjects:
  - kind: ServiceAccount
    name: kb-rabbitmq-cluster
    namespace: demo
EOF

字段	定义
`spec.terminationPolicy`	集群终止策略，有效值为 `DoNotTerminate`、`Delete` 和 `WipeOut`。具体定义可参考终止策略。
`spec.componentSpecs`	集群 component 列表，定义了集群 components。该字段支持自定义配置集群中每个 component。
`spec.componentSpecs.serviceVersion`	定义了 component 部署的服务版本。可选值为 [3.10.25,3.11.28,3.12.14,3.13.2,3.13.7,3.8.14,3.9.29]。
`spec.componentSpecs.serviceAccountName`	指定了运行 component 所需的 ServiceAccount 名称。RabbitMQ 需要 peer-discovery 角色来创建事件和获取端点。这对于发现其他 RabbitMQ 节点并形成集群至关重要。
`spec.componentSpecs.replicas`	定义了 component 中 replicas 的数量。RabbitMQ 建议配置奇数，如 [3,5,7]。所有数据/状态都会在所有副本之间进行复制。
`spec.componentSpecs.resources`	定义了 component 的资源要求。
`spec.componentSpecs.volumeClaimTemplates`	PersistentVolumeClaim 模板列表，定义 component 的存储需求。
`spec.componentSpecs.volumeClaimTemplates.name`	引用了在 `componentDefinition.spec.runtime.containers[*].volumeMounts` 中定义的 volumeMount 名称。
`spec.componentSpecs.volumeClaimTemplates.spec.storageClassName`	定义了 StorageClass 的名称。如果未指定，系统将默认使用带有 `storageclass.kubernetes.io/is-default-class=true` 注释的 StorageClass。
`spec.componentSpecs.volumeClaimTemplates.spec.resources.storage`	可按需配置存储容量。

您可参考 API 文档，查看更多 API 字段及说明。

KubeBlocks operator 监控 Cluster CRD 并创建集群和全部依赖资源。您可执行以下命令获取集群创建的所有资源信息。

kubectl get all,secret,rolebinding,serviceaccount -l app.kubernetes.io/instance=mycluster -n demo

执行以下命令，查看已创建的 RabbitMQ 集群。

kubectl get cluster mycluster -n demo -o yaml

连接集群

可使用 RabbitMQ tools 连接并管理 RabbitMQ 集群。

扩缩容

垂直扩缩容

开始之前

确认集群状态是否为 Running。否则，后续相关操作可能会失败。

kubectl get cluster mycluster -n demo
>
NAME        CLUSTER-DEFINITION    VERSION        TERMINATION-POLICY     STATUS    AGE
mycluster                                        Delete                 Running   47m

步骤

OpsRequest
修改集群 YAML 文件

对指定的集群应用 OpsRequest，可根据您的需求配置参数。

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-vertical-scaling
  namespace: demo
spec:
  clusterName: mycluster
  type: VerticalScaling
  verticalScaling:
  - componentName: rabbitmq
    requests:
      memory: "2Gi"
      cpu: "1"
    limits:
      memory: "4Gi"
      cpu: "2"
EOF

查看运维任务状态，验证垂直扩缩容操作是否成功。
```
kubectl get ops -n demo
>
NAME                   TYPE              CLUSTER     STATUS    PROGRESS   AGE
ops-vertical-scaling   VerticalScaling   mycluster   Succeed   3/3        6m
```
如果有报错，可执行 kubectl describe ops -n demo 命令查看该运维操作的相关事件，协助排障。
当 OpsRequest 状态为 Succeed 或集群状态再次回到 Running 后，查看相应资源是否变更。
```
kubectl describe cluster mycluster -n demo
```

修改 YAML 文件中 spec.componentSpecs.resources 的配置。spec.componentSpecs.resources 控制资源的请求值和限制值，修改参数值将触发垂直扩缩容。

kubectl edit cluster mycluster -n demo

在编辑器中修改 spec.componentSpecs.resources 的值。

...
spec:
  componentSpecs:
  - name: rabbitmq
    componentDefRef: rabbitmq
    replicas: 3
    resources: # 修改 resources 中的参数值
      requests:
        memory: "2Gi"
        cpu: "1"
      limits:
        memory: "4Gi"
        cpu: "2"
...

当集群状态再次回到 Running 后，查看相应资源是否变更。
```
kubectl describe cluster mycluster -n demo
```

水平伸缩

水平扩展改变 Pod 的数量。例如，您可以将副本从三个扩展到五个。

从 v0.9.0 开始，KubeBlocks 还支持了指定实例扩缩容。可通过水平扩缩容文档文档了解更多细节和示例。

开始之前

确认集群状态是否为 Running。否则，后续相关操作可能会失败。

kubectl get cluster mycluster -n demo
>
NAME        CLUSTER-DEFINITION    VERSION        TERMINATION-POLICY     STATUS    AGE
mycluster                                        Delete                 Running   47m

步骤

OpsRequest
编辑集群 YAML 文件

对指定的集群应用 OpsRequest，可根据您的需求配置参数。

以下示例演示了增加 2 个副本。

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-horizontal-scaling
  namespace: demo
spec:
  clusterName: mycluster
  type: HorizontalScaling
  horizontalScaling:
  - componentName: rabbitmq
    scaleIn:
      replicaChanges: 2
EOF

如果您想要缩容，可将 scaleOut 替换为 scaleIn，并修改 replicaChanges 的参数值。

查看运维操作状态，验证水平扩缩容是否成功。

kubectl get ops -n demo
>
NAME                     TYPE                CLUSTER     STATUS    PROGRESS   AGE
ops-horizontal-scaling   HorizontalScaling   mycluster   Succeed   2/2        6m

如果有报错，可执行 kubectl describe ops -n demo 命令查看该运维操作的相关事件，协助排障。

当 OpsRequest 状态为 Succeed 或集群状态再次回到 Running 后，查看相应资源是否变更。
```
kubectl describe cluster mycluster -n demo
```

修改 YAML 文件中 spec.componentSpecs.replicas 的配置。spec.componentSpecs.replicas 定义了 pod 数量，修改该参数将触发集群水平扩缩容。
```
kubectl edit cluster mycluster -n demo
```
在编辑器中修改 spec.componentSpecs.replicas 的值。
```
...
spec:
  componentSpecs:
  - name: rabbitmq
    componentDefRef: rabbitmq
    replicas: 1 # 修改参数值
...
```
当集群状态再次回到 Running 后，查看相关资源是否变更。
```
kubectl describe cluster mycluster -n demo
```

磁盘扩容

开始之前

确认集群状态是否为 Running。否则，后续相关操作可能会失败。

kubectl get cluster mycluster -n demo
>
NAME        CLUSTER-DEFINITION    VERSION        TERMINATION-POLICY     STATUS    AGE
mycluster                                        Delete                 Running   47m

步骤

OpsRequest
修改集群 YAML 文件

应用 OpsRequest。根据需求更改 storage 的值，并执行以下命令来更改集群的存储容量。

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: ops-volume-expansion
  namespace: demo
spec:
  clusterName: mycluster
  type: VolumeExpansion
  volumeExpansion:
  - componentName: rabbitmq
    volumeClaimTemplates:
    - name: data
      storage: "40Gi"
EOF

查看磁盘扩容操作是否成功。

kubectl get ops -n demo
>
NAME                   TYPE              CLUSTER     STATUS    PROGRESS   AGE
ops-volume-expansion   VolumeExpansion   mycluster   Succeed   1/1        6m

如果有报错，可执行 kubectl describe ops -n demo 命令查看该运维操作的相关事件，协助排障。

当 OpsRequest 状态为 Succeed 或集群状态再次回到 Running 后，查看相应资源是否变更。
```
kubectl describe cluster mycluster -n demo
```

修改集群 YAML 文件中 spec.componentSpecs.volumeClaimTemplates.spec.resources 的值。

spec.componentSpecs.volumeClaimTemplates.spec.resources 定义了 Pod 存储资源信息，修改该数值将触发集群磁盘扩容。

kubectl edit cluster mycluster -n demo

在编辑器中修改 spec.componentSpecs.volumeClaimTemplates.spec.resources 的值。

...
spec:
  componentSpecs:
  - name: rabbitmq
    componentDefRef: rabbitmq
    replicas: 2
    volumeClaimTemplates:
    - name: data
      spec:
        accessModes:
          - ReadWriteOnce
        resources:
          requests:
            storage: 40Gi # 修改该参数值
  terminationPolicy: Delete
...

当集群状态再次回到 Running 后，查看相应资源是否变更。
```
kubectl describe cluster mycluster -n demo
```

停止/启动集群

您可以停止/启动集群以释放计算资源。当集群停止时，其计算资源将被释放，也就是说 Kubernetes 的 Pod 将被释放，但其存储资源仍将被保留。您也可以重新启动该集群，使其恢复到停止集群前的状态。

停止集群

配置集群名称，并执行以下命令来停止该集群。

OpsRequest
修改集群 YAML 文件

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: mycluster-stop
  namespace: demo
spec:
  clusterName: mycluster
  type: Stop
EOF

将 replicas 的值修改为 0，删除 pod。

apiVersion: apps.kubeblocks.io/v1alpha1
kind: Cluster
metadata:
  name: mycluster
  namespace: demo
spec:
  terminationPolicy: Delete
  affinity:
    podAntiAffinity: Preferred
    topologyKeys:
      - kubernetes.io/hostname
  componentSpecs:
    - name: rabbitmq
      componentDef: rabbitmq
      serviceVersion: 3.13.2
      replicas: 0
      serviceAccountName: kb-mycluster
      resources:
        limits:
          cpu: "0.5"
          memory: "0.5Gi"
        requests:
          cpu: "0.5"
          memory: "0.5Gi"
      volumeClaimTemplates:
        - name: data
          spec:
            accessModes:
              - ReadWriteOnce
            resources:
              requests:
                storage: 20Gi
      services:

查看集群状态，确认集群是否已停止。
```
kubectl get cluster mycluster -n demo
```

启动集群

配置集群名称，并执行以下命令来启动该集群。

OpsRequest
修改集群 YAML 文件

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: mycluster-start
  namespace: demo
spec:
  clusterName: mycluster
  type: Start
EOF 

将 replicas 数值修改为初始值，启动集群。

apiVersion: apps.kubeblocks.io/v1alpha1
kind: Cluster
metadata:
  name: mycluster
  namespace: demo
spec:
  terminationPolicy: Delete
  affinity:
    podAntiAffinity: Preferred
    topologyKeys:
      - kubernetes.io/hostname
  componentSpecs:
    - name: rabbitmq
      componentDef: rabbitmq
      serviceVersion: 3.13.2
      replicas: 3
      serviceAccountName: kb-mycluster
      resources:
        limits:
          cpu: "0.5"
          memory: "0.5Gi"
        requests:
          cpu: "0.5"
          memory: "0.5Gi"
      volumeClaimTemplates:
        - name: data
          spec:
            accessModes:
              - ReadWriteOnce
            resources:
              requests:
                storage: 20Gi
      services:

查看集群状态，确认集群是否已再次运行。
```
kubectl get cluster mycluster -n demo
```

重启集群

执行以下命令，重启集群。

kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
  name: mycluster-restart
  namespace: demo
spec:
  clusterName: mycluster
  type: Restart 
  restart:
  - componentName: rabbitmq
EOF

查看 pod 和运维操作状态，验证重启操作是否成功。
```
kubectl get pod -n demo

kubectl get ops -n demo
```
重启过程中，Pod 有如下两种状态：
- STATUS=Terminating：表示集群正在重启。
- STATUS=Running：表示集群已重启。
如果操作过程中出现报错，可通过 kubectl describe ops -n demo 查看该操作的事件，协助排障。

删除集群

终止策略

备注

终止策略决定了删除集群的方式。

终止策略	删除操作
`DoNotTerminate`	`DoNotTerminate` 禁止删除操作。
`Halt`	`Halt` 删除集群资源（如 Pods、Services 等），但保留 PVC。停止其他运维操作的同时，保留了数据。但 `Halt` 策略在 v0.9.1 中已删除，设置为 `Halt` 的效果与 `DoNotTerminate` 相同。
`Delete`	`Delete` 在 `Halt` 的基础上，删除 PVC 及所有持久数据。
`WipeOut`	`WipeOut` 删除所有集群资源，包括外部存储中的卷快照和备份。使用该策略将会删除全部数据，特别是在非生产环境，该策略将会带来不可逆的数据丢失。请谨慎使用。

执行以下命令查看终止策略。

kubectl get cluster mycluster -n demo
>
NAME        CLUSTER-DEFINITION    VERSION        TERMINATION-POLICY     STATUS    AGE
mycluster                                        Delete                 Running   47m

步骤

执行以下命令，删除集群。

kubectl delete cluster mycluster -n demo

如果想删除集群和所有相关资源，可以将终止策略修改为 WipeOut，然后再删除该集群。

kubectl patch -n demo cluster mycluster -p '{"spec":{"terminationPolicy":"WipeOut"}}' --type="merge"

kubectl delete -n demo cluster mycluster

开始之前​

创建集群​

连接集群​

扩缩容​

垂直扩缩容​

开始之前​

步骤​

水平伸缩​

开始之前​

步骤​

磁盘扩容​

开始之前​

步骤​

停止/启动集群​

停止集群​

启动集群​

重启集群​

删除集群​

终止策略​

步骤​

开始之前

创建集群

连接集群

扩缩容

垂直扩缩容

开始之前

步骤

水平伸缩

开始之前

步骤

磁盘扩容

开始之前

步骤

停止/启动集群

停止集群

启动集群

重启集群

删除集群

终止策略

步骤