Add documentation for remote cluster proxy mode #52779
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is related to elastic#49067.
Tim-Brooks
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-distributed (:Distributed/Network) |
|
Depends on #52796 |
This was referenced Feb 26, 2020
jrodewig
reviewed
Feb 27, 2020
jrodewig
reviewed
Feb 27, 2020
Comment on lines
42
to
44
| `seeds`:: | ||
| The configured initial seed transport addresses of the remote cluster when | ||
| sniff mode is configured. |
There was a problem hiding this comment.
This looks like it was double indented.
Suggested change
| `seeds`:: | |
| The configured initial seed transport addresses of the remote cluster when | |
| sniff mode is configured. | |
| `seeds`:: | |
| Initial seed transport addresses of the remote cluster when | |
| sniff mode is configured. |
jrodewig
reviewed
Feb 27, 2020
jrodewig
reviewed
Feb 27, 2020
jrodewig
reviewed
Feb 27, 2020
jrodewig
reviewed
Feb 27, 2020
jrodewig
reviewed
Feb 27, 2020
jrodewig
reviewed
Feb 27, 2020
| to three _gateway nodes_ are selected to be connected to as part of remote | ||
| cluster requests. | ||
| // end::how-remote-clusters-work[] | ||
| only to a limited number of nodes in that remote cluster. There are two |
There was a problem hiding this comment.
Suggested change
| only to a limited number of nodes in that remote cluster. There are two | |
| to a limited number of nodes in that remote cluster. There are two |
jrodewig
reviewed
Feb 27, 2020
jrodewig
reviewed
Feb 27, 2020
jrodewig
reviewed
Feb 27, 2020
|
I updated this and added a section on proxy mode in the CCS docs. |
jrodewig
reviewed
Mar 4, 2020
|
|
||
| Gateway and seed nodes need to be accessible from the local cluster via your | ||
| network. | ||
| For remote clusters using the <<sniff-mode,sniff connection> mode, gateway and |
There was a problem hiding this comment.
This is required for the link to render properly.
Suggested change
| For remote clusters using the <<sniff-mode,sniff connection> mode, gateway and | |
| For remote clusters using the <<sniff-mode,sniff connection>> mode, gateway and |
jrodewig
reviewed
Mar 4, 2020
| == {ccs} in proxy mode | ||
|
|
||
| <<proxy-mode,Proxy mode>> remote cluster connections support {ccs}. All remote | ||
| connections will connect to the configured `proxy_address`. Any desired |
There was a problem hiding this comment.
Suggested change
| connections will connect to the configured `proxy_address`. Any desired | |
| connections connect to the configured `proxy_address`. Any desired |
jrodewig
reviewed
Mar 4, 2020
Comment on lines
33
to
34
| cluster requests. This mode requires that the gateway node's publish addresses | ||
| are exposed to the local cluster. |
There was a problem hiding this comment.
"accessible" is more consistent with what's stated in "proxy" mode and has less of a negative connotation.
Suggested change
| cluster requests. This mode requires that the gateway node's publish addresses | |
| are exposed to the local cluster. | |
| cluster requests. This mode requires that the gateway node's publish addresses | |
| are accessible by the local cluster. |
jrodewig
reviewed
Mar 4, 2020
| <2> The hostname and <<modules-transport,transport>> port (default: 9300) of a | ||
| seed node in the remote cluster. | ||
| <3> A keep-alive ping is configured for `cluster_one`. | ||
| <4> Compression is explicitly enabled for requests to `cluster_two`. | ||
| <5> Disconnected remote clusters are optional for `cluster_two`. | ||
| <4> The configured connection mode. By default it is <<sniff-mode,sniff>>, so |
There was a problem hiding this comment.
Suggested change
| <4> The configured connection mode. By default it is <<sniff-mode,sniff>>, so | |
| <4> The configured connection mode. By default, this is <<sniff-mode,`sniff`>>, so |
jrodewig
reviewed
Mar 4, 2020
| [[remote-cluster-sniff-settings]] | ||
| === Remote cluster settings for sniff mode | ||
|
|
||
| `cluster.remote.${cluster_alias}.seeds`:: |
There was a problem hiding this comment.
Our docs typically use the <variable> convention.
Suggested change
| `cluster.remote.${cluster_alias}.seeds`:: | |
| `cluster.remote.<cluster_alias>.seeds`:: |
jrodewig
reviewed
Mar 4, 2020
|
|
||
| The list of seed nodes used to sniff the remote cluster state. | ||
|
|
||
| `cluster.remote.${cluster_alias}.node_connections`:: |
There was a problem hiding this comment.
Suggested change
| `cluster.remote.${cluster_alias}.node_connections`:: | |
| `cluster.remote.<cluster_alias>.node_connections`:: |
jrodewig
reviewed
Mar 4, 2020
| [[remote-cluster-proxy-settings]] | ||
| === Remote cluster settings for proxy mode | ||
|
|
||
| `cluster.remote.${cluster_alias}.proxy_address`:: |
There was a problem hiding this comment.
Suggested change
| `cluster.remote.${cluster_alias}.proxy_address`:: | |
| `cluster.remote.<cluster_alias>.proxy_address`:: |
jrodewig
reviewed
Mar 4, 2020
|
|
||
| The address used for all remote connections. | ||
|
|
||
| `cluster.remote.${cluster_alias}.proxy_socket_connections`:: |
There was a problem hiding this comment.
Suggested change
| `cluster.remote.${cluster_alias}.proxy_socket_connections`:: | |
| `cluster.remote.<cluster_alias>.proxy_socket_connections`:: |
jrodewig
reviewed
Mar 4, 2020
Comment on lines
322
to
324
| ifndef::include-xpack[] | ||
|
|
||
| `cluster.remote.${cluster_alias}.server_name`:: |
There was a problem hiding this comment.
I think this should be ifdef, not ifndef.
I'm also not sure if it's necessary to do ifdef::include-xpack[]. Adding [role="xpack"] before the setting def should suffice. From what I understand, ifdef::include-xpack[] and ifndef::include-xpack[] have not been functional for some time.
Suggested change
| ifndef::include-xpack[] | |
| `cluster.remote.${cluster_alias}.server_name`:: | |
| [role="xpack"] | |
| `cluster.remote.${cluster_alias}.server_name`:: |
jrodewig
reviewed
Mar 4, 2020
| <<configuring-tls,{TLS is enabled}>>. The TLS transport will fail to open | ||
| remote connections if this field is not a valid hostname as defined by the | ||
| TLS SNI specification. | ||
| endif::[] |
There was a problem hiding this comment.
Suggested change
| endif::[] |
jrodewig
reviewed
Mar 4, 2020
|
|
||
| `cluster.remote.${cluster_alias}.server_name`:: | ||
|
|
||
| An optional hostname string which will be sent in the server_name field of |
There was a problem hiding this comment.
Suggested change
| An optional hostname string which will be sent in the server_name field of | |
| An optional hostname string which is sent in the `server_name` field of |
jrodewig
reviewed
Mar 4, 2020
|
|
||
| An optional hostname string which will be sent in the server_name field of | ||
| the TLS Server Name Indication extension if | ||
| <<configuring-tls,{TLS is enabled}>>. The TLS transport will fail to open |
There was a problem hiding this comment.
Suggested change
| <<configuring-tls,{TLS is enabled}>>. The TLS transport will fail to open | |
| <<configuring-tls,TLS is enabled>>. The TLS transport will fail to open |
jrodewig
reviewed
Mar 4, 2020
| @@ -139,7 +171,8 @@ PUT _cluster/settings | |||
| // TEST[s/127.0.0.1:9300/\${transport_host}/] | |||
|
|
|||
| You can dynamically update the compression and ping schedule settings. However, | |||
| you must re-include seeds in the settings update request. For example: | |||
| you must re-include seeds or proxy_address in the settings update request. | |||
There was a problem hiding this comment.
Suggested change
| you must re-include seeds or proxy_address in the settings update request. | |
| you must re-include seeds or a `proxy_address` in the settings update request. |
jrodewig
reviewed
Mar 4, 2020
| cluster requests. This mode requires that the gateway node's publish addresses | ||
| are exposed to the local cluster. | ||
|
|
||
| The sniff mode is the default connection mode. |
There was a problem hiding this comment.
Suggested change
| The sniff mode is the default connection mode. | |
| Sniff mode is the default connection mode. |
jrodewig
approved these changes
Mar 4, 2020
There was a problem hiding this comment.
Look good overall. I did suggest a few needed changes:
- Fix a broken internal link
- Remove or update the new
ifndefdirective in the remote cluster settings section - Use the standard
<variable>convention in the remote cluster settings section
My other feedback is non-blocking. Feel free to use or ignore those items as you see fit.
Thanks for writing up the proxy mode CCS section!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is related to #49067.