etcd

Raft-based distributed key-value store for coordination.

Provider: default
Kind: Coordination service
Category: Operations
Official docs: https://etcd.io/docs/

Properties · 3 set by this component

property	type	values	required	kind default	this component
authEnabled · component property	boolean	—	no	false	inherited
consensus	enum	none \| raft \| paxos \| zab	no	none	▸ raft
managed	boolean	—	no	false	▸ false
nodes	integer	—	no	—	inherited
replicated	boolean	—	no	false	inherited
role	enum	metadata \| lock \| discovery \| placement \| sharding \| leader-election \| config	yes	—	▸ metadata

Rules that apply · 2

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

Shared dependency without redundancyerror

shared-dependency-without-redundancy

The design requires redundant discovery, but this DNS or coordination service, which everything depends on, runs on a single provider or a single replica. Its failure is the whole system's failure.

— all of these hold:
— the design requirement `availability.discoveryRedundant` is true
— any of these hold:
— the node's `redundantProviders` is false
— the node's `replicated` is false

Stateful engine pinned to a single zoneerror

stateful-engine-pinned-to-single-zone

A matching engine, coordination service or event store living in exactly one availability zone, with no failover and no replication, is lost with that zone. Everything that depends on it stops with it.

— all of these hold:
— the node sits inside exactly 1 availability-zone group
— any of these hold:
— the node's `failover` is "none"
— the node's `replicated` is false
— the node's `replication` is "none"

Use it in a design

nodes:
  - { id: "etcd", component: "etcd" }

Other Coordination service products · 17

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# etcd: Raft key-value store for metadata and config; single member by default, auth off.
3schemaVersion: "1"
4type: "component"
5id: "etcd"
6kind: "coordination-service"
7provider: "default"
8docs: "https://etcd.io/docs/"
9defaults:
10  role: "metadata"
11  consensus: "raft"
12  managed: false
13properties:
14  authEnabled:
15    type: "boolean"
16    default: false

The same page as markdown, for an agent: /catalogue/components/etcd.md