为 Kubernetes 运行 etcd 集群

etcd 是一个一致且高度可用的键值存储，用作 Kubernetes 的后端存储，用于所有集群数据。

如果你的 Kubernetes 集群使用 etcd 作为其后端存储，请确保你有一个数据备份计划。

你可以在官方文档中找到有关 etcd 的深入信息。

开始之前

在按照本页中的步骤部署、管理、备份或恢复 etcd 之前，你需要了解运行 etcd 集群的典型期望。请参阅 etcd 文档 以获取更多信息。

关键细节包括

• 在生产环境中运行的 etcd 的最低推荐版本是 3.4.29+ 和 3.5.11+。

• etcd 是一个基于领导者的分布式系统。确保领导者及时向所有追随者发送心跳，以保持集群稳定。

• 你应该将 etcd 作为具有奇数成员的集群运行。

• 旨在确保不会发生资源匮乏。

  集群的性能和稳定性对网络和磁盘 I/O 敏感。任何资源匮乏都可能导致心跳超时，从而导致集群不稳定。一个不稳定的 etcd 表明没有选举出领导者。在这种情况下，集群无法对其当前状态进行任何更改，这意味着无法调度新的 Pod。

etcd 的资源需求

使用有限的资源运行 etcd 仅适用于测试目的。对于在生产环境中部署，需要高级硬件配置。在生产环境中部署 etcd 之前，请参阅 资源需求参考。

保持 etcd 集群稳定对于 Kubernetes 集群的稳定性至关重要。因此，在专用机器或隔离环境中运行 etcd 集群，以满足 保证的资源需求。

工具

根据你正在处理的具体结果，你需要 etcdctl 工具或 etcdutl 工具（你可能需要两者）。

了解 etcdctl 和 etcdutl

etcdctl 和 etcdutl 是用于与 etcd 集群交互的命令行工具，但它们服务于不同的目的

• etcdctl：这是通过网络与 etcd 交互的主要命令行客户端。它用于日常操作，例如管理键和值、管理集群、检查健康状况等。

• etcdutl：这是一个管理实用程序，旨在直接操作 etcd 数据文件，包括在 etcd 版本之间迁移数据、碎片整理数据库、恢复快照和验证数据一致性。对于网络操作，应使用 etcdctl。

有关 etcdutl 的更多信息，请参阅 etcd 恢复文档。

启动 etcd 集群

本节介绍启动单节点和多节点 etcd 集群。

本指南假定 etcd 已经安装。

单节点 etcd 集群

仅将单节点 etcd 集群用于测试目的。

1. 运行以下命令

   etcd --listen-client-urls=http://$PRIVATE_IP:2379 \
      --advertise-client-urls=http://$PRIVATE_IP:2379
   

2. 使用标志 --etcd-servers=$PRIVATE_IP:2379 启动 Kubernetes API 服务器。

   确保 PRIVATE_IP 设置为你的 etcd 客户端 IP。

多节点 etcd 集群

为了持久性和高可用性，在生产环境中将 etcd 作为多节点集群运行，并定期备份。建议在生产环境中运行一个五成员集群。有关更多信息，请参阅 FAQ 文档。

由于你正在使用 Kubernetes，你可以选择将 etcd 作为容器在一个或多个 Pod 中运行。kubeadm 工具默认设置 etcd 静态 Pod，或者你可以部署一个 单独的集群 并指示 kubeadm 将该 etcd 集群用作控制平面的后端存储。

你可以通过静态成员信息或动态发现来配置 etcd 集群。有关集群的更多信息，请参阅 etcd 集群文档。

例如，考虑一个运行以下客户端 URL 的五成员 etcd 集群：http://$IP1:2379、http://$IP2:2379、http://$IP3:2379、http://$IP4:2379 和 http://$IP5:2379。要启动 Kubernetes API 服务器

