Beta Version
You're viewing documentation for version v1.1.0. Beta versions are subject to changes and may not represent the final stable release. Do not use in production environments.
etcd
The etcd integration takes snapshots of an etcd cluster and stores them in a Kloset store with encryption and deduplication.
| Connector type | Description |
|---|---|
| ✅ Source connector | Back up an etcd cluster into a Kloset store. |
Requirements
- Plakar v1.1.0-beta or later.
- Network access to at least one etcd node.
Typical use cases
- Disaster recovery for etcd clusters.
- Point-in-time snapshots of Kubernetes cluster state (for clusters using etcd as their backing store).
Installation
Note: Installing pre-built packages requires authentication with Plakar. See Login to Plakar to unlock features.
Install the etcd package:
$ plakar pkg add etcd
Verify the installation:
$ plakar pkg list
Prerequisites
- A working Go toolchain compatible with your version of Plakar.
Build and install the etcd package:
$ plakar pkg build etcd
$ plakar pkg add ./etcd_v1.1.0-beta_linux_amd64.ptar
Verify the installation:
$ plakar pkg list
To list, upgrade, or remove the package, see managing packages guide.
Source connector
The source connector connects to an etcd node, takes a snapshot of the cluster, and ingests it into a Kloset store.
etcd API" } Transform@{ shape: rect, label: "Encrypt & deduplicate" } Connector --> Transform end Source --> Connector Store@{ shape: cyl, label: "Kloset Store" } Transform --> Store classDef sourceBox fill:#ffe4e6,stroke:#cad5e2,stroke-width:1px classDef brandBox fill:#524cff,color:#ffffff classDef storeBox fill:#dbeafe,stroke:#cad5e2,stroke-width:1px class Source sourceBox class Plakar brandBox class Store storeBox linkStyle default stroke-dasharray: 9,5,stroke-dashoffset: 900,animation: dash 25s linear infinite;
Back up a cluster
Back up by connecting to a node over HTTP:
$ plakar backup etcd://node1:2379
Back up using HTTPS with authentication:
$ plakar backup -o username=myuser -o password=secret etcd+https://node1:2379
Back up by specifying multiple nodes:
$ plakar backup -o endpoints=http://node1:2379,http://node2:2379 etcd://
Options
| Option | Required | Description |
|---|---|---|
location |
Yes | etcd node address. Use etcd://, etcd+http://, or etcd+https:// followed by the hostname and optional port. |
endpoints |
No | Comma-separated list of node endpoints. Takes priority over location when set. |
username |
No | etcd username. |
password |
No | etcd password. |
Restoring
The etcd API does not support restoring a snapshot directly. To restore, first retrieve the snapshot from the Kloset store to disk, then use etcdutl to provision a new etcd data directory from it.
$ plakar at /var/backups restore -to ./etcd-snapshot <snapshot_id>
Then follow the upstream etcd recovery procedure to bring the cluster back up.
Refer to the etcd recovery documentation for full restore instructions.
See also
Found a bug or mistake in the documentation? Create an issue on GitHub