Skip to content

Commit 437e32a

Browse files
kosabogieedugon
andauthored
Adds Manage snapshot repositories page (#422)
This PR adds the **Manage snapshot repositories** overview page. --------- Co-authored-by: Edu González de la Herrán <[email protected]>
1 parent 3b62bc0 commit 437e32a

File tree

2 files changed

+76
-1
lines changed

2 files changed

+76
-1
lines changed

deploy-manage/tools/snapshot-and-restore.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ mapped_urls:
66
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-snapshot-restore.html
77
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-restoring-snapshots.html
88
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-snapshots.html
9+
10+
applies:
11+
stack: all
12+
hosted: all
13+
ece: all
14+
eck: all
15+
916
---
1017

1118
# Snapshot and restore
Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,75 @@
1+
---
2+
3+
applies:
4+
stack: all
5+
hosted: all
6+
ece: all
7+
eck: all
8+
9+
---
10+
111
# Manage snapshot repositories
212

313
% What needs to be done: Write from scratch
414

515
% GitHub issue: https://github.com/elastic/docs-projects/issues/343
616

7-
% Scope notes: Landing page for this containing links for Cloud and ECE
17+
% Scope notes: Landing page for this containing links for Cloud and ECE
18+
19+
Snapshot repositories allow you to back up and restore your Elasticsearch data efficiently. Whether you're using [{{ech}}](#elastic-cloud-hosted), [{{ece}} (ECE)](#elastic-cloud-enterprise-ece), [{{eck}} (ECK)](#elastic-cloud-on-kubernetes-eck), or managing your own [{{es}} cluster](#self-managed), configuring a snapshot repository ensures data security, long-term archiving, and seamless migration across environments.
20+
21+
## Supported repository types
22+
23+
### Self-managed
24+
25+
If you manage your own Elasticsearch cluster, you can use the following built-in snapshot repository types:
26+
27+
* [Azure](/deploy-manage/tools/snapshot-and-restore/azure-repository.md)
28+
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository.md)
29+
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/s3-repository.md)
30+
* [Shared file system](/deploy-manage/tools/snapshot-and-restore/shared-file-system-repository.md)
31+
* [Read-only URL](/deploy-manage/tools/snapshot-and-restore/read-only-url-repository.md)
32+
* [Source-only](/deploy-manage/tools/snapshot-and-restore/source-only-repository.md)
33+
34+
Other repository types are available through official plugins:
35+
36+
* [Hadoop Distributed File System (HDFS)](https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html)
37+
38+
### Elastic Cloud Hosted
39+
40+
{{ech}} deployments automatically register a repository named `found-snapshots` in {{es}} clusters. These repositories are used together with the `cloud-snapshot-policy` SLM policy to take periodic snapshots of your {{es}} clusters. You can also use the `found-snapshots` repository for your own [SLM policies](/deploy-manage/tools/snapshot-and-restore/create-snapshots.md#automate-snapshots-slm) or to store searchable snapshots.
41+
42+
The `found-snapshots` repository is specific to each deployment. However, you can restore snapshots from another deployment’s found-snapshots repository if the deployments are under the same account and in the same region.
43+
44+
Elastic Cloud Hosted deployments also support the following repository types:
45+
46+
* [Azure](/deploy-manage/tools/snapshot-and-restore/ec-azure-snapshotting.md)
47+
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/ec-gcs-snapshotting.md)
48+
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/ec-aws-custom-repository.md)
49+
* [Source-only](/deploy-manage/tools/snapshot-and-restore/source-only-repository.md)
50+
51+
For more details, refer to [Managing snapshot repositories in Elastic Cloud Hosted](/deploy-manage/tools/snapshot-and-restore/elastic-cloud-hosted.md).
52+
53+
### Elastic Cloud Enterprise (ECE)
54+
55+
Snapshot repositories are managed at the platform level in Elastic Cloud Enterprise (ECE) and can be associated with deployments as needed. ECE supports the creation and maintenance of multiple repositories, but each deployment can be linked to only one repository for automatic snapshots.
56+
57+
When a platform-level repository is associated with a deployment, the `found-snapshots` repository is added to the {{es}} cluster, and, similar to Elastic Cloud, a snapshot is taken every 30 minutes by default. The interval can be adjusted on per deployment basis.
58+
59+
Elastic Cloud Enterprise installations support the following Elasticsearch snapshot repository types:
60+
61+
* [Azure](/deploy-manage/tools/snapshot-and-restore/azure-storage-repository.md)
62+
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-gcs-repository.md)
63+
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/minio-on-premise-repository.md)
64+
65+
:::{note}
66+
No repository types other than those listed are supported in the Elastic Cloud Enterprise platform, even if they are supported by Elasticsearch.
67+
:::
68+
69+
For more details, refer to [Managing snapshot repositories in Elastic Cloud Enterprise](/deploy-manage/tools/snapshot-and-restore/cloud-enterprise.md).
70+
71+
### Elastic Cloud on Kubernetes (ECK)
72+
73+
{{es}} clusters deployed through ECK support the same type of deployments as self-managed {{es}} clusters. ECK does not currently provide any automation or functionality to facilitate the integration of snapshot repositores within the {{es}} clusters.
74+
75+
For more information and examples, refer to [create automated snapshots on ECK](/deploy-manage/tools/snapshot-and-restore/cloud-on-k8s.md).

0 commit comments

Comments
 (0)