1. 运行以下命令

   etcd --listen-client-urls=http://$IP1:2379,http://$IP2:2379,http://$IP3:2379,http://$IP4:2379,http://$IP5:2379 --advertise-client-urls=http://$IP1:2379,http://$IP2:2379,http://$IP3:2379,http://$IP4:2379,http://$IP5:2379
   

2. 使用标志 --etcd-servers=$IP1:2379,$IP2:2379,$IP3:2379,$IP4:2379,$IP5:2379 启动 Kubernetes API 服务器。

   确保 IP<n> 变量设置为你的客户端 IP 地址。

具有负载均衡器的多节点 etcd 集群

要运行具有负载均衡的 etcd 集群

1. 设置 etcd 集群。
2. 在 etcd 集群前面配置负载均衡器。例如，让负载均衡器的地址为 $LB。
3. 使用标志 --etcd-servers=$LB:2379 启动 Kubernetes API 服务器。

保护 etcd 集群

访问 etcd 等同于集群中的 root 权限，因此理想情况下只有 API 服务器才应具有访问权限。考虑到数据的敏感性，建议仅授予需要访问 etcd 集群的节点权限。

要保护 etcd，可以设置防火墙规则或使用 etcd 提供的安全功能。etcd 安全功能依赖于 x509 公钥基础设施 (PKI)。首先，通过生成密钥和证书对来建立安全的通信通道。例如，使用密钥对 peer.key 和 peer.cert 来保护 etcd 成员之间的通信，并使用 client.key 和 client.cert 来保护 etcd 与其客户端之间的通信。请参阅 etcd 项目提供的 示例脚本 以生成客户端身份验证的密钥对和 CA 文件。

保护通信

要使用安全的对等通信配置 etcd，请指定标志 --peer-key-file=peer.key 和 --peer-cert-file=peer.cert，并使用 HTTPS 作为 URL 架构。

类似地，要使用安全的客户端通信配置 etcd，请指定标志 --key=k8sclient.key 和 --cert=k8sclient.cert，并使用 HTTPS 作为 URL 架构。以下是使用安全通信的客户端命令示例

ETCDCTL_API=3 etcdctl --endpoints 10.2.0.9:2379 \
  --cert=/etc/kubernetes/pki/etcd/server.crt \
  --key=/etc/kubernetes/pki/etcd/server.key \
  --cacert=/etc/kubernetes/pki/etcd/ca.crt \
  member list

限制 etcd 集群的访问

配置安全通信后，使用 TLS 身份验证将 etcd 集群的访问限制为仅 Kubernetes API 服务器。

例如，考虑由 CA etcd.ca 信任的密钥对 k8sclient.key 和 k8sclient.cert。当 etcd 使用 --client-cert-auth 连同 TLS 配置时，它会使用系统 CA 或 --trusted-ca-file 标志传递的 CA 验证客户端的证书。指定标志 --client-cert-auth=true 和 --trusted-ca-file=etcd.ca 将限制对具有证书 k8sclient.cert 的客户端的访问。

正确配置 etcd 后，只有具有有效证书的客户端才能访问它。为了让 Kubernetes API 服务器访问，使用标志 --etcd-certfile=k8sclient.cert、--etcd-keyfile=k8sclient.key 和 --etcd-cafile=ca.cert 配置它们。

替换失败的 etcd 成员

etcd 集群通过容忍轻微的成员故障来实现高可用性。但是，为了提高集群的整体健康状况，请立即替换失败的成员。当多个成员失败时，请逐个替换它们。替换失败的成员涉及两个步骤：删除失败的成员和添加新成员。

虽然 etcd 内部保留唯一的成员 ID，但建议为每个成员使用唯一的名称以避免人为错误。例如，考虑一个三成员 etcd 集群。让 URL 为 member1=http://10.0.0.1、member2=http://10.0.0.2 和 member3=http://10.0.0.3。当 member1 失败时，将其替换为 member4=http://10.0.0.4。

