datastax/cass-operator

Cass Operator

镜像概述和主要用途

Cass Operator是DataStax提供的Kubernetes Operator，用于在Kubernetes集群上部署、管理和运维Apache Cassandra®。通过自定义资源定义（CRD）简化Cassandra集群的生命周期管理，提供自动化节点管理、配置集成和高可用性保障，适用于需要在Kubernetes环境中运行Cassandra的生产和开发场景。

核心功能和特性

核心功能

• Token Ring初始化：确保一次仅引导一个节点，避免集群启动冲突
• 种子节点管理：每个机架一个或每个数据中心三个种子节点（取较多者）
• 配置集成：服务器配置通过CassandraDatacenter CRD统一管理
• 滚动重启：通过修改CRD实现节点滚动重启，最小化服务中断
• 机架安全存储：数据存储遵循机架安全策略，每个云可用区一个副本
• 均匀扩容：机架内节点均匀扩展，保持集群负载平衡
• 节点替换：自动检测并替换失效或不可恢复的节点
• 多数据中心支持：支持在单个Kubernetes命名空间内创建多数据中心集群

容器组件

operator由以下协同工作的容器镜像组成：

• Operator镜像：从operator目录源代码构建
• 配置构建器初始化容器：基于https://github.com/datastax/cass-config-builder%E6%9E%84%E5%BB%BA
• Cassandra镜像：基于https://github.com/datastax/management-api-for-apache-cassandra%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%94%AF%E6%8C%81Cassandra 3.11.7，实验性支持4.0-beta1
• DSE镜像（可选）：基于https://github.com/datastax/docker-images%E6%9E%84%E5%BB%BA

使用场景和适用范围

适用于需要在Kubernetes环境中部署和管理Apache Cassandra的场景，包括：

• 需要自动化Cassandra集群生命周期管理（部署、扩展、维护）的环境
• 追求高可用性和机架感知存储的生产系统
• 通过Kubernetes原生工具统一管理容器化应用的团队
• 构建地理分布式多数据中心Cassandra集群的场景

详细使用方法和配置说明

前置要求

• Kubernetes集群版本1.13或更高

快速启动

console
# 适用于GKE Regular Channel (k8s 1.16)，根据实际环境调整
kubectl create -f https://raw.githubusercontent.com/datastax/cass-operator/v1.4.0/docs/user/cass-operator-manifests-v1.16.yaml
kubectl create -f https://raw.githubusercontent.com/datastax/cass-operator/v1.4.0/operator/k8s-flavors/gke/storage.yaml
kubectl -n cass-operator create -f https://raw.githubusercontent.com/datastax/cass-operator/v1.4.0/operator/example-cassdc-yaml/cassandra-3.11.x/example-cassdc-minimal.yaml

安装Operator

1. 根据Kubernetes版本选择对应的manifest文件：

console
K8S_VER=v1.16  # 支持1.13-1.17版本
kubectl apply -f https://raw.githubusercontent.com/datastax/cass-operator/v1.4.0/docs/user/cass-operator-manifests-$K8S_VER.yaml

注意：安装需要集群管理员权限，因为涉及自定义资源定义(CRD)的创建

2. 验证Operator部署状态：

console
kubectl -n cass-operator get pods --selector name=cass-operator
# 预期输出：
# NAME                             READY   STATUS    RESTARTS   AGE
# cass-operator-555577b9f8-zgx6j   1/1     Running   0          25h

创建存储类

存储类定义Cassandra节点使用的存储类型，以下是GKE环境SSD存储类示例：

yaml
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: server-storage
provisioner: kubernetes.io/gce-pd
parameters:
  type: pd-ssd
  replication-type: none
volumeBindingMode: WaitForFirstConsumer
reclaimPolicy: Delete

应用存储类：

console
kubectl apply -f https://raw.githubusercontent.com/datastax/cass-operator/v1.4.0/operator/k8s-flavors/gke/storage.yaml

创建CassandraDatacenter

以下示例创建包含3个节点的Cassandra 3.11.7数据中心：

yaml
apiVersion: cassandra.datastax.com/v1beta1
kind: CassandraDatacenter
metadata:
  name: dc1
spec:
  clusterName: cluster1
  serverType: cassandra
  serverVersion: 3.11.7
  managementApiAuth:
    insecure: {}
  size: 3  # 节点数量
  storageConfig:
    cassandraDataVolumeClaimSpec:
      storageClassName: server-storage  # 引用前面创建的存储类
      accessModes:
      - ReadWriteOnce
      resources:
        requests:
          storage: 5Gi  # 每个节点的存储请求
  config:
    cassandra-yaml:
      authenticator: org.apache.cassandra.auth.PasswordAuthenticator
      authorizer: org.apache.cassandra.auth.CassandraAuthorizer
      role_manager: org.apache.cassandra.auth.CassandraRoleManager
    jvm-options:
      initial_heap_size: 800M
      max_heap_size: 800M

