그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그 그

  2 minute read  

etcd-druid

REUSE status CI Build status Go Report Card License: Apache-2.0 Release Go Reference

etcd-druid is an etcd operator which makes it easy to configure, provision, reconcile and monitor etcd clusters. It enables management of an etcd cluster through declarative Kubernetes API model.

In every etcd cluster managed by etcd-druid, each etcd member is a two container Pod which consists of:

  • etcd-wrapper which manages the lifecycle (validation & initialization) of an etcd.
  • etcd-backup-restore sidecar which currently provides the following capabilities (the list is not comprehensive):
    • etcd DB validation.
    • Scheduled etcd DB defragmentation.
    • Backup - etcd DB snapshots are taken regularly and backed in an object store if one is configured.
    • Restoration - In case of a DB corruption for a single-member cluster it helps in restoring from latest set of snapshots (full & delta).
    • Member control operations.

etcd-druid additional provides the following capabilities:

  • Facilitates declarative scale-out of etcd clusters.

  • Provides protection against accidental deletion/mutation of resources provisioned as part of an etcd cluster.

  • Offers an asynchronous and threshold based capability to process backed up snapshots to:

  • Allows seamless copy of backups between any two object store buckets.

Start using or developing etcd-druid locally

If you are looking to try out druid then you can use a Kind cluster based setup.

https://github.com/user-attachments/assets/cfe0d891-f709-4d7f-b975-4300c6de67e4

For detailed documentation, see our /docs folder. Please find the index here.

Contributions

If you wish to contribute then please see our guidelines.

Feedback and Support

We always look forward to active community engagement. Please report bugs or suggestions on how we can enhance etcd-druid on GitHub Issues.

License

Release under Apache-2.0 license.


API Reference

Relevant for: Developers

01 Multi Node Etcd Clusters

Relevant for:

02 Snapshot Compaction

Relevant for:

03 Scaling Up An Etcd Cluster

Relevant for:

Cli Flags

Relevant for:

Controllers

Relevant for:

DEP Title

Relevant for:

Etcd Druid

Relevant for:

etcd Network Latency

Relevant for: Developers

EtcdMember Custom Resource

Relevant for:

Feature Gates in Etcd-Druid

Relevant for:

Getting Started Locally

Relevant for: Developers

Getting Started Locally Azurite

Relevant for: Developers

Getting Started Locally Localstack

Relevant for: Developers

Local e2e Tests

Relevant for: Developers

Metrics

Relevant for: Operators

operator out-of-band tasks

Relevant for:

Recovery From Permanent Quorum Loss In Etcd Cluster

Relevant for: Operators

Restoring Single Member In Multi Node Etcd Cluster

Relevant for: Operators

Supported K8s Versions

Relevant for: Users

Testing

Relevant for: Developers

Webhooks

Relevant for: