Skip to content

Commit 310cb0e

Browse files
authored
remote clusters settings removed from docs-content (#3347)
Remote clusters settings were moved to elasticsearch reference documentation. We remove them now from docs-content, and: - Add a `redirect` in case of links pointing to our version. - Change the existing links in the repo to use the new elasticsearch:// destination. Closes #579
1 parent 10b2fbe commit 310cb0e

File tree

4 files changed

+6
-79
lines changed

4 files changed

+6
-79
lines changed

deploy-manage/remote-clusters/remote-clusters-self-managed.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ $$$sniff-mode$$$
3535
Sniff mode
3636
: In sniff mode, a cluster alias is registered with a name of your choosing and a list of addresses of *seed* nodes specified with the `cluster.remote.<cluster_alias>.seeds` setting. When you register a remote cluster using sniff mode, {{es}} retrieves from one of the seed nodes the addresses of up to three *gateway nodes*. Each `remote_cluster_client` node in the local {{es}} cluster then opens several TCP connections to the publish addresses of the gateway nodes. This mode therefore requires that the gateway nodes' publish addresses are accessible to nodes in the local cluster.
3737

38-
Sniff mode is the default connection mode. See [Sniff mode remote cluster settings](remote-clusters-settings.md#remote-cluster-sniff-settings) for more information about configuring sniff mode.
38+
Sniff mode is the default connection mode. See [Sniff mode remote cluster settings](elasticsearch://reference/elasticsearch/configuration-reference/remote-clusters.md#remote-cluster-sniff-settings) for more information about configuring sniff mode.
3939

4040
$$$gateway-nodes-selection$$$
4141
The *gateway nodes* selection depends on the following criteria:
4242

4343
* **version**: Remote nodes must be compatible with the cluster they are registered to.
4444
* **role**: By default, any non-[master-eligible](/deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md#master-node-role) node can act as a gateway node. Dedicated master nodes are never selected as gateway nodes.
45-
* **attributes**: You can define the gateway nodes for a cluster by setting [`cluster.remote.node.attr.gateway`](remote-clusters-settings.md#cluster-remote-node-attr) to `true`. However, such nodes still have to satisfy the two above requirements.
45+
* **attributes**: You can define the gateway nodes for a cluster by setting [`cluster.remote.node.attr.gateway`](elasticsearch://reference/elasticsearch/configuration-reference/remote-clusters.md#cluster-remote-node-attr) to `true`. However, such nodes still have to satisfy the two above requirements.
4646

4747

4848
$$$proxy-mode$$$
4949

5050
Proxy mode
5151
: In proxy mode, a cluster alias is registered with a name of your choosing and the address of a TCP (layer 4) reverse proxy specified with the `cluster.remote.<cluster_alias>.proxy_address` setting. You must configure this proxy to route connections to one or more nodes of the remote cluster. When you register a remote cluster using proxy mode, {{es}} opens several TCP connections to the proxy address and uses these connections to communicate with the remote cluster. In proxy mode {{es}} disregards the publish addresses of the remote cluster nodes which means that the publish addresses of the remote cluster nodes need not be accessible to the local cluster.
5252

53-
Proxy mode is not the default connection mode, so you must set `cluster.remote.<cluster_alias>.mode: proxy` to use it. See [Proxy mode remote cluster settings](remote-clusters-settings.md#remote-cluster-proxy-settings) for more information about configuring proxy mode.
53+
Proxy mode is not the default connection mode, so you must set `cluster.remote.<cluster_alias>.mode: proxy` to use it. See [Proxy mode remote cluster settings](elasticsearch://reference/elasticsearch/configuration-reference/remote-clusters.md#remote-cluster-proxy-settings) for more information about configuring proxy mode.
5454

5555
Proxy mode has the same [version compatibility requirements](#gateway-nodes-selection) as sniff mode.

deploy-manage/remote-clusters/remote-clusters-settings.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

deploy-manage/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,6 @@ toc:
656656
- file: remote-clusters/remote-clusters-api-key.md
657657
- file: remote-clusters/remote-clusters-cert.md
658658
- file: remote-clusters/remote-clusters-migrate.md
659-
- file: remote-clusters/remote-clusters-settings.md
660659
- file: remote-clusters/eck-remote-clusters.md
661660
- file: monitor.md
662661
children:

redirects.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -519,5 +519,8 @@ redirects:
519519
# Search sessions becoming background search
520520
'explore-analyze/discover/search-sessions.md': 'explore-analyze/discover/background-search.md'
521521

522+
# Remote cluster settings moved to reference: https://github.com/elastic/docs-content/issues/579
523+
'deploy-manage/remote-clusters/remote-clusters-settings.md': 'elasticsearch://reference/elasticsearch/configuration-reference/remote-clusters.md'
524+
522525

523526

0 commit comments

Comments
 (0)