为 Kubernetes 运行 etcd 集群

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

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

您可以在官方文档中找到有关 etcd 的详细信息。

准备工作

在按照此页面中的步骤部署、管理、备份或恢复 etcd 之前，您需要了解操作 etcd 集群的一般预期。有关更多上下文，请参阅etcd 文档。

关键细节包括

• 建议在生产环境中运行的最低 etcd 版本是 3.4.22+ 和 3.5.6+。

• 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 作为多节点集群运行，并定期对其进行备份。建议在生产环境中使用五成员集群。有关更多信息，请参阅常见问题解答文档。

当您使用 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-file=k8sclient.key 和 --cert-file=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。当使用 --client-cert-auth 和 TLS 配置 etcd 时，它会使用系统 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 数据目录（当前未被 etcd 进程使用）复制 member/snap/db 文件。创建快照不会影响成员的性能。

以下是为 $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。