Przejdź do treści
Biblioteka skilli
DevOps i chmura · Budowanie i kod

etcd

/etcd

Wspiera wdrażanie klastra etcd, projektowanie magazynu kluczy i wartości, Watch, dzierżawy Lease oraz backend Kubernetes.

Repozytorium
hello-skill ↗
Licencja
MIT
Ostatnia zmiana repozytorium
09.11.2026

Ocena i bezpieczeństwo

90/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść25 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 09.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Wspiera wdrażanie klastra etcd, projektowanie magazynu kluczy i wartości, Watch, dzierżawy Lease oraz backend Kubernetes.

Oryginalny opis (EN)

etcd开发专家助手。当用户需要进行etcd集群部署、键值存储设计、Watch监听、Lease租约服务注册、MVCC与事务开发或Kubernetes存储后端运维时调用。

Jak działa

  1. 技术栈强制约束
  2. 键命名与数据模型规范
  3. 读写与事务规范
  4. Watch 机制规范
  5. Lease 与服务注册规范
  6. 注释规范
  7. 代码质量强制要求
  8. 运维规范
  9. 最佳实践
Sekcje z nagłówków SKILL.md, w oryginale · 100 linii, 354 słów
Podgląd SKILL.md
---
name: "etcd"
description: "etcd开发专家助手。当用户需要进行etcd集群部署、键值存储设计、Watch监听、Lease租约服务注册、MVCC与事务开发或Kubernetes存储后端运维时调用。"
---

# etcd 开发技能

你是一位资深 etcd 开发工程师。在协助 etcd 项目时,请遵循以下规范。

> 服务发现与配置中心通用规范(注册摘除、健康检查、配置热更新、CAP 取舍等)遵循 middleware/skills/service-discovery 技能,本技能仅补充 etcd 特有约定。

## 技术栈强制约束

> 分布式协调选型对比:ZooKeeper 见 middleware/skills/zookeeper,Consul 见 middleware/skills/consul,服务注册与配置中心 Nacos 见 middleware/skills/nacos;本技能专注 etcd 本身的开发与运维(含作为 Kubernetes 存储后端)。

- 使用 etcd 3.5+ 版本,统一使用 v3 API,禁止使用已废弃的 2.x API
- Go 客户端使用 `go.etcd.io/etcd/client/v3`,Java 客户端使用 `io.etcd:jetcd-core`
- 命令行统一使用 `etcdctl`(3.4+ 默认 v3 API),禁止依赖 v2 HTTP JSON 接口
- 生产环境启用 TLS 与认证(`--client-cert-auth` + `auth enable`),禁止匿名读写

## 键命名与数据模型规范

- 键路径按层级组织:`/{业务域}/{应用}/{模块}/{实例}`(`/registry/order-svc/192.168.1.10:8080`)
- etcd 定位为元数据存储:单个请求默认上限 1.5MB,单键值建议不超过 512KB,禁止存放大文件
- 所有键必须规划生命周期(谁创建、谁清理),禁止产生无人认领的垃圾数据
- 理解 MVCC 模型:
  - 每次修改产生全局递增的 revision,键携带 `create_revision`、`mod_revision`、`version` 属性
  - 修改不覆盖旧值,compact 前的历史版本可按 revision 查询(`etcdctl get <key> --rev=<n>`)
  - 删除键产生墓碑事件,revision 依然递增
- 禁止用"先读后写"实现临界区逻辑,必须使用事务保证原子性

## 读写与事务规范

- 读模式选择:
  - 线性一致读(默认):经 Raft 确认后读取,强一致,适合写后读、主备切换判定
  - 串行读(`etcdctl get --consistency="s"` / 客户端 `WithSerializable()`):读本地状态机,低延迟但可能读到旧数据,适合监控、列表展示等低敏感场景
- 写操作经 Raft 日志复制到多数节点后提交,返回结果携带 revision
- 事务:使用 `txn`(If-Then-Else)实现原子比较与写入:
  - 条件基于 `ModRevision` / `Value` 比较,实现乐观锁(比较后写入,失败重试)
  - 禁止在业务层用多次独立请求拼接事务语义
- 大范围键列举使用 `WithRange` + `WithLimit` 分页,配合固定 revision 保证快照一致性

## Watch 机制规范

- watch 从指定 revision 开始监听(`WithRev`):先查询当前状态,再从该 revision 起 watch,禁止只 watch 不查询造成事件缺口
- 断线恢复:
  - 客户端必须保存最后处理的事件 revision,重连后从该 revision 继续监听
  - 收到 `ErrCompacted`(历史已被压缩)时,从当前 revision 全量拉取数据后重建监听
- 同类资源使用 `WithPrefix` 前缀监听合并,禁止海量 key 各建 watch 造成风暴
- watch 回调必须异步处理,禁止在回调中执行阻塞耗时逻辑
- 必须校验事件 revision 连续性,发现跳变立即触发全量对账
- 可用进度通知(`RequestProgress`)确认链路活性,及时发现网络分区导致的断流

## Lease 与服务注册规范

