Operations guide

etcd installation, maintenance, and troubleshooting guides

Authentication Guides

Guide to etcd authentication and role-based access control

Configuration options

etcd configuration files, flags, and environment variables

Transport security model

Securing data in transit

Clustering Guide

Bootstrapping an etcd cluster: Static, etcd Discovery, and DNS Discovery

Run etcd clusters as a Kubernetes StatefulSet

Running etcd as a Kubernetes StatefulSet

Run etcd clusters inside containers

Running etcd with Docker using static bootstrapping

Failure modes

Kinds of failures and etcd’s tolerance for them

Disaster recovery

etcd v3 snapshot & restore facilities

etcd gateway

etcd gateway, when to use it, and how to set it up

gRPC proxy

A stateless etcd reverse proxy operating at the gRPC layer

Hardware recommendations

Hardware guidelines for administering etcd clusters

Maintenance

Periodic etcd cluster maintenance guide

Monitoring etcd

Monitoring etcd for system health & cluster debugging

Performance

Understanding performance: latency & throughput

Design of runtime reconfiguration

The design of etcd’s runtime reconfiguration commands

Runtime reconfiguration

etcd incremental runtime reconfiguration support

Supported platforms

etcd support for common architectures & operating systems

Versioning

Versioning support by etcd

Data Corruption

etcd data corruption and recovery

Last modified February 28, 2022: Create doc branch for v3.6 (9ed5c74)