运行复制的有状态应用程序

本页面展示了如何使用 StatefulSet 运行有状态的复制应用程序。此应用程序是一个复制的 MySQL 数据库。示例拓扑结构有一个主服务器和多个副本，使用异步基于行的复制。

注意

这不是生产配置。MySQL 设置仍使用不安全的默认值，以便将重点放在 Kubernetes 中运行有状态应用程序的通用模式上。

准备工作

你需要有一个 Kubernetes 集群，并且 kubectl 命令行工具必须配置为与你的集群通信。建议在至少有两个不作为控制平面主机的节点的集群上运行本教程。如果你还没有集群，可以使用 minikube 创建一个，或者使用以下 Kubernetes 演练环境之一：
你需要有一个具有默认 StorageClass 的动态 PersistentVolume 供应器，或者你自己静态配置 PersistentVolumes 以满足此处使用的 PersistentVolumeClaims。
本教程假定你熟悉 PersistentVolumes 和 StatefulSets，以及其他核心概念，例如 Pods、Services 和 ConfigMaps。
对 MySQL 有一定的了解会有帮助，但本教程旨在呈现对其他系统也应有用的通用模式。
你正在使用默认命名空间或其他不包含任何冲突对象的命名空间。
你需要一个兼容 AMD64 的 CPU。

目标

使用 StatefulSet 部署一个复制的 MySQL 拓扑。
发送 MySQL 客户端流量。
观察对停机时间的抵抗力。
扩缩 StatefulSet。

部署 MySQL

示例 MySQL 部署包含一个 ConfigMap、两个 Service 和一个 StatefulSet。

创建 ConfigMap

从以下 YAML 配置文件创建 ConfigMap：

application/mysql/mysql-configmap.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: mysql
  labels:
    app: mysql
    app.kubernetes.io/name: mysql
data:
  primary.cnf: |
    # Apply this config only on the primary.
    [mysqld]
    log-bin    
  replica.cnf: |
    # Apply this config only on replicas.
    [mysqld]
    super-read-only

kubectl apply -f https://k8s.io/examples/application/mysql/mysql-configmap.yaml

此 ConfigMap 提供了 my.cnf 覆盖，使你能够独立控制主 MySQL 服务器及其副本的配置。在这种情况下，你希望主服务器能够向副本提供复制日志，并且你希望副本拒绝任何非通过复制进行的写入。

ConfigMap 本身并没有什么特别之处，导致不同部分应用于不同的 Pod。每个 Pod 在初始化时根据 StatefulSet 控制器提供的信息决定查看哪一部分。

创建 Service

从以下 YAML 配置文件创建 Service：

application/mysql/mysql-services.yaml

# Headless service for stable DNS entries of StatefulSet members.
apiVersion: v1
kind: Service
metadata:
  name: mysql
  labels:
    app: mysql
    app.kubernetes.io/name: mysql
spec:
  ports:
  - name: mysql
    port: 3306
  clusterIP: None
  selector:
    app: mysql
---
# Client service for connecting to any MySQL instance for reads.
# For writes, you must instead connect to the primary: mysql-0.mysql.
apiVersion: v1
kind: Service
metadata:
  name: mysql-read
  labels:
    app: mysql
    app.kubernetes.io/name: mysql
    readonly: "true"
spec:
  ports:
  - name: mysql
    port: 3306
  selector:
    app: mysql

kubectl apply -f https://k8s.io/examples/application/mysql/mysql-services.yaml

无头 Service 为 StatefulSet 控制器为集合中的每个 Pod 创建的 DNS 条目提供了一个宿主。由于无头 Service 名为 mysql，因此在同一 Kubernetes 集群和命名空间中的任何其他 Pod 内，通过解析 <pod-name>.mysql 即可访问这些 Pod。

客户端 Service，名为 mysql-read，是一个正常的 Service，具有自己的集群 IP，它在所有报告就绪的 MySQL Pod 之间分配连接。潜在的端点集包括主 MySQL 服务器和所有副本。

