diff --git a/docs/reference/administering.asciidoc b/docs/reference/administering.asciidoc deleted file mode 100644 index 0fd279024aaf6..0000000000000 --- a/docs/reference/administering.asciidoc +++ /dev/null @@ -1,12 +0,0 @@ -[[administer-elasticsearch]] -= Administering {es} - -[partintro] --- -Elasticsearch is a complex piece of software, with many moving parts. There are -many APIs and features that are designed to help you manage your Elasticsearch -cluster. - --- - -include::administering/backup-cluster.asciidoc[] diff --git a/docs/reference/ccr/auto-follow.asciidoc b/docs/reference/ccr/auto-follow.asciidoc index 580b2b11d7244..eb2394bfa0770 100644 --- a/docs/reference/ccr/auto-follow.asciidoc +++ b/docs/reference/ccr/auto-follow.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="platinum"] [[ccr-auto-follow]] -=== Automatically following indices +== Automatically following indices In time series use cases where you want to follow new indices that are periodically created (such as daily Beats indices), manually configuring follower @@ -10,7 +10,7 @@ functionality in {ccr} is aimed at easing this burden. With the auto-follow functionality, you can specify that new indices in a remote cluster that have a name that matches a pattern are automatically followed. -==== Managing auto-follow patterns +=== Managing auto-follow patterns You can add a new auto-follow pattern configuration with the {ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. When you create diff --git a/docs/reference/ccr/getting-started.asciidoc b/docs/reference/ccr/getting-started.asciidoc index 24304fea7642a..fef771526b2cf 100644 --- a/docs/reference/ccr/getting-started.asciidoc +++ b/docs/reference/ccr/getting-started.asciidoc @@ -20,7 +20,7 @@ This getting-started guide for {ccr} shows you how to: . Obtain a license that includes the {ccr} features. See https://www.elastic.co/subscriptions[subscriptions] and - <>. + {stack-ov}/license-management.html[License-management]. . If the Elastic {security-features} are enabled in your local and remote clusters, you need a user that has appropriate authority to perform the steps @@ -34,7 +34,7 @@ to control which users have authority to manage {ccr}. By default, you can perform all of the steps in this tutorial by using the built-in `elastic` user. However, a password must be set for this user before the user can do anything. For information about how to set that password, -see <>. +see {stack-ov}/security-getting-started.html[Tutorial: Getting started with security]. If you are performing these steps in a production environment, take extra care because the `elastic` user has the `superuser` role and you could inadvertently diff --git a/docs/reference/ccr/index.asciidoc b/docs/reference/ccr/index.asciidoc index ba2fa0d1e7820..fd3e0bc647a50 100644 --- a/docs/reference/ccr/index.asciidoc +++ b/docs/reference/ccr/index.asciidoc @@ -3,9 +3,6 @@ [[xpack-ccr]] = {ccr-cap} -[partintro] --- - The {ccr} (CCR) feature enables replication of indices in remote clusters to a local cluster. This functionality can be used in some common production use cases: @@ -22,7 +19,6 @@ This guide provides an overview of {ccr}: * <> * <> --- include::overview.asciidoc[] include::requirements.asciidoc[] diff --git a/docs/reference/ccr/requirements.asciidoc b/docs/reference/ccr/requirements.asciidoc index 91fbd2c755328..124cc04f28c70 100644 --- a/docs/reference/ccr/requirements.asciidoc +++ b/docs/reference/ccr/requirements.asciidoc @@ -1,7 +1,7 @@ [role="xpack"] [testenv="platinum"] [[ccr-requirements]] -=== Requirements for leader indices +== Requirements for leader indices {ccr-cap} works by replaying the history of individual write operations that were performed on the shards of the leader index. This means that the @@ -24,7 +24,7 @@ enabled. [float] [[ccr-overview-soft-deletes]] -==== Soft delete settings +=== Soft delete settings `index.soft_deletes.enabled`:: @@ -44,7 +44,7 @@ For more information about index settings, see {ref}/index-modules.html[Index mo [float] [[ccr-overview-beats]] -==== Setting soft deletes on indices created by APM Server or Beats +=== Setting soft deletes on indices created by APM Server or Beats If you want to replicate indices created by APM Server or Beats, and are allowing APM Server or Beats to manage index templates, you need to configure @@ -65,7 +65,7 @@ index template. [float] [[ccr-overview-logstash]] -==== Setting soft deletes on indices created by Logstash +=== Setting soft deletes on indices created by Logstash If you want to replicate indices created by Logstash, and are using Logstash to manage index templates, you need to configure soft deletes on a custom Logstash diff --git a/docs/reference/high-availability.asciidoc b/docs/reference/high-availability.asciidoc new file mode 100644 index 0000000000000..2f4506ba8b797 --- /dev/null +++ b/docs/reference/high-availability.asciidoc @@ -0,0 +1,35 @@ +[[high-availability]] += Set up a cluster for high availability + +[partintro] +-- +As with any software that stores data, +it is important to routinely back up your data. +{es}'s <> provide high availability +during runtime; +they enable you to tolerate sporadic node loss +without an interruption of service. + +However, replica shards do not protect an {es} cluster +from catastrophic failure. +You need a backup of your cluster— +a copy in case something goes wrong. + + +{es} offers two features to support high availability for a cluster: + +* <>, +which you can use to back up individual indices or entire clusters. +You can automatically store these backups in a repository on a shared filesystem. + +* <>, +which you can use to copy indices in remote clusters to a local cluster. +You can use {ccr} to recover from the failure of a primary cluster +or serve data locally based on geo-proximity. +-- + +include::high-availability/backup-cluster.asciidoc[] + +:leveloffset: +1 +include::ccr/index.asciidoc[] +:leveloffset: -1 diff --git a/docs/reference/administering/backup-and-restore-security-config.asciidoc b/docs/reference/high-availability/backup-and-restore-security-config.asciidoc similarity index 100% rename from docs/reference/administering/backup-and-restore-security-config.asciidoc rename to docs/reference/high-availability/backup-and-restore-security-config.asciidoc diff --git a/docs/reference/administering/backup-cluster-config.asciidoc b/docs/reference/high-availability/backup-cluster-config.asciidoc similarity index 100% rename from docs/reference/administering/backup-cluster-config.asciidoc rename to docs/reference/high-availability/backup-cluster-config.asciidoc diff --git a/docs/reference/administering/backup-cluster-data.asciidoc b/docs/reference/high-availability/backup-cluster-data.asciidoc similarity index 72% rename from docs/reference/administering/backup-cluster-data.asciidoc rename to docs/reference/high-availability/backup-cluster-data.asciidoc index 377cd4085c576..485e047acd255 100644 --- a/docs/reference/administering/backup-cluster-data.asciidoc +++ b/docs/reference/high-availability/backup-cluster-data.asciidoc @@ -4,14 +4,6 @@ Back up the data ++++ -As with any software that stores data, it is important to routinely back up your -data. {es} replicas provide high availability during runtime; they enable you to -tolerate sporadic node loss without an interruption of service. - -Replicas do not provide protection from catastrophic failure, however. For that, -you need a real backup of your cluster—a complete copy in case something goes -wrong. - To back up your cluster's data, you can use the <>. include::{es-repo-dir}/modules/snapshots.asciidoc[tag=snapshot-intro] diff --git a/docs/reference/administering/backup-cluster.asciidoc b/docs/reference/high-availability/backup-cluster.asciidoc similarity index 100% rename from docs/reference/administering/backup-cluster.asciidoc rename to docs/reference/high-availability/backup-cluster.asciidoc diff --git a/docs/reference/administering/restore-cluster-data.asciidoc b/docs/reference/high-availability/restore-cluster-data.asciidoc similarity index 100% rename from docs/reference/administering/restore-cluster-data.asciidoc rename to docs/reference/high-availability/restore-cluster-data.asciidoc diff --git a/docs/reference/index.asciidoc b/docs/reference/index.asciidoc index 7f82553f0c561..e70ae19ca76e8 100644 --- a/docs/reference/index.asciidoc +++ b/docs/reference/index.asciidoc @@ -60,7 +60,7 @@ include::monitoring/index.asciidoc[] include::frozen-indices.asciidoc[] -include::administering.asciidoc[] +include::high-availability.asciidoc[] include::data-rollup-transform.asciidoc[] diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc index ddf0bfd4e1b73..7eb6f4082913a 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -721,3 +721,6 @@ See <>. See <>. +[role="exclude",id="administer-elasticsearch"] +=== Administering {es} +See <>. \ No newline at end of file