1. 获取失败的 member1 的成员 ID

   etcdctl --endpoints=http://10.0.0.2,http://10.0.0.3 member list
   

   显示以下消息

   8211f1d0f64f3269, started, member1, http://10.0.0.1:2380, http://10.0.0.1:2379
   91bc3c398fb3c146, started, member2, http://10.0.0.2:2380, http://10.0.0.2:2379
   fd422379fda50e48, started, member3, http://10.0.0.3:2380, http://10.0.0.3:2379
   

2. 执行以下操作之一

   1. 如果每个 Kubernetes API 服务器都配置为与所有 etcd 成员通信，请从 --etcd-servers 标志中删除失败的成员，然后重新启动每个 Kubernetes API 服务器。
   2. 如果每个 Kubernetes API 服务器与单个 etcd 成员通信，则停止与失败的 etcd 通信的 Kubernetes API 服务器。

3. 停止损坏节点上的 etcd 服务器。其他客户端（除了 Kubernetes API 服务器）可能正在导致 etcd 流量，并且希望停止所有流量以防止写入数据目录。

4. 删除失败的成员

   etcdctl member remove 8211f1d0f64f3269
   

   显示以下消息

   Removed member 8211f1d0f64f3269 from cluster
   

5. 添加新成员

   etcdctl member add member4 --peer-urls=http://10.0.0.4:2380
   

   显示以下消息

   Member 2be1eb8f84b7f63e added to cluster ef37ad9dc622a7c4
   

6. 在新 IP 10.0.0.4 的机器上启动新添加的成员

   export ETCD_NAME="member4"
   export ETCD_INITIAL_CLUSTER="member2=http://10.0.0.2:2380,member3=http://10.0.0.3:2380,member4=http://10.0.0.4:2380"
   export ETCD_INITIAL_CLUSTER_STATE=existing
   etcd [flags]
   

7. 执行以下操作之一

   1. 如果每个 Kubernetes API 服务器都配置为与所有 etcd 成员通信，请将新添加的成员添加到 --etcd-servers 标志，然后重新启动每个 Kubernetes API 服务器。
   2. 如果每个 Kubernetes API 服务器与单个 etcd 成员通信，请启动在步骤 2 中停止的 Kubernetes API 服务器。然后配置 Kubernetes API 服务器客户端，再次将请求路由到已停止的 Kubernetes API 服务器。这通常可以通过配置负载均衡器来完成。

有关集群重新配置的更多信息，请参阅 etcd 重新配置文档。

备份 etcd 集群

所有 Kubernetes 对象都存储在 etcd 中。定期备份 etcd 集群数据对于在灾难场景下恢复 Kubernetes 集群至关重要，例如丢失所有控制平面节点。快照文件包含所有 Kubernetes 状态和关键信息。为了确保敏感的 Kubernetes 数据安全，请加密快照文件。

备份 etcd 集群可以通过两种方式完成：etcd 内置快照和卷快照。

内置快照

etcd 支持内置快照。快照可以从实时成员使用 etcdctl snapshot save 命令创建，也可以通过复制 etcd 数据目录 中的 member/snap/db 文件来创建，该目录当前未被 etcd 进程使用。创建快照不会影响成员的性能。

以下是创建由 $ENDPOINT 服务提供的键空间的快照到文件 snapshot.db 的示例

ETCDCTL_API=3 etcdctl --endpoints $ENDPOINT snapshot save snapshot.db

验证快照

• 使用 etcdutl
• 使用 etcdctl (已弃用)

etcdutl --write-out=table snapshot status snapshot.db 

+----------+----------+------------+------------+
|   HASH   | REVISION | TOTAL KEYS | TOTAL SIZE |
+----------+----------+------------+------------+
| fe01cf57 |       10 |          7 | 2.1 MB     |
+----------+----------+------------+------------+

export ETCDCTL_API=3
etcdctl --write-out=table snapshot status snapshot.db

Deprecated: Use `etcdutl snapshot status` instead.

