charts/bitnami/etcd

etcd

etcd is an object-relational database management system (ORDBMS) with an emphasis on extensibility and on standards-compliance.

TL;DR;

$ helm install bitnami/etcd

Introduction

This chart bootstraps a etcd deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

• Kubernetes 1.4+ with Beta APIs enabled
• PV provisioner support in the underlying infrastructure

Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release bitnami/etcd

The command deploys etcd on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following tables lists the configurable parameters of the etcd chart and their default values.

Parameter	Description	Default
image.registry	etcd image registry	docker.io
image.repository	etcd Image name	bitnami/etcd
image.tag	etcd Image tag	{VERSION}
image.pullPolicy	etcd image pull policy	Always
image.pullSecrets	Specify image pull secrets	nil (does not add image pull secrets to deployed pods)
image.debug	Specify if debug values should be set	false
statefulset.updateStrategy	Update strategy for the stateful set	RollingUpdate
statefulset.rollingUpdatePartition	Partition for Rolling Update strategy	nil
statefulset.podManagementPolicy	Pod management policy for the stateful set	OrderedReady
statefulset.replicaCount	Number of etcd nodes	1
useConfigmap	Switch to use the config map for etcd	false
allowNoneAuthentication	Allow to use etcd without configuring RBAC authentication	true
auth.rbac.enabled	Switch to enable the etcd authentication.	false
auth.rbac.rootPassword	Password for the root user	false
auth.rbac.existingSecret	Name of the existing secret containing the root password	false
auth.client.secureTransport	Switch to encrypt client communication using TLS certificates	false
auth.client.useAutoTLS	Switch to automatically create the TLS certificates	false
auth.client.enableAuthentication	Switch to enable host authentication using TLS certificates. Requires existing secret.	secret
auth.client.existingSecret	Name of the existing secret containing cert files for client communication.	nil
auth.peer.secureTransport	Switch to encrypt peer communication using TLS certificates	false
auth.peer.useAutoTLS	Switch to automatically create the TLS certificates	false
auth.peer.enableAuthentication	Switch to enable host authentication using TLS certificates. Requires existing secret.	false
auth.peer.existingSecret	Name of the existing secret containing cert files for peer communication.	nil
securityContext.enabled	Enable security context	true
securityContext.fsGroup	Group ID for the container	1001
securityContext.runAsUser	User ID for the container	1001
service.type	Kubernetes Service type	ClusterIP
service.port	etcd client port	2379
service.nodePort	Port to bind to for NodePort service type (client port)	nil
service.peerPort	etcd peer port	2380
service.peerNodePort	Port to bind to for NodePort service type (peer port)	nil
service.annotations	Annotations for etcd service	{}
service.loadBalancerIP	loadBalancerIP if etcd service type is LoadBalancer	nil
persistence.enabled	Enable persistence using PVC	true
persistence.storageClass	PVC Storage Class for etcd volume	nil
persistence.accessMode	PVC Access Mode for etcd volume	ReadWriteOnce
persistence.size	PVC Storage Request for etcd volume	8Gi
persistence.annotations	Annotations for the PVC	{}
nodeSelector	Node labels for pod assignment	{}
tolerations	Toleration labels for pod assignment	[]
resources	CPU/Memory resource requests/limits	Memory: 256Mi, CPU: 250m
livenessProbe.enabled	Turn on and off liveness probe	true
livenessProbe.initialDelaySeconds	Delay before liveness probe is initiated	10
livenessProbe.periodSeconds	How often to perform the probe	10
livenessProbe.timeoutSeconds	When the probe times out	5
livenessProbe.failureThreshold	Minimum consecutive failures for the probe to be considered failed after having succeeded.	2
livenessProbe.successThreshold	Minimum consecutive successes for the probe to be considered successful after having failed	1
readinessProbe.enabled	Turn on and off readiness probe	true
readinessProbe.initialDelaySeconds	Delay before liveness probe is initiated	5
readinessProbe.periodSeconds	How often to perform the probe	10
readinessProbe.timeoutSeconds	When the probe times out	5
readinessProbe.failureThreshold	Minimum consecutive failures for the probe to be considered failed after having succeeded.	6
readinessProbe.successThreshold	Minimum consecutive successes for the probe to be considered successful after having failed	1

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set auth.rootPassword=secretpassword bitnami/etcd

The above command sets the etcd etcd account password to secretpassword. Additionally it creates a database named my-database.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml bitnami/etcd

Tip

: You can use the default values.yaml

Production and horizontal scaling

The following repo contains the recommended production settings for etcd server in an alternative values file. Please read carefully the comments in the values-production.yaml file to set up your environment.

$ helm install --name my-release -f ./values-production.yaml bitnami/etcd

To horizontally scale this chart once it has been deployed:

$ kubectl scale statefulset my-etcd --replicas=5

Enable security for etcd

Configure RBAC

In order to enable Role-based access control for etcd you can run the following command:

$ helm install --name my-release --set auth.rbac.enabled --set auth.rbac.rootPassword=YOUR-PASSWORD bitnami/etcd

The previous command will deploy etcd creating a root user with its associate root role with access to everything. The rest of users will use the guest role and won't have permissions to do anything.

Configure certificated for peer communication

In order to enable secure transport between peer nodes deploy the helm chart with these options:

$ helm install --name my-release --set auth.peer.secureTransport=true --set auth.peer.useAutoTLS=true bitnami/etcd

Configure certificates for client comminication

In order to enable secure transport between client and server you have to create a secret containing the cert and key files and the CA used to sign those client certificates.

You can create that secret with this command:

$ kubectl create secret generic etcd-client-certs --from-file=ca.crt=path/to/ca.crt --from-file=cert.pem=path/to/cert.pem --from-file=key.pem=path/to/key.pem

Once the secret is created, you can deploy the helm chart with these options:

$ helm install --name my-release --set auth.client.secureTransport=true --set auth.client.enableAuthentication=true --set auth.client.existingSecret=etcd-client-certs bitnami/etcd

Ref: etcd security model

Ref: Generate self-signed certificagtes for etcd

Persistence

The Bitnami etcd image stores the etcd data at the /bitnami/etcd path of the container.

Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. See the Configuration section to configure the PVC or to disable persistence.