---
title: Charmhub | Deploy Charmed etcd using Charmhub - The Open Operator Collection
description: Deploy the latest version of Charmed etcd on any cloud.
url: https://charmhub.io/charmed-etcd/configurations
---

# Charmed etcd

[Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")

* [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")

Platform:

24.04

3.6/stable 182

```
juju deploy charmed-etcd --channel 3.6/stable
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

* [auto-compaction-mode](https://charmhub.io/charmed-etcd/configurations#auto-compaction-mode)
* [auto-compaction-retention](https://charmhub.io/charmed-etcd/configurations#auto-compaction-retention)
* [certificate-extra-sans](https://charmhub.io/charmed-etcd/configurations#certificate-extra-sans)
* [client-certificate-domain](https://charmhub.io/charmed-etcd/configurations#client-certificate-domain)
* [election-timeout](https://charmhub.io/charmed-etcd/configurations#election-timeout)
* [heartbeat-interval](https://charmhub.io/charmed-etcd/configurations#heartbeat-interval)
* [pause-after-unit-refresh](https://charmhub.io/charmed-etcd/configurations#pause-after-unit-refresh)
* [peer-certificate-domain](https://charmhub.io/charmed-etcd/configurations#peer-certificate-domain)
* [quota-backend-bytes](https://charmhub.io/charmed-etcd/configurations#quota-backend-bytes)
* [system-users](https://charmhub.io/charmed-etcd/configurations#system-users)
* [tls-client-private-key](https://charmhub.io/charmed-etcd/configurations#tls-client-private-key)
* [tls-peer-private-key](https://charmhub.io/charmed-etcd/configurations#tls-peer-private-key)

[Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration)

* auto-compaction-mode | string

  Default: periodic

  The compaction mode to apply on the etcd keyspace. The possible values are "periodic" or "revision";
  "periodic" for duration based retention, "revision" for revision number based retention.
* auto-compaction-retention | string

  Default: 1h

  Specifies how much history to keep when compacting the keyspace. Supported time units are "h"
  for hours or "m" for minutes in case of periodic compaction. If the compaction mode is set to
  "revision", this option defines how many revisions to keep.
* certificate-extra-sans | string

  Config options to add extra-sans to the ones used when requesting server certificates.
  The extra-sans are specified by comma-separated names to be added when requesting signed certificates.
  Use "{unit}" as a placeholder to be filled with the unit number, e.g. "worker-{unit}" will be translated as
  "worker-0" for unit 0 and "worker-1" for unit 1 when requesting the certificate.
* client-certificate-domain | string

  Config option to specify a domain to be added to the common names in certificate signing requests
  for client certificates. Example: "mydomain.com". This must match the allowed domains from the TLS provider.
  In the case of Vault, this should be set to one of the domains configured in "pki\_allowed\_domains".
* election-timeout | int

  Default: 1000

  How long, in milliseconds, a follower node will go without hearing a heartbeat before attempting to become leader itself. The value should be at least 10x the value of <heartbeat-interval>, and must not exceed 50000.
* heartbeat-interval | int

  Default: 100

  The frequency, in milliseconds, with which the leader will notify followers that it is still the leader. For best practices, the parameter should be set around round-trip time between members. The value must be between 10 and 5000 at most.
* pause-after-unit-refresh | string

  Default: first

  Wait for manual confirmation to resume refresh after these units refresh
  Allowed values: "all", "first", "none"
* peer-certificate-domain | string

  Config option to specify a domain to be added to the common names in certificate signing requests
  for peer server certificates. Example: "mydomain.com". This must match the allowed domains from the TLS
  provider. In the case of Vault, this should be set to one of the domains configured in "pki\_allowed\_domains".
* quota-backend-bytes | string

  Default: auto

  Sets the backend database size limit in bytes for each etcd member. When this limit is exceeded,
  the cluster raises a NOSPACE alarm and enters a read-only mode, rejecting all write requests.
  This value should be sized according to the cluster's workload and available RAM.
  The value needs to be `auto` or an integer representing the size in bytes.
  If value is set to 'auto' the formula used is min(100GiB, 0.9*memory, 0.9*data\_storage\_size)
  The community-recommended maximum is 8 GiB.
  A minimum of 100MiB is enforced.
  WARNING: The LXD 'dir' storage driver exposes the host's total disk space to containers, which
  can cause inaccurate quota calculations.
* system-users | secret

  Configure the internal system user and it's password. The password will
  be auto-generated if this option is not set. It is for internal use only
  and SHOULD NOT be used by applications. This needs to be a Juju Secret URI pointing
  to a secret that contains the following content: `root: <password>`.
* tls-client-private-key | secret

  A Juju secret URI of a secret containing the private key for client-to-server TLS certificates.
* tls-peer-private-key | secret

  A Juju secret URI of a secret containing the private key for peer-to-peer TLS certificates.