Skip to content

An etcd operator to configure, provision, reconcile and monitor etcd clusters.

License

Notifications You must be signed in to change notification settings

gardener/etcd-druid

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:

    • Potentially minimize the recovery time by leveraging restoration from backups followed by etcd's compaction and defragmentation.
    • Indirectly assert integrity of the backed up snaphots.
  • 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.

getting-started.mp4

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.