Remote clusters: Snippets and improvements for ECE and ECH use cases #3365
+143
−522
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,44 @@ | ||||||
| <!-- | ||||||
| This snippet is in use in the following locations: | ||||||
| - ec-remote-cluster-same-ess.md | ||||||
| - ec-remote-cluster-other-ess.md | ||||||
| - ec-remote-cluster-ece.md | ||||||
| - ece-remote-cluster-same-ece.md | ||||||
| - ece-remote-cluster-other-ece.md | ||||||
| - ece-remote-cluster-ess.md | ||||||
|
|
||||||
| It requires remote_type substitution to be defined | ||||||
| --> | ||||||
| To configure a deployment as a remote cluster, use the [cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). Configure the following fields: | ||||||
|
|
||||||
| * `mode`: `proxy` | ||||||
| * `proxy_address`: This value can be found on the **Security** page of the {{remote_type}} you want to use as a remote. Copy the **Proxy address** from the **Remote cluster parameters** section. Also, using the API, this value can be obtained from the {{es}} resource info, concatenating the field `metadata.endpoint` and port `9400` using a semicolon. | ||||||
|
|
||||||
| ::::{note} | ||||||
| If you’re using API keys as security model, change the port into `9443`. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| :::: | ||||||
|
|
||||||
| * `server_name`: This value can be found on the **Security** page of the {{remote_type}} you want to use as a remote. Copy the **Server name** from the **Remote cluster parameters** section. Also, using the API, this can be obtained from the {{es}} resource info field `metadata.endpoint`. | ||||||
|
|
||||||
| This is an example of the API call to `_cluster/settings`: | ||||||
|
|
||||||
| ```json | ||||||
| PUT /_cluster/settings | ||||||
| { | ||||||
| "persistent": { | ||||||
| "cluster": { | ||||||
| "remote": { | ||||||
| "alias-for-my-remote-cluster": { | ||||||
| "mode":"proxy", | ||||||
| "proxy_address": "a542184a7a7d45b88b83f95392f450ab.192.168.44.10.ip.es.io:9400", | ||||||
| "server_name": "a542184a7a7d45b88b83f95392f450ab.192.168.44.10.ip.es.io" | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| ::::{note} | ||||||
| When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI. | ||||||
| :::: | ||||||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,36 @@ | ||||||
| <!-- | ||||||
| This snippet is in use in the following locations: | ||||||
| - ec-remote-cluster-same-ess.md | ||||||
| - ec-remote-cluster-other-ess.md | ||||||
| - ec-remote-cluster-ece.md | ||||||
| - ece-remote-cluster-same-ece.md | ||||||
| - ece-remote-cluster-other-ece.md | ||||||
| - ece-remote-cluster-ess.md | ||||||
| It requires remote_type substitution to be defined | ||||||
| --> | ||||||
| 1. Open the {{kib}} main menu, and select **Stack Management > Data > Remote Clusters > Add a remote cluster**. | ||||||
| 2. In **Select connection type**, choose the authentication mechanism you prepared earlier (**API keys** or **Certificates**), and then click **Next**. | ||||||
| 3. In **Add connection information**, fill in the following fields: | ||||||
|
|
||||||
| * **Remote cluster name**: This *cluster alias* is a unique identifier that represents the connection to the remote cluster and is used to distinguish local and remote indices. | ||||||
|
|
||||||
| When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI. | ||||||
|
|
||||||
| * **Remote address**: This value can be found on the **Security** page of the {{remote_type}} you want to use as a remote. Copy the **Proxy address** from the **Remote cluster parameters** section. | ||||||
|
|
||||||
| ::::{note} | ||||||
| If you’re using API keys as security model, change the port into `9443`. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| :::: | ||||||
|
|
||||||
| * **Configure advanced options** (optional): Expand this section if you need to customize additional settings. | ||||||
| * **TLS server name**: Specify a value if the certificate presented by the remote cluster is signed for a different name than the remote address. | ||||||
|
|
||||||
| This value can be found on the **Security** page of the {{remote_type}} you want to use as a remote. Copy the **Server name** from the **Remote cluster parameters** section. | ||||||
|
|
||||||
| * **Socket connections**: Define the number of connections to open with the remote cluster. | ||||||
|
|
||||||
| For a full list of available client connection settings, refer to [remote cluster settings reference](elasticsearch://reference/elasticsearch/configuration-reference/remote-clusters.md#remote-cluster-proxy-settings). | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| 4. Click **Next**. | ||||||
| 5. In **Confirm setup**, click **Add remote cluster** (you have already established trust in a previous step). | ||||||
This file contains hidden or 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 file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that the idea that you're adding a
remotewith an alias matching your api key cluster alias is a little lost here. consider skipping this instructional stuff and instead marking up the code snippet with annotations, so you can explain all of the "relevant" props. might also be worth making an explicit connection to the cluster settings you're setting by linking to the remote cluster settings referencetechnically this would also be doable through the elasticsearch settings in the cloud ui right? might be worth stepping back and saying you're setting cluster settings, and you could do that through the API or the user settings.