请注意，只有读取查询才能使用负载均衡的客户端 Service。由于只有一个主 MySQL 服务器，客户端应直接连接到主 MySQL Pod（通过其在无头 Service 中的 DNS 条目）来执行写入。

创建 StatefulSet

最后，从以下 YAML 配置文件创建 StatefulSet：

application/mysql/mysql-statefulset.yaml

apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: mysql
spec:
  selector:
    matchLabels:
      app: mysql
      app.kubernetes.io/name: mysql
  serviceName: mysql
  replicas: 3
  template:
    metadata:
      labels:
        app: mysql
        app.kubernetes.io/name: mysql
    spec:
      initContainers:
      - name: init-mysql
        image: mysql:5.7
        command:
        - bash
        - "-c"
        - |
          set -ex
          # Generate mysql server-id from pod ordinal index.
          [[ $HOSTNAME =~ -([0-9]+)$ ]] || exit 1
          ordinal=${BASH_REMATCH[1]}
          echo [mysqld] > /mnt/conf.d/server-id.cnf
          # Add an offset to avoid reserved server-id=0 value.
          echo server-id=$((100 + $ordinal)) >> /mnt/conf.d/server-id.cnf
          # Copy appropriate conf.d files from config-map to emptyDir.
          if [[ $ordinal -eq 0 ]]; then
            cp /mnt/config-map/primary.cnf /mnt/conf.d/
          else
            cp /mnt/config-map/replica.cnf /mnt/conf.d/
          fi          
        volumeMounts:
        - name: conf
          mountPath: /mnt/conf.d
        - name: config-map
          mountPath: /mnt/config-map
      - name: clone-mysql
        image: gcr.io/google-samples/xtrabackup:1.0
        command:
        - bash
        - "-c"
        - |
          set -ex
          # Skip the clone if data already exists.
          [[ -d /var/lib/mysql/mysql ]] && exit 0
          # Skip the clone on primary (ordinal index 0).
          [[ `hostname` =~ -([0-9]+)$ ]] || exit 1
          ordinal=${BASH_REMATCH[1]}
          [[ $ordinal -eq 0 ]] && exit 0
          # Clone data from previous peer.
          ncat --recv-only mysql-$(($ordinal-1)).mysql 3307 | xbstream -x -C /var/lib/mysql
          # Prepare the backup.
          xtrabackup --prepare --target-dir=/var/lib/mysql          
        volumeMounts:
        - name: data
          mountPath: /var/lib/mysql
          subPath: mysql
        - name: conf
          mountPath: /etc/mysql/conf.d
      containers:
      - name: mysql
        image: mysql:5.7
        env:
        - name: MYSQL_ALLOW_EMPTY_PASSWORD
          value: "1"
        ports:
        - name: mysql
          containerPort: 3306
        volumeMounts:
        - name: data
          mountPath: /var/lib/mysql
          subPath: mysql
        - name: conf
          mountPath: /etc/mysql/conf.d
        resources:
          requests:
            cpu: 500m
            memory: 1Gi
        livenessProbe:
          exec:
            command: ["mysqladmin", "ping"]
          initialDelaySeconds: 30
          periodSeconds: 10
          timeoutSeconds: 5
        readinessProbe:
          exec:
            # Check we can execute queries over TCP (skip-networking is off).
            command: ["mysql", "-h", "127.0.0.1", "-e", "SELECT 1"]
          initialDelaySeconds: 5
          periodSeconds: 2
          timeoutSeconds: 1
      - name: xtrabackup
        image: gcr.io/google-samples/xtrabackup:1.0
        ports:
        - name: xtrabackup
          containerPort: 3307
        command:
        - bash
        - "-c"
        - |
          set -ex
          cd /var/lib/mysql

          # Determine binlog position of cloned data, if any.
          if [[ -f xtrabackup_slave_info && "x$(<xtrabackup_slave_info)" != "x" ]]; then
            # XtraBackup already generated a partial "CHANGE MASTER TO" query
            # because we're cloning from an existing replica. (Need to remove the tailing semicolon!)
            cat xtrabackup_slave_info | sed -E 's/;$//g' > change_master_to.sql.in
            # Ignore xtrabackup_binlog_info in this case (it's useless).
            rm -f xtrabackup_slave_info xtrabackup_binlog_info
          elif [[ -f xtrabackup_binlog_info ]]; then
            # We're cloning directly from primary. Parse binlog position.
            [[ `cat xtrabackup_binlog_info` =~ ^(.*?)[[:space:]]+(.*?)$ ]] || exit 1
            rm -f xtrabackup_binlog_info xtrabackup_slave_info
            echo "CHANGE MASTER TO MASTER_LOG_FILE='${BASH_REMATCH[1]}',\
                  MASTER_LOG_POS=${BASH_REMATCH[2]}" > change_master_to.sql.in
          fi

          # Check if we need to complete a clone by starting replication.
          if [[ -f change_master_to.sql.in ]]; then
            echo "Waiting for mysqld to be ready (accepting connections)"
            until mysql -h 127.0.0.1 -e "SELECT 1"; do sleep 1; done

            echo "Initializing replication from clone position"
            mysql -h 127.0.0.1 \
                  -e "$(<change_master_to.sql.in), \
                          MASTER_HOST='mysql-0.mysql', \
                          MASTER_USER='root', \
                          MASTER_PASSWORD='', \
                          MASTER_CONNECT_RETRY=10; \
                        START SLAVE;" || exit 1
            # In case of container restart, attempt this at-most-once.
            mv change_master_to.sql.in change_master_to.sql.orig
          fi

          # Start a server to send backups when requested by peers.
          exec ncat --listen --keep-open --send-only --max-conns=1 3307 -c \
            "xtrabackup --backup --slave-info --stream=xbstream --host=127.0.0.1 --user=root"          
        volumeMounts:
        - name: data
          mountPath: /var/lib/mysql
          subPath: mysql
        - name: conf
          mountPath: /etc/mysql/conf.d
        resources:
          requests:
            cpu: 100m
            memory: 100Mi
      volumes:
      - name: conf
        emptyDir: {}
      - name: config-map
        configMap:
          name: mysql
  volumeClaimTemplates:
  - metadata:
      name: data
    spec:
      accessModes: ["ReadWriteOnce"]
      resources:
        requests:
          storage: 10Gi

