Skip to content

Document snapshot repositories at deployment level on ECE #4611

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.

Sign up for GitHub

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

Open
eedugon wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −0
Open

Document snapshot repositories at deployment level on ECE #4611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions deploy-manage/tools/snapshot-and-restore/_snippets/ece_ech_custom_repo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:::{note}
This procedure can be used for both {{ech}} and {{ece}} deployments to register a snapshot repository directly at the deployment level. This is useful when you need a deployment-specific repository that operates independently of the platform-managed automatic snapshots (`found-snapshots`), for example for [searchable snapshots](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md) or custom backup use cases.
:::
12 changes: 12 additions & 0 deletions deploy-manage/tools/snapshot-and-restore/cloud-enterprise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@

When a repository is assigned to a deployment, a snapshot is taken every 30 minutes by default. The snapshot interval can be adjusted per deployment.

::::{note}
This section focuses on configuring snapshot repositories at the ECE platform level. These repositories are assigned to deployments and are used by the ECE platform to automatically manage snapshots through the `found-snapshots` repository.

In addition to platform-managed repositories, you can also configure snapshot repositories directly at the deployment level for custom requirements or deployment-specific use cases. This approach is useful when you need snapshots that are independent of the ECE-managed automation.

Check notice on line 21 in deploy-manage/tools/snapshot-and-restore/cloud-enterprise.md

View workflow job for this annotation

GitHub Actions / preview / vale 

Elastic.Wordiness: Consider using 'also' instead of 'In addition'.

To register snapshot repositories in ECE directly at the deployment level, follow the guides written for {{ech}}, which are also applicable to ECE deployments:

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

## Supported repository types

{{ece}} installations support the following {{es}} snapshot repository types:
Expand Down
3 changes: 3 additions & 0 deletions deploy-manage/tools/snapshot-and-restore/ec-aws-custom-repository.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ mapped_pages:
applies_to:
deployment:
ess:
ece:
products:
- id: cloud-hosted
navigation_title: AWS S3
Copy link
Collaborator

@shainaraskas shainaraskas Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's change the title - {{ech}} s/b ECH and ECE

Expand All @@ -15,6 +16,8 @@ navigation_title: AWS S3

Configure a custom snapshot repository using an S3 storage bucket in your AWS account.

::::{include} _snippets/ece_ech_custom_repo.md
::::

## Prepare an S3 bucket [ec-prepare-aws-bucket]

Expand Down
3 changes: 3 additions & 0 deletions deploy-manage/tools/snapshot-and-restore/ec-azure-snapshotting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ mapped_pages:
applies_to:
deployment:
ess:
ece:
products:
- id: cloud-hosted
navigation_title: Azure Blob Storage
Expand All @@ -14,6 +15,8 @@ navigation_title: Azure Blob Storage

Configure a custom snapshot repository using your Azure Blob Storage account.

::::{include} _snippets/ece_ech_custom_repo.md
::::

## Prepare a container [ec-prepare-azure-container]

Expand Down
3 changes: 3 additions & 0 deletions deploy-manage/tools/snapshot-and-restore/ec-gcs-snapshotting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ mapped_pages:
applies_to:
deployment:
ess:
ece:
products:
- id: cloud-hosted
navigation_title: Google Cloud Storage
Expand All @@ -14,6 +15,8 @@ navigation_title: Google Cloud Storage

Configure a custom snapshot repository using your Google Cloud Storage account.

::::{include} _snippets/ece_ech_custom_repo.md
::::

## Set up your service account credentials [ec-gcs-service-account-key]

Expand Down
Loading