Skip to content

Commit 520a4e8

Browse files
jrodewiglcawl
authored andcommitted
[DOCS] Remove leveloffset for CCR docs (#46818)
1 parent 50d5d84 commit 520a4e8

8 files changed

+41
-44
lines changed

docs/reference/ccr/auto-follow.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-auto-follow]]
4-
== Automatically following indices
4+
=== Automatically following indices
55

66
In time series use cases where you want to follow new indices that are
77
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
1010
functionality, you can specify that new indices in a remote cluster that have a
1111
name that matches a pattern are automatically followed.
1212

13-
=== Managing auto-follow patterns
13+
==== Managing auto-follow patterns
1414

1515
You can add a new auto-follow pattern configuration with the
1616
{ref}/ccr-put-auto-follow-pattern.html[create auto-follow pattern API]. When you create

docs/reference/ccr/getting-started.asciidoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-getting-started]]
4-
== Getting started with {ccr}
4+
=== Getting started with {ccr}
55

66
This getting-started guide for {ccr} shows you how to:
77

@@ -12,9 +12,9 @@ This getting-started guide for {ccr} shows you how to:
1212
a leader index
1313
* <<ccr-getting-started-auto-follow,Automatically create follower indices>>
1414

15-
[float]
15+
1616
[[ccr-getting-started-before-you-begin]]
17-
=== Before you begin
17+
==== Before you begin
1818
. {stack-gs}/get-started-elastic-stack.html#install-elasticsearch[Install {es}]
1919
on your local and remote clusters.
2020

@@ -81,9 +81,9 @@ cluster update settings API, you will also need a user with the `all` cluster
8181
privilege.
8282
--
8383

84-
[float]
84+
8585
[[ccr-getting-started-remote-cluster]]
86-
=== Connecting to a remote cluster
86+
==== Connecting to a remote cluster
8787

8888
The {ccr} features require that you
8989
{ref}/modules-remote-clusters.html[connect your local cluster to a remote
@@ -161,9 +161,9 @@ Alternatively, you can manage remote clusters on the
161161
image::images/remote-clusters.jpg["The Remote Clusters page in {kib}"]
162162

163163

164-
[float]
164+
165165
[[ccr-getting-started-leader-index]]
166-
=== Creating a leader index
166+
==== Creating a leader index
167167

168168
Leader indices require a special index setting to ensure that the operations
169169
that need to be replicated are available when the follower requests them from
@@ -219,9 +219,9 @@ PUT /server-metrics
219219
// TEST[continued]
220220
<1> Enables soft deletes on the leader index.
221221

222-
[float]
222+
223223
[[ccr-getting-started-follower-index]]
224-
=== Creating a follower index
224+
==== Creating a follower index
225225

226226
Follower indices are created with the {ref}/ccr-put-follow.html[create follower
227227
API]. When you create a follower index, you must reference the
@@ -279,9 +279,9 @@ POST /server-metrics-copy/_ccr/unfollow
279279
280280
//////////////////////////
281281

282-
[float]
282+
283283
[[ccr-getting-started-auto-follow]]
284-
=== Automatically create follower indices
284+
==== Automatically create follower indices
285285

286286
The <<ccr-auto-follow,auto-follow>> feature in {ccr} helps for time series use
287287
cases where you want to follow new indices that are periodically created in the

docs/reference/ccr/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[xpack-ccr]]
4-
= {ccr-cap}
4+
== {ccr-cap}
55

66
The {ccr} (CCR) feature enables replication of indices in remote clusters to a
77
local cluster. This functionality can be used in some common production use

docs/reference/ccr/overview.asciidoc

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-overview]]
4-
== Overview
4+
=== Overview
55

66

77
{ccr-cap} is done on an index-by-index basis. Replication is
@@ -19,8 +19,7 @@ that {ccr} does not interfere with indexing on the leader index.
1919

2020
IMPORTANT: {ccr-cap} requires {ref}/modules-remote-clusters.html[remote clusters].
2121

22-
[float]
23-
=== Configuring replication
22+
==== Configuring replication
2423

2524
Replication can be configured in two ways:
2625

@@ -69,8 +68,8 @@ POST /follower_index/_ccr/pause_follow
6968
7069
//////////////////////////
7170

72-
[float]
73-
=== The mechanics of replication
71+
72+
==== The mechanics of replication
7473

7574
While replication is managed at the index level, replication is performed at the
7675
shard level. When a follower index is created, it is automatically
@@ -127,17 +126,17 @@ closing itself, applying the settings update, and then re-opening itself. The
127126
follower index will be unavailable for reads and not replicating writes
128127
during this cycle.
129128

130-
[float]
131-
=== Inspecting the progress of replication
129+
130+
==== Inspecting the progress of replication
132131

133132
You can inspect the progress of replication at the shard level with the
134133
{ref}/ccr-get-follow-stats.html[get follower stats API]. This API gives you
135134
insight into the read and writes managed by the follower shard task. It also
136135
reports read exceptions that can be retried and fatal exceptions that require
137136
user intervention.
138137

