Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Manage snapshot repositories page #422

Merged
merged 25 commits into from
Feb 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
ec41cce
Adds Manage snapshot repositories page
kosabogi Feb 12, 2025
9f10ef8
Fixes link
kosabogi Feb 12, 2025
44b5064
Merge branch 'main' into adds-manage-repositories-page
kosabogi Feb 12, 2025
ec3c453
Fix link
kosabogi Feb 12, 2025
b357dde
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
f08f571
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
b1c19a5
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
d1e7839
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
eef0ad5
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
53b255d
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
e572955
Adds ECK to self-managed
kosabogi Feb 13, 2025
3b68ab6
Merge branch 'main' into adds-manage-repositories-page
kosabogi Feb 13, 2025
436e162
Merge branch 'main' into adds-manage-repositories-page
kosabogi Feb 13, 2025
97ba045
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
87eb23a
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
0f2ff48
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
dbf307b
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
977cac0
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 13, 2025
b056d73
Merge branch 'main' into adds-manage-repositories-page
kosabogi Feb 13, 2025
3e43f96
Adds applies-to tag and reorders deployment types
kosabogi Feb 13, 2025
cf11a39
Merge branch 'main' into adds-manage-repositories-page
kosabogi Feb 13, 2025
12d11c6
Fixes applies-to
kosabogi Feb 14, 2025
d65f867
Update deploy-manage/tools/snapshot-and-restore/manage-snapshot-repos…
kosabogi Feb 17, 2025
4e8c6f8
Merge branch 'main' into adds-manage-repositories-page
kosabogi Feb 17, 2025
4977bae
Merge branch 'main' into adds-manage-repositories-page
eedugon Feb 17, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions deploy-manage/tools/snapshot-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ mapped_urls:
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-snapshot-restore.html
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-restoring-snapshots.html
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-snapshots.html

applies:
stack: all
hosted: all
ece: all
eck: all

---

# Snapshot and restore
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,75 @@
---

applies:
stack: all
hosted: all
ece: all
eck: all

---

# Manage snapshot repositories

% What needs to be done: Write from scratch

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

% Scope notes: Landing page for this containing links for Cloud and ECE
% Scope notes: Landing page for this containing links for Cloud and ECE

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.

## Supported repository types

### Self-managed

If you manage your own Elasticsearch cluster, you can use the following built-in snapshot repository types:

* [Azure](/deploy-manage/tools/snapshot-and-restore/azure-repository.md)
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository.md)
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/s3-repository.md)
* [Shared file system](/deploy-manage/tools/snapshot-and-restore/shared-file-system-repository.md)
* [Read-only URL](/deploy-manage/tools/snapshot-and-restore/read-only-url-repository.md)
* [Source-only](/deploy-manage/tools/snapshot-and-restore/source-only-repository.md)

Other repository types are available through official plugins:

* [Hadoop Distributed File System (HDFS)](https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html)

### Elastic Cloud Hosted

{{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.

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.

Elastic Cloud Hosted deployments also support the following repository types:

* [Azure](/deploy-manage/tools/snapshot-and-restore/ec-azure-snapshotting.md)
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/ec-gcs-snapshotting.md)
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/ec-aws-custom-repository.md)
* [Source-only](/deploy-manage/tools/snapshot-and-restore/source-only-repository.md)

For more details, refer to [Managing snapshot repositories in Elastic Cloud Hosted](/deploy-manage/tools/snapshot-and-restore/elastic-cloud-hosted.md).

### Elastic Cloud Enterprise (ECE)

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.

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.

Elastic Cloud Enterprise installations support the following Elasticsearch snapshot repository types:

* [Azure](/deploy-manage/tools/snapshot-and-restore/azure-storage-repository.md)
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-gcs-repository.md)
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/minio-on-premise-repository.md)

:::{note}
No repository types other than those listed are supported in the Elastic Cloud Enterprise platform, even if they are supported by Elasticsearch.
:::

For more details, refer to [Managing snapshot repositories in Elastic Cloud Enterprise](/deploy-manage/tools/snapshot-and-restore/cloud-enterprise.md).

### Elastic Cloud on Kubernetes (ECK)

{{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.

For more information and examples, refer to [create automated snapshots on ECK](/deploy-manage/tools/snapshot-and-restore/cloud-on-k8s.md).
Loading