https://github.com/improbable-eng/etcd-cluster-operator

A controller to deploy and manage etcd clusters inside of Kubernetes
https://github.com/improbable-eng/etcd-cluster-operator

etcd kubernetes operator

Last synced: 5 months ago
JSON representation

A controller to deploy and manage etcd clusters inside of Kubernetes

• Host: GitHub
• URL: https://github.com/improbable-eng/etcd-cluster-operator
• Owner: improbable-eng
• License: mit
• Created: 2019-09-24T13:44:46.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-05T20:50:11.000Z (over 2 years ago)
• Last Synced: 2025-05-08T20:41:32.194Z (6 months ago)
• Topics: etcd, kubernetes, operator
• Language: Go
• Homepage:
• Size: 548 KB
• Stars: 129
• Watchers: 8
• Forks: 36
• Open Issues: 39
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Etcd Cluster Operator

![Go Report Card](https://goreportcard.com/badge/github.com/improbable-eng/etcd-cluster-operator)

[![Improbable Engineering](https://circleci.com/gh/improbable-eng/etcd-cluster-operator.svg?style=shield)](https://app.circleci.com/github/improbable-eng/etcd-cluster-operator/pipelines)

Etcd Cluster Operator is an [Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator) for automating

the creation and management of etcd inside of Kubernetes. It provides a

[custom resource definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources)

based API to define etcd clusters with Kubernetes resources, and enable management with native Kubernetes tooling.

## Quick Start

See the [installation instructions](docs/installing.md) for installing the operator to your Kubernetes cluster. If you

want to experiment with the operator, considering using [kind](https://github.com/kubernetes-sigs/kind) to run a local

cluster.

Once installed you can create an etcd cluster by using `kubectl` to apply an `EtcdCluster`.

```yaml

apiVersion: etcd.improbable.io/v1alpha1

kind: EtcdCluster

metadata:

  name: my-first-etcd-cluster

spec:

  replicas: 3

  version: 3.2.28

```

## Further Reading

* See the [operations guide](docs/operations.md) for full details on the options available and how to perform further

  tasks.

* See [design documentation](docs/design) for background reading.

* See the [release notes](docs/release-notes) for feature update information.

* See the [contributing guide](docs/contributing.md) for details on how to get involved.