139-
[float]
140-
=== Pausing and resuming replication
138+
139+
==== Pausing and resuming replication
141140

142141
You can pause replication with the
143142
{ref}/ccr-post-pause-follow.html[pause follower API] and then later resume
@@ -146,8 +145,8 @@ Using these APIs in tandem enables you to adjust the read and write parameters
146145
on the follower shard task if your initial configuration is not suitable for
147146
your use case.
148147

149-
[float]
150-
=== Leader index retaining operations for replication
148+
149+
==== Leader index retaining operations for replication
151150

152151
If the follower is unable to replicate operations from a leader for a period of
153152
time, the following process can fail due to the leader lacking a complete history
@@ -177,8 +176,8 @@ the lease expires. It is valuable to have monitoring in place to detect a follow
177176
replication issue prior to the lease expiring so that the problem can be remedied
178177
before the follower falls fatally behind.
179178

180-
[float]
181-
=== Remedying a follower that has fallen behind
179+
180+
==== Remedying a follower that has fallen behind
182181

183182
If a follower falls sufficiently behind a leader that it can no longer replicate
184183
operations this can be detected in {kib} or by using the
@@ -208,8 +207,8 @@ segment files are deleted on the follower cluster. The
208207
files from the leader again. After the follower index initializes, the
209208
following process starts again.
210209

211-
[float]
212-
=== Terminating replication
210+
211+
==== Terminating replication
213212

214213
You can terminate replication with the
215214
{ref}/ccr-post-unfollow.html[unfollow API]. This API converts a follower index

docs/reference/ccr/remote-recovery.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[remote-recovery]]
4-
== Remote recovery
4+
=== Remote recovery
55

66
When you create a follower index, you cannot use it until it is fully initialized.
77
The _remote recovery_ process builds a new copy of a shard on a follower node by

docs/reference/ccr/requirements.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-requirements]]
4-
== Requirements for leader indices
4+
=== Requirements for leader indices
55

66
{ccr-cap} works by replaying the history of individual write
77
operations that were performed on the shards of the leader index. This means that the
@@ -24,9 +24,9 @@ existing data that you want to replicate from another cluster, you must
2424
{ref}/docs-reindex.html[reindex] your data into a new index with soft deletes
2525
enabled.
2626

27-
[float]
27+
2828
[[ccr-overview-soft-deletes]]
29-
=== Soft delete settings
29+
==== Soft delete settings
3030

3131
`index.soft_deletes.enabled`::
3232

@@ -44,9 +44,9 @@ The default value is `12h`.
4444

4545
For more information about index settings, see {ref}/index-modules.html[Index modules].
4646

47-
[float]
47+
4848
[[ccr-overview-beats]]
49-
=== Setting soft deletes on indices created by APM Server or Beats
49+
==== Setting soft deletes on indices created by APM Server or Beats
5050

5151
If you want to replicate indices created by APM Server or Beats, and are
5252
allowing APM Server or Beats to manage index templates, you need to enable
@@ -66,9 +66,9 @@ For additional information on controlling the index templates managed by APM
6666
Server or Beats, see the relevant documentation on loading the Elasticsearch
6767
index template.
6868

69-
[float]
69+
7070
[[ccr-overview-logstash]]
71-
=== Setting soft deletes on indices created by Logstash
71+
==== Setting soft deletes on indices created by Logstash
7272

7373
If you want to replicate indices created by Logstash, and are using Logstash to
7474
manage index templates, you need to configure soft deletes on a custom Logstash

docs/reference/ccr/upgrading.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ccr-upgrading]]
4-
== Upgrading clusters
4+
=== Upgrading clusters
55

66
Clusters that are actively using {ccr} require a careful approach to upgrades.
77
Otherwise index following may fail during a rolling upgrade, because of the
@@ -17,8 +17,8 @@ following reasons:
1717
Rolling upgrading clusters with {ccr} is different in case of uni-directional
1818
index following and bi-directional index following.
1919

20-
[float]
21-
=== Uni-directional index following
20+
21+
==== Uni-directional index following
2222

2323
In a uni-directional setup between two clusters, one cluster contains only
2424
leader indices, and the other cluster contains only follower indices following
@@ -35,8 +35,8 @@ cluster B that follows indices in cluster A and cluster C that follows
3535
indices in cluster B. In this case the cluster C should be upgraded first,
3636
then cluster B and finally cluster A.
3737

38-
[float]
39-
=== Bi-directional index following
38+
39+
==== Bi-directional index following
4040

4141
In a bi-directional setup between two clusters, each cluster contains both
4242
leader and follower indices.

docs/reference/high-availability.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,4 @@ You can use {ccr} to recover from the failure of a primary cluster
2828
or serve data locally based on geo-proximity.
2929
--
3030

31-
:leveloffset: +1
3231
include::ccr/index.asciidoc[]
33-
:leveloffset: -1

0 commit comments

Comments
 (0)