---
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/actions
---

# 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)

* [create-backup](https://charmhub.io/charmed-etcd/actions#create-backup)
* [force-refresh-start](https://charmhub.io/charmed-etcd/actions#force-refresh-start)
* [list-backups](https://charmhub.io/charmed-etcd/actions#list-backups)
* [pre-refresh-check](https://charmhub.io/charmed-etcd/actions#pre-refresh-check)
* [rebuild-cluster](https://charmhub.io/charmed-etcd/actions#rebuild-cluster)
* [restore](https://charmhub.io/charmed-etcd/actions#restore)
* [resume-refresh](https://charmhub.io/charmed-etcd/actions#resume-refresh)
* [status-detail](https://charmhub.io/charmed-etcd/actions#status-detail)

[Learn about actions >](https://juju.is/docs/juju/action)

* create-backup

  Create a database backup and send it to an object storage. S3 credentials are retrieved from a relation with the S3 integrator charm.
* force-refresh-start

  Potential of data loss and downtime

  Force refresh of first unit

  Must run with at least one of the parameters `=false`

  Params

  + check-compatibility
    boolean

    Potential of data loss and downtime

    If `false`, force refresh if new version of etcd and/or charm is not compatible with previous version
  + check-workload-container
    boolean

    Potential of data loss and downtime during and after refresh

    If `false`, allow refresh to etcd container version that has not been validated to work with the charm revision
  + run-pre-refresh-checks
    boolean

    Potential of data loss and downtime

    If `false`, force refresh if app is unhealthy or not ready to refresh (and unit status shows "Pre-refresh check failed")
* list-backups

  List database backups. S3 credentials are retrieved from a relation with the S3 integrator charm.
* pre-refresh-check

  Check if charm is ready to refresh
* rebuild-cluster

  Stop the cluster and rebuild the cluster membership configuration. This action induces a downtime if executed on a running cluster. It should only be used to recover from majority failure, and it must be run on the Juju leader. The cluster will be initialised with new membership configuration, based on the current Juju units at runtime.

  Params

  + force
    boolean

    Force the rebuild of a cluster even if the majority was not lost.
* restore

  Restore a database backup from object storage. S3 credentials are retrieved from a relation with the S3 integrator charm.

  Params

  + backup-id
    string

    A backup-id to identify the backup to restore. Format of <%Y-%m-%dT%H:%M:%SZ>
* resume-refresh

  Refresh next unit(s) (after you have manually verified that refreshed units are healthy)

  If the `pause-after-unit-refresh` config is set to `all`, this action will refresh the next unit.

  If `pause-after-unit-refresh` is set to `first`, this action will refresh all remaining units.

  Exception: if automatic health checks fail after a unit has refreshed, the refresh will pause.

  If `pause-after-unit-refresh` is set to `none`, this action will have no effect unless it is called with `check-health-of-refreshed-units` as `false`.

  Params

  + check-health-of-refreshed-units
    boolean

    Potential of data loss and downtime

    If `false`, force refresh (of next unit) if 1 or more refreshed units are unhealthy

    Warning: if first unit to refresh is unhealthy, consider running `force-refresh-start` action on that unit instead of using this parameter.
    If first unit to refresh is unhealthy because compatibility checks, pre-refresh checks, or workload container checks are failing, this parameter is more destructive than the `force-refresh-start` action.
* status-detail

  Gets statuses of the charm

  Params

  + recompute
    boolean

    a boolean indicating whether a unit should recompute all statuses.
