Skip to content

Commit e6c24e3

Browse files
Melori Arellanojrodewig
Melori Arellano
authored andcommitted
[DOCS] Add missing setting skip_unavailable to example
The example to delete a remote cluster is missing the `skip_unavailable` setting which results in an error: ``` "type": "illegal_argument_exception", "reason": "missing required setting [cluster.remote.tiny-test.seeds] for setting [cluster.remote.tiny-test.skip_unavailable]" ```
1 parent cc867e8 commit e6c24e3

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/reference/modules/remote-clusters.asciidoc

+14-7
Original file line numberDiff line numberDiff line change
@@ -79,17 +79,20 @@ cluster:
7979
cluster_two:
8080
seeds: 127.0.0.1:9301
8181
transport.compress: true <3>
82+
skip_unavailable: true <4>
8283
8384
--------------------------------
8485
<1> `cluster_one` and `cluster_two` are arbitrary _cluster aliases_ representing
8586
the connection to each cluster. These names are subsequently used to distinguish
8687
between local and remote indices.
8788
<2> A keep-alive ping is configured for `cluster_one`.
8889
<3> Compression is explicitly enabled for requests to `cluster_two`.
90+
<4> Disconnected remote clusters are optional for `cluster_two`.
8991

9092
For more information about the optional transport settings, see
9193
<<modules-transport>>.
9294

95+
9396
If you use <<cluster-update-settings,cluster settings>>, the remote clusters
9497
are available on every node in the cluster. For example:
9598

@@ -110,7 +113,8 @@ PUT _cluster/settings
110113
"seeds": [
111114
"127.0.0.1:9301"
112115
],
113-
"transport.compress": true
116+
"transport.compress": true,
117+
"skip_unavailable": true
114118
},
115119
"cluster_three": {
116120
"seeds": [
@@ -160,8 +164,7 @@ NOTE: When the compression or ping schedule settings change, all the existing
160164
node connections must close and re-open, which can cause in-flight requests to
161165
fail.
162166

163-
A remote cluster can be deleted from the cluster settings by setting its seeds
164-
to `null`:
167+
A remote cluster can be deleted from the cluster settings by setting its seeds and optional settings to `null` :
165168

166169
[source,js]
167170
--------------------------------
@@ -170,8 +173,12 @@ PUT _cluster/settings
170173
"persistent": {
171174
"cluster": {
172175
"remote": {
173-
"cluster_three": {
174-
"seeds": null <1>
176+
"cluster_two": { <1>
177+
"seeds": null,
178+
"skip_unavailable": null,
179+
"transport": {
180+
"compress": null
181+
}
175182
}
176183
}
177184
}
@@ -180,8 +187,8 @@ PUT _cluster/settings
180187
--------------------------------
181188
// CONSOLE
182189
// TEST[continued]
183-
<1> `cluster_three` would be removed from the cluster settings, leaving
184-
`cluster_one` and `cluster_two` intact.
190+
<1> `cluster_two` would be removed from the cluster settings, leaving
191+
`cluster_one` and `cluster_three` intact.
185192

186193
[float]
187194
[[remote-cluster-settings]]

0 commit comments

Comments
 (0)