kubectl apply -f https://k8s.io/examples/application/mysql/mysql-statefulset.yaml

你可以通过运行以下命令查看启动进度：

kubectl get pods -l app=mysql --watch

一段时间后，你应该会看到所有 3 个 Pod 都变为 Running：

NAME      READY     STATUS    RESTARTS   AGE
mysql-0   2/2       Running   0          2m
mysql-1   2/2       Running   0          1m
mysql-2   2/2       Running   0          1m

按 Ctrl+C 取消观察。

注意

如果你没有看到任何进展，请确保已启用动态 PersistentVolume 供应器，如前提条件中所述。

此清单使用各种技术来管理作为 StatefulSet 一部分的有状态 Pod。下一节将重点介绍其中一些技术，以解释 StatefulSet 创建 Pod 时发生的情况。

理解有状态 Pod 初始化

StatefulSet 控制器一次启动一个 Pod，按照其序数索引的顺序。它会等待每个 Pod 报告就绪后才启动下一个 Pod。

此外，控制器为每个 Pod 分配一个唯一且稳定的名称，格式为 <statefulset-name>-<ordinal-index>，这导致 Pod 被命名为 mysql-0、mysql-1 和 mysql-2。

上述 StatefulSet 清单中的 Pod 模板利用这些特性来执行 MySQL 复制的有序启动。

生成配置

在启动 Pod 规约中的任何容器之前，Pod 会首先按照定义的顺序运行所有 Init 容器。

第一个 Init 容器，名为 init-mysql，根据序数索引生成特殊的 MySQL 配置文件。

脚本通过从 hostname 命令返回的 Pod 名称末尾提取序数索引来确定自己的序数索引。然后，它将序数（带有数字偏移量以避免保留值）保存到 MySQL conf.d 目录中名为 server-id.cnf 的文件中。这会将 StatefulSet 提供的唯一稳定身份转换为需要相同属性的 MySQL 服务器 ID 域。

