Skip to content

Commit 6863b90

Browse files
committed
[DOCS] Remove leveloffset for CCR docs (#46818)
1 parent 3ae51f2 commit 6863b90

File tree

8 files changed

+42
-44
lines changed

8 files changed

+42
-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
@@ -154,9 +154,9 @@ Alternatively, you can manage remote clusters on the
154154
image::images/remote-clusters.jpg["The Remote Clusters page in {kib}"]
155155

156156

157-
[float]
157+
158158
[[ccr-getting-started-leader-index]]
159-
=== Creating a leader index
159+
==== Creating a leader index
160160

161161
In the following example, we will create a leader index in the remote cluster:
162162

@@ -199,9 +199,9 @@ PUT /server-metrics
199199
--------------------------------------------------
200200
// TEST[continued]
201201

202-
[float]
202+
203203
[[ccr-getting-started-follower-index]]
204-
=== Creating a follower index
204+
==== Creating a follower index
205205

206206
Follower indices are created with the {ref}/ccr-put-follow.html[create follower
207207
API]. When you create a follower index, you must reference the
@@ -256,9 +256,9 @@ POST /server-metrics-copy/_ccr/unfollow
256256
257257
//////////////////////////
258258

259-
[float]
259+
260260
[[ccr-getting-started-auto-follow]]
261-
=== Automatically create follower indices
261+
==== Automatically create follower indices
262262

263263
The <<ccr-auto-follow,auto-follow>> feature in {ccr} helps for time series use
264264
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: 15 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
@@ -17,8 +17,8 @@ Replication is pull-based. This means that replication is driven by the
1717
follower index. This simplifies state management on the leader index and means
1818
that {ccr} does not interfere with indexing on the leader index.
1919

20-
[float]
21-
=== Configuring replication
20+
21+
==== Configuring replication
2222

2323
Replication can be configured in two ways:
2424

@@ -65,8 +65,8 @@ POST /follower_index/_ccr/pause_follow
6565
6666
//////////////////////////
6767

68-
[float]
69-
=== The mechanics of replication
68+
69+
==== The mechanics of replication
7070

7171
While replication is managed at the index level, replication is performed at the
7272
shard level. When a follower index is created, it is automatically
@@ -128,17 +128,17 @@ closing itself, applying the settings update, and then re-opening itself. The
128128
follower index will be unavailable for reads and not replicating writes
129129
during this cycle.
130130

131-
[float]
132-
=== Inspecting the progress of replication
131+
132+
==== Inspecting the progress of replication
133133

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

140-
[float]
141-
=== Pausing and resuming replication
140+
141+
==== Pausing and resuming replication
142142

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

150-
[float]
151-
=== Leader index retaining operations for replication
150+
151+
==== Leader index retaining operations for replication
152152

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

181-
[float]
182-
=== Remedying a follower that has fallen behind
181+
182+
==== Remedying a follower that has fallen behind
183183

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

211-
[float]
212-
=== Terminating replication
211+
212+
==== Terminating replication
213213

214214
You can terminate replication with the
215215
{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
@@ -22,9 +22,9 @@ existing data that you want to replicate from another cluster, you must
2222
{ref}/docs-reindex.html[reindex] your data into a new index with soft deletes
2323
enabled.
2424

25-
[float]
25+
2626
[[ccr-overview-soft-deletes]]
27-
=== Soft delete settings
27+
==== Soft delete settings
2828

2929
`index.soft_deletes.enabled`::
3030

@@ -42,9 +42,9 @@ The default value is `12h`.
4242

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

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

4949
If you want to replicate indices created by APM Server or Beats, and are
5050
allowing APM Server or Beats to manage index templates, you need to configure
@@ -63,9 +63,9 @@ For additional information on controlling the index templates managed by APM
6363
Server or Beats, see the relevant documentation on loading the Elasticsearch
6464
index template.
6565

66-
[float]
66+
6767
[[ccr-overview-logstash]]
68-
=== Setting soft deletes on indices created by Logstash
68+
==== Setting soft deletes on indices created by Logstash
6969

7070
If you want to replicate indices created by Logstash, and are using Logstash to
7171
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
@@ -30,6 +30,4 @@ or serve data locally based on geo-proximity.
3030

3131
include::high-availability/backup-cluster.asciidoc[]
3232

33-
:leveloffset: +1
3433
include::ccr/index.asciidoc[]
35-
:leveloffset: -1

0 commit comments

Comments
 (0)