+----------+----------+------------+------------+
|   HASH   | REVISION | TOTAL KEYS | TOTAL SIZE |
+----------+----------+------------+------------+
| fe01cf57 |       10 |          7 | 2.1 MB     |
+----------+----------+------------+------------+

卷快照

如果 etcd 正在运行在支持备份的存储卷上，例如 Amazon Elastic Block Store，则通过创建存储卷的快照来备份 etcd 数据。

使用 etcdctl 选项创建快照

我们还可以使用 etcdctl 提供的各种选项来创建快照。例如

ETCDCTL_API=3 etcdctl -h 

将列出 etcdctl 可用的各种选项。例如，您可以指定端点、证书和密钥来创建快照，如下所示

ETCDCTL_API=3 etcdctl --endpoints=https://127.0.0.1:2379 \
  --cacert=<trusted-ca-file> --cert=<cert-file> --key=<key-file> \
  snapshot save <backup-file-location>

其中 trusted-ca-file、cert-file 和 key-file 可以从 etcd Pod 的描述中获得。

扩展 etcd 集群

扩展 etcd 集群通过牺牲性能来提高可用性。扩展不会增加集群性能或功能。一个普遍的规则是不扩展或缩减 etcd 集群。不要为 etcd 集群配置任何自动缩放组。强烈建议始终为生产 Kubernetes 集群运行静态的五成员 etcd 集群，无论其规模如何。

合理的扩展是将三成员集群升级到五成员集群，当需要更高的可靠性时。有关如何将成员添加到现有集群的信息，请参阅 etcd 重新配置文档。

恢复 etcd 集群

etcd 支持从 etcd 进程的 主版本号.次版本号 的快照中恢复。恢复来自 etcd 不同补丁版本的快照也受支持。恢复操作用于恢复失败集群的数据。

在开始恢复操作之前，必须存在一个快照文件。它可以是来自以前备份操作的快照文件，也可以是来自剩余的 数据目录 的快照文件。

• 使用 etcdutl
• 使用 etcdctl (已弃用)

etcdutl --data-dir <data-dir-location> snapshot restore snapshot.db

export ETCDCTL_API=3
etcdctl --data-dir <data-dir-location> snapshot restore snapshot.db

有关从快照文件恢复集群的更多信息和示例，请参阅 etcd 灾难恢复文档。

如果已恢复集群的访问 URL 已从之前的集群更改，则必须相应地重新配置 Kubernetes API 服务器。在这种情况下，使用标志 --etcd-servers=$NEW_ETCD_CLUSTER 而不是标志 --etcd-servers=$OLD_ETCD_CLUSTER 重新启动 Kubernetes API 服务器。将 $NEW_ETCD_CLUSTER 和 $OLD_ETCD_CLUSTER 替换为相应的 IP 地址。如果 etcd 集群前面使用负载均衡器，则可能需要更新负载均衡器。

如果大多数 etcd 成员永久性地失败，则 etcd 集群被认为已失败。在这种情况下，Kubernetes 无法对其当前状态进行任何更改。虽然计划的 Pod 可能会继续运行，但无法调度新的 Pod。在这种情况下，恢复 etcd 集群并可能重新配置 Kubernetes API 服务器以解决问题。

升级 etcd 集群

有关 etcd 升级的详细信息，请参阅 etcd 升级 文档。

维护 etcd 集群

有关 etcd 维护的更多详细信息，请参阅 etcd 维护 文档。

集群碎片整理

碎片整理是一项代价高昂的操作，因此应尽可能不频繁地执行。另一方面，也有必要确保任何 etcd 成员都不会超过存储配额。Kubernetes 项目建议，在执行碎片整理时，使用诸如 etcd-defrag 之类的工具。

您还可以将碎片整理工具作为 Kubernetes CronJob 运行，以确保定期进行碎片整理。有关详细信息，请参阅 etcd-defrag-cronjob.yaml。