init-mysql 容器中的脚本还通过将内容复制到 conf.d 来应用 ConfigMap 中的 primary.cnf 或 replica.cnf。由于示例拓扑结构包含一个主 MySQL 服务器和任意数量的副本，因此脚本将序数 0 分配给主服务器，其他所有服务器都作为副本。结合 StatefulSet 控制器的部署顺序保证，这确保了主 MySQL 服务器在创建副本之前就绪，以便它们可以开始复制。

克隆现有数据

通常，当一个新的 Pod 作为副本加入集合时，它必须假定主 MySQL 服务器上可能已经存在数据。它还必须假定复制日志可能无法一直追溯到最初。这些保守的假设是允许运行中的 StatefulSet 随着时间的推移进行扩缩而不是固定其初始大小的关键。

第二个 Init 容器，名为 clone-mysql，在副本 Pod 首次在空的 PersistentVolume 上启动时执行克隆操作。这意味着它会从另一个运行中的 Pod 复制所有现有数据，以便其本地状态足够一致以开始从主服务器进行复制。

MySQL 本身不提供执行此操作的机制，因此示例使用了一个流行的开源工具 Percona XtraBackup。在克隆过程中，源 MySQL 服务器的性能可能会下降。为了最大程度地减少对主 MySQL 服务器的影响，脚本指示每个 Pod 从其序数索引低一个的 Pod 进行克隆。这之所以有效，是因为 StatefulSet 控制器总是确保 Pod N 在启动 Pod N+1 之前就绪。

启动复制

Init 容器成功完成后，常规容器开始运行。MySQL Pod 包含一个运行实际 mysqld 服务器的 mysql 容器，以及一个充当边车的 xtrabackup 容器。

xtrabackup 边车会查看克隆的数据文件，并确定是否有必要在副本上初始化 MySQL 复制。如果是，它会等待 mysqld 就绪，然后使用从 XtraBackup 克隆文件中提取的复制参数执行 CHANGE MASTER TO 和 START SLAVE 命令。

一旦副本开始复制，它会记住其主 MySQL 服务器，如果服务器重启或连接断开，它会自动重新连接。此外，由于副本通过其稳定的 DNS 名称（mysql-0.mysql）查找主服务器，即使主服务器因重新调度而获得新的 Pod IP，它们也能自动找到主服务器。

最后，启动复制后，xtrabackup 容器会监听来自其他请求数据克隆的 Pod 的连接。如果 StatefulSet 扩缩或下一个 Pod 丢失其 PersistentVolumeClaim 并需要重新进行克隆，此服务器将无限期保持运行。

发送客户端流量

你可以通过运行带有 mysql:5.7 镜像的临时容器并运行 mysql 客户端二进制文件来向主 MySQL 服务器（主机名 mysql-0.mysql）发送测试查询。

kubectl run mysql-client --image=mysql:5.7 -i --rm --restart=Never --\
  mysql -h mysql-0.mysql <<EOF
CREATE DATABASE test;
CREATE TABLE test.messages (message VARCHAR(250));
INSERT INTO test.messages VALUES ('hello');
EOF

使用主机名 mysql-read 向任何报告就绪的服务器发送测试查询。

kubectl run mysql-client --image=mysql:5.7 -i -t --rm --restart=Never --\
  mysql -h mysql-read -e "SELECT * FROM test.messages"

你应该会得到如下输出：

Waiting for pod default/mysql-client to be running, status is Pending, pod ready: false
+---------+
| message |
+---------+
| hello   |
+---------+
pod "mysql-client" deleted

为了证明 mysql-read Service 在服务器之间分配连接，你可以在循环中运行 SELECT @@server_id：

kubectl run mysql-client-loop --image=mysql:5.7 -i -t --rm --restart=Never --\
  bash -ic "while sleep 1; do mysql -h mysql-read -e 'SELECT @@server_id,NOW()'; done"

你应该会看到报告的 @@server_id 随机变化，因为每次连接尝试都可能选择不同的端点：

