Skip to main content

​
Overview

etcd is a distributed, reliable key-value store designed for the most critical data of a distributed system. It provides consistent coordination, service discovery, and configuration management across distributed systems, making it a common foundation for cluster health and orchestration. This template deploys an etcd cluster as a stateful workload with configurable replica count and persistent storage.

​
What Gets Created

  • Stateful Workload — An etcd cluster with a configurable number of replicas (default: 3).
  • Volume Set — Persistent storage for etcd data.
  • Secret — An opaque startup script secret that handles cluster initialization, peer URL configuration, and replica setup.
  • Identity & Policy — An identity bound to the workload with reveal access to the startup script secret.
This template does not create a GVC. You must deploy it into an existing GVC.

​
Installation

This template has no external prerequisites. To install, follow the instructions for your preferred method:

UI

Browse, install, and manage templates visually

CLI

Manage templates from your terminal

Terraform

Declare templates in your Terraform configurations

Pulumi

Declare templates in your Pulumi programs

​
Configuration

The default values.yaml for this template: 
replicas: 3 # minimum 3, must be odd

resources:
  cpu: 1
  memory: 2Gi

multiZone: false

volumeset:
  capacity: 10 # initial capacity in GiB (minimum is 10)

internal_access:
  type: same-gvc # options: same-gvc, same-org, workload-list
  workloads: # Note: can only be used if type is same-gvc or workload-list
    #- //gvc/GVC_NAME/workload/WORKLOAD_NAME

​
Replicas

  • replicas — Number of etcd instances in the cluster (minimum 3).
The replica count must always be an odd number. etcd uses the Raft consensus algorithm, which requires a majority quorum — an odd number of members ensures a quorum can always be reached and avoids split-brain scenarios.

​
Resources

  • resources.cpu / resources.memory — CPU and memory allocated to each etcd instance (default: 1 CPU, 2Gi). These can be lowered for lighter workloads. See the etcd hardware recommendations for guidance.

​
Storage

  • volumeset.capacity — Persistent volume size in GiB for etcd data (minimum 10).

​
Multi-Zone

  • multiZone — When true, distributes replicas equally across available zones for higher availability.
Not all locations support multi-zone deployments. Confirm that your target location supports multi-zone before enabling this option.

​
Internal Access

The internal_access section controls which workloads can reach the etcd cluster:
TypeDescription
same-gvcAllow access from all workloads in the same GVC
same-orgAllow access from all workloads in the same organization
workload-listAllow access only from specific workloads listed in workloads

​
External References

etcd Documentation

Official etcd documentation

Hardware Recommendations

etcd hardware and resource sizing guidelines

etcd Template

View the source files, default values, and chart definition