#StatefulSets

#理解 StatefulSets

请参考 Kubernetes 官方文档：StatefulSets

StatefulSet 是 Kubernetes 的一种工作负载 API 对象，旨在通过以下方式管理有状态应用：

• 稳定的网络身份：DNS 主机名格式为 <statefulset-name>-<ordinal>.<service-name>.ns.svc.cluster.local。
• 稳定的持久存储：通过 volumeClaimTemplates 实现。
• 有序部署/扩缩容：Pod 按顺序创建/删除：Pod-0 → Pod-1 → Pod-N。
• 有序滚动更新：Pod 按逆序号更新：Pod-N → Pod-0。

在分布式系统中，可以部署多个 StatefulSets 作为独立组件来提供专门的有状态服务（例如 Kafka brokers、MongoDB shards）。

#创建 StatefulSets

#使用 CLI 创建 StatefulSet

#前提条件

• 确保已配置好 kubectl 并连接到集群。

#YAML 文件示例

# example-statefulset.yaml
apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: web
spec:
  selector:
    matchLabels:
      app: nginx # 必须与 .spec.template.metadata.labels 匹配
  serviceName: 'nginx' # 该无头 Service 负责 Pod 的网络身份
  replicas: 3 # 定义期望的 Pod 副本数（默认：1）
  minReadySeconds: 10 # 默认为 0
  template: # 定义 StatefulSet 的 Pod 模板
    metadata:
      labels:
        app: nginx # 必须与 .spec.selector.matchLabels 匹配
    spec:
      terminationGracePeriodSeconds: 10
      containers:
        - name: nginx
          image: registry.k8s.io/nginx-slim:0.24
          ports:
            - containerPort: 80
              name: web
          volumeMounts:
            - name: www
              mountPath: /usr/share/nginx/html
  volumeClaimTemplates: # 定义 PersistentVolumeClaim (PVC) 模板。每个 Pod 根据模板动态创建唯一的 PersistentVolume (PV)。
    - metadata:
        name: www
      spec:
        accessModes: ['ReadWriteOnce']
        storageClassName: 'my-storage-class'
        resources:
          requests:
            storage: 1Gi
---
# example-service.yaml
apiVersion: v1
kind: Service
metadata:
  name: nginx
  labels:
    app: nginx
spec:
  ports:
    - port: 80
      name: web
  clusterIP: None
  selector:
    app: nginx

#通过 YAML 创建 StatefulSet

# 第 1 步：执行以下命令创建 example-statefulset.yaml 中定义的 StatefulSet
kubectl apply -f example-statefulset.yaml

# 第 2 步：验证 StatefulSet 及其关联的 Pods 和 PVC 的创建和状态：
kubectl get statefulset web # 查看 StatefulSet
kubectl get pods -l app=nginx # 查看该 StatefulSet 管理的 Pods
kubectl get pvc -l app=nginx # 查看 volumeClaimTemplates 创建的 PVC

#使用 Web 控制台创建 StatefulSet

#前提条件

获取镜像地址。镜像来源可以是平台管理员通过工具链集成的镜像仓库，也可以是第三方平台的镜像仓库。

• 对于前者，管理员通常会将镜像仓库分配给您的项目，您可以使用其中的镜像。如果找不到所需的镜像仓库，请联系管理员进行分配。

• 对于第三方平台的镜像仓库，请确保当前集群可以直接拉取镜像。

• 如果镜像仓库需要认证，您需要配置相应的镜像拉取密钥。详情请参见 向 ServiceAccount 添加 ImagePullSecrets。

#操作步骤 - 配置基本信息

1. 在 Container Platform 中，左侧导航栏进入 Workloads > StatefulSets。

2. 点击 Create StatefulSet。

3. 选择或输入镜像，点击 Confirm。

在 Basic Info 部分，配置 StatefulSet 工作负载的声明式参数：

#操作步骤 - 配置 Pod

Pod 部分，请参见 Deployment - 配置 Pod

#操作步骤 - 配置容器

Containers 部分，请参见 Deployment - 配置容器

#操作步骤 - 创建

点击 Create。

#健康检查

• 健康检查 YAML 文件示例
• Web 控制台中的健康检查配置参数

#管理 StatefulSets

#使用 CLI 管理 StatefulSet

#查看 StatefulSet

您可以查看 StatefulSet 以获取应用信息。

• 检查 StatefulSet 是否已创建。

  kubectl get statefulsets

• 获取 StatefulSet 详细信息。

  kubectl describe statefulsets

#扩缩容 StatefulSet

• 修改现有 StatefulSet 的副本数：

  kubectl scale statefulset <statefulset-name> --replicas=<new-replica-count>

• 示例：

  kubectl scale statefulset web --replicas=5

#更新 StatefulSet（滚动更新）

当修改 StatefulSet 的 Pod 模板（例如更改容器镜像）时，Kubernetes 默认执行滚动更新（如果 updateStrategy 设置为 RollingUpdate，且这是默认值）。

• 先编辑 YAML 文件（如 example-statefulset.yaml）并应用更改：

  kubectl apply -f example-statefulset.yaml

• 然后监控滚动更新进度：

  kubectl rollout status statefulset/<statefulset-name>

#删除 StatefulSet

删除 StatefulSet 及其关联的 Pods：

kubectl delete statefulset <statefulset-name>

默认情况下，删除 StatefulSet 不会删除其关联的 PersistentVolumeClaims (PVCs) 或 PersistentVolumes (PVs)，以防止数据丢失。若需同时删除 PVC，请显式执行：

kubectl delete pvc -l app=<label-selector-for-your-statefulset> # 示例：kubectl delete pvc -l app=nginx

或者，如果您的 volumeClaimTemplates 使用了 reclaimPolicy 为 Delete 的 StorageClass，则在删除 PVC 时，PV 及其底层存储会自动被删除。

#使用 Web 控制台管理 StatefulSet

#查看 StatefulSet

1. 在 Container Platform 中，进入 Workloads > StatefulSets。
2. 找到您想查看的 StatefulSet。
3. 点击 StatefulSet 名称查看 详情、拓扑、日志、事件、监控 等信息。

#更新 StatefulSet

1. 在 Container Platform 中，进入 Workloads > StatefulSets。
2. 找到您想更新的 StatefulSet。
3. 在 Actions 下拉菜单中选择 Update，进入编辑 StatefulSet 页面，可更新 Replicas、image、updateStrategy 等参数。

#删除 StatefulSet

1. 在 Container Platform 中，进入 Workloads > StatefulSets。
2. 找到您想删除的 StatefulSet。
3. 在 Actions 下拉菜单中，点击操作列中的 Delete 按钮并确认。