Skip to content

Commit 204f23c

Browse files
kosabogieedugonshainaraskas
authored
Updating the 'Snapshot and restore' section (#480)
This PR updates the whole Snapshot and restore section. The PR also includes refinements in the Cross-cluster replication section (but it is not completely ready yet). ### Main changes Restructured the Manage snapshot repositories section Added or refined the following pages: - [Self-managed](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/480/deploy-manage/tools/snapshot-and-restore/self-managed) - [Elastic Cloud Hosted](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/480/deploy-manage/tools/snapshot-and-restore/elastic-cloud-hosted) - [Elastic Cloud Enterprise](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/480/deploy-manage/tools/snapshot-and-restore/cloud-enterprise) - [Elastic Cloud on Kubernetes](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/480/deploy-manage/tools/snapshot-and-restore/cloud-on-k8s) - [Restore snapshots](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/480/deploy-manage/tools/snapshot-and-restore/restore-snapshot) --------- Co-authored-by: Edu González de la Herrán <[email protected]> Co-authored-by: shainaraskas <[email protected]>
1 parent 525d3a3 commit 204f23c

File tree

76 files changed

+1063
-614
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+1063
-614
lines changed

cloud-account/join-or-leave-an-organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ If you already belong to an organization, and you want to join a new one you wil
3535

3636
Alternatively, for Elastic Cloud Hosted deployments, there's a possibility to migrate your deployments to the new organization through back up and restore operations. In such case:
3737

38-
1. [Back up your deployments to any private repository](/deploy-manage/tools/snapshot-and-restore/ec-custom-repository.md) so that you can restore them to your new organization.
38+
1. [Back up your deployments to any private repository](/deploy-manage/tools/snapshot-and-restore/elastic-cloud-hosted.md) so that you can restore them to your new organization.
3939
2. Leave your current organization.
4040
3. Ask the administrator to invite you to the organization you want to join.
4141
4. Accept the invitation that you will get by email.

deploy-manage/deploy/cloud-enterprise/resize-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To resize a deployment:
2626
: If the initial deployment you created uses only one availability zone, it is not fault tolerant. On a production system, enable [high availability](ece-ha.md) by changing your deployment to use at least two availability zones, three for mission-critical deployments. The number of instances comes from the number of zones and the type of template. Having more nodes or instances lets you scale out horizontally by adding more processing capacity to your deployment.
2727

2828
::::{warning}
29-
Deployments that use only one availability zone are not highly available and are at risk of data loss, if you do not [configure an external snapshot repository](../../tools/snapshot-and-restore/cloud-enterprise.md#ece-manage-repositories-add) to enable regular backups. To safeguard against data loss, you must use at least two data centers and configure an external repository for backups.
29+
Deployments that use only one availability zone are not highly available and are at risk of data loss, if you do not [configure an external snapshot repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to enable regular backups. To safeguard against data loss, you must use at least two data centers and configure an external repository for backups.
3030
::::
3131

3232

deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ ECE lets you manage snapshot repositories, so that you can back up and restore y
4747

4848
As mentioned earlier, the `logging-and-metrics` cluster stores important information about your environment logs and metrics. There are also additional configurations provided out-of-the-box, such as data views (formerly *index patterns*), visualizations, and dashboards, that will require running an external script to recreate if you do not have a snapshot to restore from. We recommend that you also back up the `logging-and-metrics` cluster, though it is up to you to decide if that information should be available to be restored.
4949

50-
To configure snapshot repositories, check [Add snapshot repository configurations](../../tools/snapshot-and-restore/cloud-enterprise.md#ece-manage-repositories-add).
50+
To configure snapshot repositories, check [Add snapshot repository configurations](../../tools/snapshot-and-restore/cloud-enterprise.md).
5151

5252

5353
### Sizing [ece_sizing]

deploy-manage/deploy/elastic-cloud/ech-migrate-data-internal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To restore internal indices from a snapshot, the procedure is a bit different fr
3838
"snapshot": "scheduled-1527616008-instance-0000000004",
3939
```
4040
41-
3. To restore internal Elasticsearch indices, you need to register the snapshot repository in `read-only` mode. To do so, first add the authentication information for the repository to the Elasticsearch Add-On for Heroku keystore, following the steps for [AWS S3](../../tools/snapshot-and-restore/ech-aws-custom-repository.md#ech-snapshot-secrets-keystore), [Google Cloud Storage](../../tools/snapshot-and-restore/ech-gcs-snapshotting.md#ech-configure-gcs-keystore), or [Azure Blog storage](../../tools/snapshot-and-restore/ech-azure-snapshotting.md#ech-configure-azure-keystore).
41+
3. To restore internal Elasticsearch indices, you need to register the snapshot repository in `read-only` mode. To do so, first add the authentication information for the repository to the Elasticsearch Add-On for Heroku keystore, following the steps for [AWS S3](../../tools/snapshot-and-restore/ec-aws-custom-repository.md), [Google Cloud Storage](../../tools/snapshot-and-restore/ec-gcs-snapshotting.md), or [Azure Blog storage](../../tools/snapshot-and-restore/ec-azure-snapshotting.md).
4242
4. To register a read-only repository, open the Elasticsearch [API console](ech-api-console.md) or the Kibana [Dev Tools page](../../../explore-analyze/query-filter/tools.md) and run the [Read-only URL repository](../../tools/snapshot-and-restore/read-only-url-repository.md) API call.
4343
5. Once the repository has been registered and verified, you are ready to restore the internal indices to your new cluster, either all at once or individually.
4444

deploy-manage/deploy/elastic-cloud/ech-migrate-data2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ If you cannot connect to a remote index for whatever reason, such as if it’s i
134134
}
135135
```
136136

137-
3. From the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body) of the **new** Elasticsearch cluster, add the snapshot repository. For details, check our guidelines for [Amazon Web Services (AWS) Storage](../../tools/snapshot-and-restore/ech-aws-custom-repository.md), [Google Cloud Storage (GCS)](../../tools/snapshot-and-restore/ech-gcs-snapshotting.md), or [Azure Blob Storage](../../tools/snapshot-and-restore/ech-azure-snapshotting.md).
137+
3. From the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body) of the **new** Elasticsearch cluster, add the snapshot repository. For details, check our guidelines for [Amazon Web Services (AWS) Storage](../../tools/snapshot-and-restore/ec-aws-custom-repository.md), [Google Cloud Storage (GCS)](../../tools/snapshot-and-restore/ec-gcs-snapshotting.md), or [Azure Blob Storage](../../tools/snapshot-and-restore/ec-azure-snapshotting.md).
138138

139139
::::{important}
140140
If you’re migrating [searchable snapshots](../../tools/snapshot-and-restore/searchable-snapshots.md), the repository name must be identical in the source and destination clusters.

deploy-manage/toc.yml

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -428,22 +428,16 @@ toc:
428428
- file: tools/snapshot-and-restore/source-only-repository.md
429429
- file: tools/snapshot-and-restore/elastic-cloud-hosted.md
430430
children:
431-
- file: tools/snapshot-and-restore/ec-custom-repository.md
432-
children:
433-
- file: tools/snapshot-and-restore/ec-aws-custom-repository.md
434-
- file: tools/snapshot-and-restore/ec-gcs-snapshotting.md
435-
- file: tools/snapshot-and-restore/ec-azure-snapshotting.md
436-
- file: tools/snapshot-and-restore/ech-custom-repository.md
437-
children:
438-
- file: tools/snapshot-and-restore/ech-aws-custom-repository.md
439-
- file: tools/snapshot-and-restore/ech-gcs-snapshotting.md
440-
- file: tools/snapshot-and-restore/ech-azure-snapshotting.md
431+
- file: tools/snapshot-and-restore/ec-aws-custom-repository.md
432+
- file: tools/snapshot-and-restore/ec-gcs-snapshotting.md
433+
- file: tools/snapshot-and-restore/ec-azure-snapshotting.md
441434
- file: tools/snapshot-and-restore/access-isolation-for-found-snapshots-repository.md
442435
children:
443436
- file: tools/snapshot-and-restore/repository-isolation-on-azure.md
444437
- file: tools/snapshot-and-restore/repository-isolation-on-aws-gcp.md
445438
- file: tools/snapshot-and-restore/cloud-enterprise.md
446439
children:
440+
- file: tools/snapshot-and-restore/ece-aws-custom-repository.md
447441
- file: tools/snapshot-and-restore/google-cloud-storage-gcs-repository.md
448442
- file: tools/snapshot-and-restore/azure-storage-repository.md
449443
- file: tools/snapshot-and-restore/minio-on-premise-repository.md

deploy-manage/tools.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/high-availability.html
44

5-
applies:
6-
stack: all
7-
hosted: all
8-
ece: all
9-
eck: all
5+
applies_to:
6+
deployment:
7+
eck:
8+
ess:
9+
ece:
10+
self:
1011
---
1112

1213

14+
1315
# Backup, high availability, and resilience tools [high-availability]
1416

1517
Elastic provides comprehensive tools to safeguard data, ensure continuous availability, and maintain resilience. These tools are designed to support disaster recovery strategies, enabling businesses to protect critical information and minimize downtime, and maintain high availability in case of unexpected failures. In this section, you'll learn about these tools and how to implement them in your environment.

deploy-manage/tools/cross-cluster-replication.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2-
mapped_pages:
3-
- https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html
2+
applies_to:
3+
deployment:
4+
eck:
5+
ess:
6+
ece:
7+
self:
48
---
59

610
# Cross-cluster replication [xpack-ccr]
@@ -201,7 +205,7 @@ Soft deletes must be enabled for indices that you want to use as leader indices.
201205

202206

203207

204-
## Use {{ccr}} [ccr-learn-more]
208+
## Use cross-cluster replication [ccr-learn-more]
205209

206210
This following sections provide more information about how to configure and use {{ccr}}:
207211

@@ -211,7 +215,7 @@ This following sections provide more information about how to configure and use
211215
* [Upgrading clusters](cross-cluster-replication/upgrading-clusters.md)
212216

213217

214-
## {{ccr-cap}} limitations [ccr-limitations]
218+
## Cross-cluster replication limitations [ccr-limitations]
215219

216220
{{ccr-cap}} is designed to replicate user-generated indices only, and doesn’t currently replicate any of the following:
217221

deploy-manage/tools/cross-cluster-replication/_configure_privileges_for_cross_cluster_replication_2.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/_configure_privileges_for_cross_cluster_replication_2.html
4+
5+
applies_to:
6+
deployment:
7+
eck:
8+
ess:
9+
ece:
10+
self:
411
---
512

613
# Configure privileges for cross-cluster replication [_configure_privileges_for_ccr_2]

deploy-manage/tools/cross-cluster-replication/_connect_to_a_remote_cluster.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/_connect_to_a_remote_cluster.html
4+
5+
applies_to:
6+
deployment:
7+
eck:
8+
ess:
9+
ece:
10+
self:
411
---
512

613
# Connect to a remote cluster [_connect_to_a_remote_cluster]

0 commit comments

Comments
 (0)