How coreos/etcd works
etcd is a highly available distributed key-value store. The primary workflow is a user or application issuing requests through etcdctl or the Go client to a running member; members replicate state with Raft and serve reads and writes from the store. Major capabilities also include watches, leases, authentication, membership, maintenance and snapshots. The graph uses README statements and the supplied source excerpts; several internal subsystems are represented at directory level because their implementation was not sampled.
Main entry points: v3rpc gRPC API · server.go Etcd server · client.go Go client · raft.go Raft consensus
Components 20
Clients and tools
- etcdctl
etcdctl/ctlv3/command - Go client
client/v3/client.go - Watch cache
cache/cache.go
Serving and APIs
- Embedded startup
server/embed/etcd.go - gRPC API
server/etcdserver/api/v3rpc - API definitions
api/etcdserverpb/rpc.proto - Authentication
server/auth - Leases
server/lease - Watch API
server/etcdserver/api/v3rpc/watch.go - Maintenance API
server/etcdserver/api/v3rpc/maintenance.go
Cluster and consensus
- Etcd server
server/etcdserver/server.go - Raft consensus
server/etcdserver/raft.go - Cluster membership
server/etcdserver/api/membership - Peer transport
server/etcdserver/api/rafthttp
Persistence and state
- MVCC key-value
server/storage/mvcc - Storage backend
server/storage/backend - Raft WAL
server/storage/wal - Snapshots
server/etcdserver/api/snap
Other components
- Operator or app
- Peer members
Connections 20
- Operator or app → etcdctl: runs commands
README.md - Operator or app → Go client: uses API
README.md - etcdctl → Go client: issues requests
- Go client → Embedded startup: sends gRPC
README.md - Embedded startup → Etcd server: starts
server/embed/etcd.go - Etcd server → gRPC API: serves requests
- gRPC API → API definitions: implements
README.md - Etcd server → Raft consensus: replicates state
README.md - Raft consensus → Peer transport: exchanges messages
- Peer transport → Peer members: communicates
README.md - Etcd server → Cluster membership: manages members
- Etcd server → MVCC key-value: applies requests
- MVCC key-value → Storage backend: persists state
- Raft consensus → Raft WAL: persists log
- Etcd server → Snapshots: creates snapshots
- gRPC API → Authentication: authorizes requests
- gRPC API → Leases: serves lease calls
- gRPC API → Watch API: serves watches
- gRPC API → Maintenance API: serves maintenance
- Go client → Watch cache: backs cache
cache/cache.go