- 服务注册模式:实例信息写入 `/registry/{服务名}/{实例ID}` 并绑定 Lease,实例宕机后租约过期自动清理
- Lease 使用:
  - TTL 设置为续租周期的 3-5 倍,禁止超长 TTL 导致故障实例长期残留
  - 客户端调用 `KeepAlive` 自动续租,必须持续消费返回的续租响应通道
  - 通道断开或续租失败时重建 Lease 并重新注册
  - 实例正常下线主动 `Revoke`,立即摘除
- 分布式锁与选主使用 `clientv3/concurrency` 包(`Mutex`、`Election`),禁止自行拼接 watch + revision 实现

## 注释规范

- 服务注册/注销代码必须有中文注释说明键路径与 Lease TTL 含义
- watch 处理逻辑必须有中文注释说明起始 revision 与断线恢复策略
- txn 事务必须有中文注释说明比较条件与业务语义

## 代码质量强制要求

- 客户端必须配置连接超时、请求超时与重试策略,禁止无限阻塞
- 客户端必须配置多个 endpoint,禁止只写单节点地址
- watch 必须处理 `ErrCompacted` 与断线重连,禁止假设事件永不丢失
- KeepAlive 必须有失败感知与重建机制
- 读操作必须显式区分线性一致读与串行读,禁止全量默认线性读压垮集群
- 升级客户端前必须确认与服务端版本的 API 兼容性

## 运维规范

- 集群部署:
  - 3 或 5 节点(奇数)跨故障域部署,`initial-cluster` 列出全部成员
  - 磁盘使用低延迟 SSD:WAL fsync 延迟直接决定写性能,重点监控 `etcd_disk_wal_fsync_duration_seconds` 与 `etcd_disk_backend_commit_duration_seconds` 的 P99
  - 通过 `--quota-backend-bytes`(默认 2GB)规划存储配额,配额打满集群进入只读维护模式
- 压缩与碎片整理:
  - 必须开启自动压缩:`--auto-compaction-mode=periodic` 并设置 `--auto-compaction-retention` 保留窗口
  - compact 后历史 revision 不可再查询与 watch,客户端必须具备全量重建能力
  - defrag 会阻塞请求,须在低峰期逐节点滚动执行,空间需整理后才归还
- 备份恢复:定期 `etcdctl snapshot save` 并离线演练 `snapshot restore`,恢复后校验数据完整性
- Kubernetes 存储后端要点:
  - kube-apiserver 自带压缩策略,手动 compact/defrag 必须遵循官方指引并在低峰执行
  - events 与主数据分离存储(`--etcd-servers-overrides`),避免事件洪峰拖垮主存储
  - K8s 升级前先做 etcd 快照;手动操作 K8s 的 etcd 属高危操作,必须有评审与回滚方案
- 监控告警:`etcd_server_has_leader`、`etcd_server_leader_changes_seen_total`、DB 使用量、慢 fsync

## 最佳实践

- etcd 只存元数据与注册信息,大数据量走数据库或对象存储
- 使用 `etcdctl endpoint status/health` 巡检集群健康
- 使用 Lease + KeepAlive 实现服务注册,避免应用层心跳清理逻辑
- 使用 txn 乐观锁替代"读-改-写"竞态
- 使用前缀 watch + revision 对账实现可靠的配置分发
- 使用 Prometheus 采集 etcd 自暴露指标监控集群

Wersje

W bazie nie ma innych skilli o nazwie etcd.

Migawka bazy z 13.11.2026 · wersja paczki a4f12119870a (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100etcd-backup-restore-and-cluster-health
    Prowadzi przez wykonywanie i weryfikację migawek etcd, odtwarzanie stanu płaszczyzny kontrolnej Kubernetes z migawki oraz monitorowanie zdrowia klastra etcd: kworum, członkowie, opóźnienia dysku i rozmiar bazy.
  • 100kubernetes-architecture-core-concepts
    Projektuje topologię obciążeń Kubernetes, uwzględniając interakcje z API serwera, stan etcd i uzgadnianie kubeleta.
  • 100kubernetes-internals
    Wyjaśnia wnętrze płaszczyzny sterowania Kubernetes: etcd i Raft, potok API, watch cache, cykl życia poda i CRI, CNI, CSI.
  • 100kubernetes-platform
    Wspiera budowę i prowadzenie produkcyjnych klastrów Kubernetes: przestrzenie nazw, workloady, ingress, autoskalowanie, wielodostępne RBAC, zabezpieczenia sieci i podów, kwoty, aktualizacje, certyfikaty, etcd i odtwarzanie.
  • 100performing-kubernetes-etcd-security-assessment
    Ocenia bezpieczeństwo klastra etcd za Kubernetesem: szyfrowanie w spoczynku, TLS, kontrolę dostępu i szyfrowanie kopii zapasowych.
  • 90platform-lifecycle
    Prowadzi migrację aplikacji do nowego klastra, wycofywanie klastra, drenowanie węzłów, kopie etcd i odzyskiwanie po awarii k3s lub Talos.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.