+-------------+---------------------+
| @@server_id | NOW()               |
+-------------+---------------------+
|         100 | 2006-01-02 15:04:05 |
+-------------+---------------------+
+-------------+---------------------+
| @@server_id | NOW()               |
+-------------+---------------------+
|         102 | 2006-01-02 15:04:06 |
+-------------+---------------------+
+-------------+---------------------+
| @@server_id | NOW()               |
+-------------+---------------------+
|         101 | 2006-01-02 15:04:07 |
+-------------+---------------------+

你可以按 Ctrl+C 停止循环，但让它在另一个窗口中运行很有用，这样你就可以看到以下步骤的效果。

模拟 Pod 和节点故障

为了展示从副本池而不是单个服务器读取的可用性更高，请让上面运行的 SELECT @@server_id 循环保持运行，同时强制一个 Pod 退出就绪状态。

中断就绪探测

mysql 容器的就绪探测运行命令 mysql -h 127.0.0.1 -e 'SELECT 1'，以确保服务器已启动并能够执行查询。

强制此就绪探测失败的一种方法是破坏该命令：

kubectl exec mysql-2 -c mysql -- mv /usr/bin/mysql /usr/bin/mysql.off

这会进入 Pod mysql-2 的实际容器文件系统，并重命名 mysql 命令，使就绪探测找不到它。几秒钟后，Pod 应该报告其一个容器未就绪，你可以通过运行以下命令进行检查：

kubectl get pod mysql-2

在 READY 列中查找 1/2：

NAME      READY     STATUS    RESTARTS   AGE
mysql-2   1/2       Running   0          3m

此时，你应该会看到 SELECT @@server_id 循环继续运行，尽管它不再报告 102。回想一下，init-mysql 脚本将 server-id 定义为 100 + $ordinal，因此服务器 ID 102 对应于 Pod mysql-2。

现在修复 Pod，几秒钟后它应该会重新出现在循环输出中：

kubectl exec mysql-2 -c mysql -- mv /usr/bin/mysql.off /usr/bin/mysql

删除 Pod

如果 Pod 被删除，StatefulSet 也会重新创建 Pod，类似于 ReplicaSet 对无状态 Pod 所做的那样。

kubectl delete pod mysql-2

StatefulSet 控制器注意到不再存在 mysql-2 Pod，并创建一个同名的新 Pod，并将其链接到相同的 PersistentVolumeClaim。你应该会看到服务器 ID 102 从循环输出中消失一段时间，然后自行返回。

排空节点

如果你的 Kubernetes 集群有多个节点，你可以通过发出 drain 命令来模拟节点停机（例如在节点升级时）。

首先确定 MySQL Pod 之一位于哪个节点上：

kubectl get pod mysql-2 -o wide

节点名称应显示在最后一列中：

NAME      READY     STATUS    RESTARTS   AGE       IP            NODE
mysql-2   2/2       Running   0          15m       10.244.5.27   kubernetes-node-9l2t

然后，通过运行以下命令排空节点，该命令将隔离节点，使其无法调度新的 Pod，然后驱逐任何现有的 Pod。将 <node-name> 替换为你上一步中找到的节点名称。

注意

排空节点可能会影响在同一节点上运行的其他工作负载和应用程序。仅在测试集群中执行以下步骤。

# See above advice about impact on other workloads
kubectl drain <node-name> --force --delete-emptydir-data --ignore-daemonsets

现在你可以看到 Pod 在不同的节点上重新调度：

kubectl get pod mysql-2 -o wide --watch

它应该看起来像这样：

NAME      READY   STATUS          RESTARTS   AGE       IP            NODE
mysql-2   2/2     Terminating     0          15m       10.244.1.56   kubernetes-node-9l2t
[...]
mysql-2   0/2     Pending         0          0s        <none>        kubernetes-node-fjlm
mysql-2   0/2     Init:0/2        0          0s        <none>        kubernetes-node-fjlm
mysql-2   0/2     Init:1/2        0          20s       10.244.5.32   kubernetes-node-fjlm
mysql-2   0/2     PodInitializing 0          21s       10.244.5.32   kubernetes-node-fjlm
mysql-2   1/2     Running         0          22s       10.244.5.32   kubernetes-node-fjlm
mysql-2   2/2     Running         0          30s       10.244.5.32   kubernetes-node-fjlm

