2017-05-05 05:24:04 +00:00
|
|
|
---
|
2020-04-07 18:55:19 +00:00
|
|
|
layout: docs
|
|
|
|
|
page_title: Consul Enterprise Automated Backups
|
|
|
|
|
description: >-
|
|
|
|
|
Consul Enterprise provides a highly available service that manages taking
|
|
|
|
|
snapshots, rotation and sending backup files offsite to Amazon S3 (or
|
|
|
|
|
S3-compatible endpoints), Google Cloud Storage, or Azure Blob Storage.
|
2017-05-05 05:24:04 +00:00
|
|
|
---
|
|
|
|
|
|
2020-03-24 20:06:20 +00:00
|
|
|
# Automated Backups
|
2017-05-05 05:24:04 +00:00
|
|
|
|
2020-04-23 22:13:18 +00:00
|
|
|
<EnterpriseAlert>
|
2021-12-10 22:42:33 +00:00
|
|
|
This feature requires
|
|
|
|
|
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
|
|
|
|
|
Refer to the{' '}
|
2022-04-27 16:25:16 +00:00
|
|
|
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
|
2022-04-27 16:45:30 +00:00
|
|
|
{' '}for additional information.
|
2020-04-23 22:13:18 +00:00
|
|
|
</EnterpriseAlert>
|
|
|
|
|
|
|
|
|
|
Consul Enterprise enables you to run
|
2020-03-24 20:06:20 +00:00
|
|
|
the snapshot agent within your environment as a service (Systemd as an example)
|
2020-04-06 20:27:35 +00:00
|
|
|
or scheduled through other means. Once running, the snapshot agent service operates as a highly
|
|
|
|
|
available process that integrates with the snapshot API to automatically manage
|
|
|
|
|
taking snapshots, backup rotation, and sending backup files offsite to Amazon S3
|
2020-03-24 20:06:20 +00:00
|
|
|
(or another S3-compatible endpoint), Google Cloud Storage, or Azure Blob Storage.
|
|
|
|
|
|
2020-04-06 20:27:35 +00:00
|
|
|
This capability provides an enterprise solution for backup and restoring the state of Consul servers
|
|
|
|
|
within an environment in an automated manner. These snapshots are atomic and point-in-time. Consul
|
|
|
|
|
datacenter backups include (but are not limited to):
|
2020-03-24 20:06:20 +00:00
|
|
|
|
|
|
|
|
- Key/Value Store Entries
|
2020-04-06 20:27:35 +00:00
|
|
|
- Service Catalog Registrations
|
|
|
|
|
- Prepared Queries
|
2020-03-24 20:06:20 +00:00
|
|
|
- Sessions
|
|
|
|
|
- Access Control Lists (ACLs)
|
|
|
|
|
- Namespaces
|
|
|
|
|
|
2020-04-06 20:27:35 +00:00
|
|
|
For more experience leveraging Consul's snapshot functionality, we suggest you look through our HashiCorp
|
2020-08-13 21:02:44 +00:00
|
|
|
Learn tutorial for [Datacenter Backups in Consul](https://learn.hashicorp.com/tutorials/consul/backup-and-restore).
|
2020-04-06 20:27:35 +00:00
|
|
|
For detailed configuration information on configuring the Consul Enterprise's snapshot agent, review the
|
2020-10-14 15:23:05 +00:00
|
|
|
[Consul Snapshot Agent documentation](/commands/snapshot/agent).
|