应用配置：

console
kubectl -n cass-operator apply -f https://raw.githubusercontent.com/datastax/cass-operator/v1.4.0/operator/example-cassdc-yaml/cassandra-3.11.x/example-cassdc-minimal.yaml

验证集群状态

1. 检查Cassandra节点pod状态：

console
kubectl -n cass-operator get pods --selector cassandra.datastax.com/cluster=cluster1
# 预期输出：
# NAME                         READY   STATUS    RESTARTS   AGE
# cluster1-dc1-default-sts-0   2/2     Running   0          26h
# cluster1-dc1-default-sts-1   2/2     Running   0          26h
# cluster1-dc1-default-sts-2   2/2     Running   0          26h

2. 检查数据中心部署进度：

console
kubectl -n cass-operator get cassdc/dc1 -o "jsonpath={.status.cassandraOperatorProgress}"
# 预期输出：Ready（表示部署完成）

说明：cassdc和cassdcs是CassandraDatacenter的缩写形式

3. 使用nodetool检查集群状态：

console
kubectl -n cass-operator exec -it -c cassandra cluster1-dc1-default-sts-0 -- nodetool status

访问Cassandra集群

Operator默认创建安全集群，超级用户凭证存储在Kubernetes secret中：

console
# 获取超级用户凭证
CASS_USER=$(kubectl -n cass-operator get secret cluster1-superuser -o json | jq -r '.data.username' | base64 --decode)
CASS_PASS=$(kubectl -n cass-operator get secret cluster1-superuser -o json | jq -r '.data.password' | base64 --decode)

# 使用cqlsh连接
kubectl -n cass-operator exec -ti cluster1-dc1-default-sts-0 -c cassandra -- sh -c "cqlsh -u '$CASS_USER' -p '$CASS_PASS'"

通过Helm安装（可选）

1. 创建命名空间：

console
kubectl create namespace cass-operator-system

2. 安装Helm chart：

console
helm install --namespace=cass-operator-system cass-operator ./charts/cass-operator-chart

3. 可覆盖的Helm默认值：

yaml
clusterWideInstall: false  # 是否集群范围安装
serviceAccountName: cass-operator
roleName: cass-operator
roleBindingName: cass-operator
webhookClusterRoleName: cass-operator-webhook
webhookClusterRoleBindingName: cass-operator-webhook
deploymentName: cass-operator
deploymentReplicas: 1  # operator副本数
image: "docker.xuanyuan.run/datastax/cass-operator:1.4.0"  # operator镜像
imagePullPolicy: IfNotPresent

集群范围安装示例：

console
helm install --set clusterWideInstall=true --namespace=cass-operator-system cass-operator ./charts/cass-operator-chart

注意：Helm不自动安装存储类，需手动创建

不支持的功能（尚未支持）

• 缩容/减少数据中心节点数量
• Cassandra集成数据修复解决方案
• Cassandra集成备份和恢复解决方案
• DSE高级工作负载（搜索/图/分析）

卸载

警告：以下操作将销毁所有数据，请谨慎执行！

1. 先删除CassandraDatacenters：

console
kubectl delete cassdcs --all-namespaces --all

2. 删除Operator及相关资源：

console
kubectl delete -f https://raw.githubusercontent.com/datastax/cass-operator/v1.4.0/docs/user/cass-operator-manifests-v1.16.yaml

联系方式

• 开发问题：https://gitter.im/cass-operator/community%E6%88%96GitHub Issue
• 使用问题：DataStax社区论坛

许可证

Copyright DataStax, Inc.

根据Apache License 2.0许可。您可以在http://www.apache.org/licenses/LICENSE-2.0%E8%8E%B7%E5%8F%96%E8%AE%B8%E5%8F%AF%E8%AF%81%E5%89%AF%E6%9C%AC%E3%80%82%E9%99%A4%E9%9D%9E%E9%80%82%E7%94%A8***%E8%A6%81%E6%B1%82%E6%88%96%E4%B9%A6%E9%9D%A2%E5%90%8C%E6%84%8F%EF%BC%8C%E8%BD%AF%E4%BB%B6%E6%8C%89%22%E5%8E%9F%E6%A0%B7%22%E5%88%86%E5%8F%91%EF%BC%8C%E4%B8%8D%E6%8F%90%E4%BE%9B%E4%BB%BB%E4%BD%95%E6%98%8E%E7%A4%BA%E6%88%96%E6%9A%97%E7%A4%BA%E6%8B%85%E4%BF%9D%E3%80%82