同样，你应该会看到服务器 ID 102 从 SELECT @@server_id 循环输出中消失一段时间，然后返回。

现在解除节点的隔离，使其恢复正常状态：

kubectl uncordon <node-name>

扩缩副本数量

使用 MySQL 复制时，可以通过添加副本扩展读取查询容量。对于 StatefulSet，你可以通过一个命令实现这一点：

kubectl scale statefulset mysql  --replicas=5

通过运行以下命令观察新 Pod 的启动：

kubectl get pods -l app=mysql --watch

一旦它们启动，你应该会看到服务器 ID 103 和 104 开始出现在 SELECT @@server_id 循环输出中。

你还可以验证这些新服务器是否包含在你添加它们之前添加的数据：

kubectl run mysql-client --image=mysql:5.7 -i -t --rm --restart=Never --\
  mysql -h mysql-3.mysql -e "SELECT * FROM test.messages"

Waiting for pod default/mysql-client to be running, status is Pending, pod ready: false
+---------+
| message |
+---------+
| hello   |
+---------+
pod "mysql-client" deleted

缩减也同样无缝：

kubectl scale statefulset mysql --replicas=3

注意

尽管扩容会自动创建新的 PersistentVolumeClaim，但缩容不会自动删除这些 PVC。

这让你选择保留这些已初始化的 PVC，以便更快地进行扩容，或者在删除它们之前提取数据。

你可以通过运行以下命令来查看：

kubectl get pvc -l app=mysql

这表明所有 5 个 PVC 仍然存在，尽管 StatefulSet 已缩减到 3 个：

NAME           STATUS    VOLUME                                     CAPACITY   ACCESSMODES   AGE
data-mysql-0   Bound     pvc-8acbf5dc-b103-11e6-93fa-42010a800002   10Gi       RWO           20m
data-mysql-1   Bound     pvc-8ad39820-b103-11e6-93fa-42010a800002   10Gi       RWO           20m
data-mysql-2   Bound     pvc-8ad69a6d-b103-11e6-93fa-42010a800002   10Gi       RWO           20m
data-mysql-3   Bound     pvc-50043c45-b1c5-11e6-93fa-42010a800002   10Gi       RWO           2m
data-mysql-4   Bound     pvc-500a9957-b1c5-11e6-93fa-42010a800002   10Gi       RWO           2m

如果你不打算重复使用多余的 PVC，可以删除它们：

kubectl delete pvc data-mysql-3
kubectl delete pvc data-mysql-4

清理

通过在终端中按 Ctrl+C 或从另一个终端运行以下命令来取消 SELECT @@server_id 循环：
```
kubectl delete pod mysql-client-loop --now
```
删除 StatefulSet。这也会开始终止 Pod。
```
kubectl delete statefulset mysql
```
验证 Pod 是否消失。它们可能需要一些时间才能完成终止。
```
kubectl get pods -l app=mysql
```
当上述命令返回时，你就知道 Pod 已终止：
```
No resources found.
```
删除 ConfigMap、Service 和 PersistentVolumeClaim。
```
kubectl delete configmap,service,pvc -l app=mysql
```
如果你手动预配 PersistentVolumes，还需要手动删除它们，并释放底层资源。如果你使用动态预配器，它会在你删除 PersistentVolumeClaim 时自动删除 PersistentVolumes。一些动态预配器（例如 EBS 和 PD 的）也会在删除 PersistentVolumes 时释放底层资源。

下一步

了解更多关于扩缩 StatefulSet 的信息。
了解更多关于调试 StatefulSet 的信息。
了解更多关于删除 StatefulSet 的信息。
了解更多关于强制删除 StatefulSet Pod 的信息。
在 Helm Charts 仓库中查找其他有状态应用程序示例。

上次修改时间：2024 年 10 月 8 日，太平洋标准时间晚上 10:10：更新 content/en/docs/tasks/run-application/run-replicated-stateful-application.md (7b8fd10630)