1
1
[role="xpack"]
2
2
[testenv="platinum"]
3
3
[[ccr-overview]]
4
- == Overview
4
+ === Overview
5
5
6
6
7
7
{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.
19
19
20
20
IMPORTANT: {ccr-cap} requires {ref}/modules-remote-clusters.html[remote clusters].
21
21
22
- [float]
23
- === Configuring replication
22
+ ==== Configuring replication
24
23
25
24
Replication can be configured in two ways:
26
25
@@ -69,8 +68,8 @@ POST /follower_index/_ccr/pause_follow
69
68
70
69
//////////////////////////
71
70
72
- [float]
73
- === The mechanics of replication
71
+
72
+ ==== The mechanics of replication
74
73
75
74
While replication is managed at the index level, replication is performed at the
76
75
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
127
126
follower index will be unavailable for reads and not replicating writes
128
127
during this cycle.
129
128
130
- [float]
131
- === Inspecting the progress of replication
129
+
130
+ ==== Inspecting the progress of replication
132
131
133
132
You can inspect the progress of replication at the shard level with the
134
133
{ref}/ccr-get-follow-stats.html[get follower stats API]. This API gives you
135
134
insight into the read and writes managed by the follower shard task. It also
136
135
reports read exceptions that can be retried and fatal exceptions that require
137
136
user intervention.
138
137
139
- [float]
140
- === Pausing and resuming replication
138
+
139
+ ==== Pausing and resuming replication
141
140
142
141
You can pause replication with the
143
142
{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
146
145
on the follower shard task if your initial configuration is not suitable for
147
146
your use case.
148
147
149
- [float]
150
- === Leader index retaining operations for replication
148
+
149
+ ==== Leader index retaining operations for replication
151
150
152
151
If the follower is unable to replicate operations from a leader for a period of
153
152
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
177
176
replication issue prior to the lease expiring so that the problem can be remedied
178
177
before the follower falls fatally behind.
179
178
180
- [float]
181
- === Remedying a follower that has fallen behind
179
+
180
+ ==== Remedying a follower that has fallen behind
182
181
183
182
If a follower falls sufficiently behind a leader that it can no longer replicate
184
183
operations this can be detected in {kib} or by using the
@@ -208,8 +207,8 @@ segment files are deleted on the follower cluster. The
208
207
files from the leader again. After the follower index initializes, the
209
208
following process starts again.
210
209
211
- [float]
212
- === Terminating replication
210
+
211
+ ==== Terminating replication
213
212
214
213
You can terminate replication with the
215
214
{ref}/ccr-post-unfollow.html[unfollow API]. This API converts a follower index
0 commit comments