Skip to content

Commit 06fe323

Browse files
committed
private CA connections converted to snippets
1 parent ad87cad commit 06fe323

16 files changed

+120
-140
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--
2+
This snippet is in use in the following locations:
3+
- xxx
4+
5+
It requires remote_type substitution to be defined
6+
-->
7+
1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
8+
2. On the **Deployments** page, select your deployment.
9+
10+
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
11+
12+
3. Access the **Security** page of the deployment.
13+
4. Select **Remote Connections > Add trusted environment** and choose **{{remote_type}}**. Then click **Next**.
14+
5. Select **API keys** as authentication mechanism and click **Next**.
15+
6. When asked whether the Certificate Authority (CA) of the remote environment’s proxy or load-balancing infrastructure is public, select **No, it is private**.
16+
7. Add the API key:
17+
18+
1. Fill both fields.
19+
20+
* For the **Setting name**, enter the alias of your choice. You will use this alias to connect to the remote cluster later. It must be lowercase and only contain letters, numbers, dashes and underscores.
21+
* For the **Secret**, paste the encoded cross-cluster API key.
22+
23+
2. Click **Add** to save the API key to the keystore.
24+
3. Repeat these steps for each API key you want to add. For example, if you want to use several clusters of the remote environment for CCR or CCS.
25+
26+
8. Add the CA certificate of the remote deployment or cluster.
27+
9. Provide a name for the trusted environment. That name will appear in the trust summary of your deployment's **Security** page.
28+
10. Select **Create trust** to complete the configuration.
29+
11. Restart the local deployment to reload the keystore with its new setting. To do that, go to the deployment's main page, locate the **Actions** menu, and select **Restart {{es}}**.
30+
31+
::::{note}
32+
If the local deployment runs on version 8.14 or greater, you no longer need to perform this step because the keystore is reloaded automatically with the new API keys.
33+
::::
34+
35+
If you need to update the remote connection with different permissions later, refer to [Change a cross-cluster API key used for a remote connection](/deploy-manage/remote-clusters/ece-edit-remove-trusted-environment.md#ece-edit-remove-trusted-environment-api-key).
36+

deploy-manage/remote-clusters/_snippets/apikeys-local-ece-remote-public.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@
1313

1414
2. Click **Add** to save the API key to the keystore.
1515

16-
5. Restart the local deployment to reload the keystore with its new setting. To do that, go to the deployment's main page (named after your deployment's name), locate the **Actions** menu, and select **Restart {{es}}**.<br>
16+
5. Restart the local deployment to reload the keystore with its new setting. To do that, go to the deployment's main page (named after your deployment's name), locate the **Actions** menu, and select **Restart {{es}}**.
1717

1818
::::{note}
1919
If the local deployment runs on version 8.14 or greater, you no longer need to perform this step because the keystore is reloaded automatically with the new API keys.
2020
::::
2121

22-
2322
If you need to update the remote connection with different permissions later, refer to [Change a cross-cluster API key used for a remote connection](/deploy-manage/remote-clusters/ece-edit-remove-trusted-environment.md#ece-edit-remove-trusted-environment-api-key).
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
This snippet is in use in the following locations:
3+
- xxx
4+
5+
It requires remote_type substitution to be defined
6+
-->
7+
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
8+
2. On the home page, find your hosted deployment and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the **Hosted deployments** page to view all of your deployments.
9+
10+
On the **Hosted deployments** page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
11+
12+
3. From the navigation menu, select **Security**.
13+
4. Select **Remote Connections > Add trusted environment** and choose **{{remote_type}}**. Then click **Next**.
14+
5. Select **API keys** as authentication mechanism and click **Next**.
15+
6. When asked whether the Certificate Authority (CA) of the remote environment’s proxy or load-balancing infrastructure is public, select **No, it is private**.
16+
7. Add the API key:
17+
18+
1. Fill both fields.
19+
20+
* For the **Remote cluster name**, enter the alias of your choice. You will use this alias to connect to the remote cluster later. It must be lowercase and only contain letters, numbers, dashes and underscores.
21+
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.
22+
23+
2. Click **Add** to save the API key to the keystore.
24+
3. Repeat these steps for each API key you want to add. For example, if you want to use several clusters of the remote environment for CCR or CCS.
25+
26+
8. Add the CA certificate of the remote deployment or cluster.
27+
9. Provide a name for the trusted environment. That name will appear in the trust summary of your deployment's **Security** page.
28+
10. Select **Create trust** to complete the configuration.
29+
11. Restart the local deployment to reload the keystore with its new setting. To do that, go to the deployment's main page, locate the **Actions** menu, and select **Restart {{es}}**.
30+
31+
::::{note}
32+
If the local deployment runs on version 8.14 or greater, you no longer need to perform this step because the keystore is reloaded automatically with the new API keys.
33+
::::
34+
35+
If you need to update the remote connection with different permissions later, refer to [Change a cross-cluster API key used for a remote connection](/deploy-manage/remote-clusters/ec-edit-remove-trusted-environment.md#ec-edit-remove-trusted-environment-api-key).

deploy-manage/remote-clusters/_snippets/apikeys-local-ech-remote-public.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@
1313

1414
2. Click **Add** to save the API key.
1515

16-
5. Restart the local deployment to reload the new setting. To do that, go to the deployment's main page (named after your deployment's name), locate the **Actions** menu, and select **Restart {{es}}**.<br>
16+
5. Restart the local deployment to reload the new setting. To do that, go to the deployment's main page (named after your deployment's name), locate the **Actions** menu, and select **Restart {{es}}**.
1717

1818
::::{note}
1919
If the local deployment runs on version 8.14 or greater, you no longer need to perform this step because the keystore is reloaded automatically with the new API keys.
2020
::::
2121

22-
2322
If you need to update the remote connection with different permissions later, refer to [Change a cross-cluster API key used for a remote connection](/deploy-manage/remote-clusters/ec-edit-remove-trusted-environment.md#ec-edit-remove-trusted-environment-api-key).

deploy-manage/remote-clusters/_snippets/rcs-elasticsearch-api-snippet-self.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
This snippet is in use in the following locations:
33
- ece-remote-cluster-self-managed.md
44
- ec-remote-cluster-self-managed.md
5+
- ece-enable-ccs-for-eck.md
6+
- ec-enable-ccs-for-eck.md
57
-->
6-
To configure a self-managed cluster 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:
8+
To add 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:
79

810
* `Remote cluster alias`: When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI as **Remote cluster name**.
911
* `mode`: `proxy`
10-
* `proxy_address`: Enter the endpoint of the remote self-managed cluster, including the hostname, FQDN, or IP address, and the port. Both IPv4 and IPv6 addresses are supported.
12+
* `proxy_address`: Enter the endpoint of the remote cluster, including the hostname, FQDN, or IP address, and the port. Both IPv4 and IPv6 addresses are supported.
1113

1214
Make sure you use the correct port for your authentication method:
1315
* **API keys**: Use the port configured in the remote cluster interface of the remote cluster (defaults to `9443`).

deploy-manage/remote-clusters/_snippets/rcs-elasticsearch-api-snippet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ To configure a deployment as a remote cluster, use the [cluster update settings
1313

1414
* `Remote cluster alias`: When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI as **Remote cluster name**.
1515
* `mode`: `proxy`
16-
* `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.
16+
* `proxy_address`: This value can be found on the **Security** page of the {{remote_type}} deployment you want to use as a remote. Copy the **Proxy address** from the **Remote cluster parameters** section.
1717

1818
Using the API, this value can be obtained from the {{es}} resource info, concatenating the field `metadata.endpoint` and port `9400` using a semicolon.
1919

2020
::::{note}
2121
If you’re using API keys as security model, change the port to `9443`.
2222
::::
2323

24-
* `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.
24+
* `server_name`: This value can be found on the **Security** page of the {{remote_type}} deployment you want to use as a remote. Copy the **Server name** from the **Remote cluster parameters** section.
2525

2626
Using the API, this can be obtained from the {{es}} resource info field `metadata.endpoint`.
2727

deploy-manage/remote-clusters/_snippets/rcs-kibana-api-snippet-self.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
This snippet is in use in the following locations:
33
- ece-remote-cluster-self-managed.md
44
- ec-remote-cluster-self-managed.md
5+
- ece-enable-ccs-for-eck.md
6+
- ec-enable-ccs-for-eck.md
57
-->
68
1. Go to the **Remote Clusters** management page in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
79
2. Select **Add a remote cluster**.
@@ -12,7 +14,7 @@ This snippet is in use in the following locations:
1214
* **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.
1315

1416
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
15-
* **Remote address**: Enter the endpoint of the remote self-managed cluster, including the hostname, FQDN, or IP address, and the port.
17+
* **Remote address**: Enter the endpoint of the remote cluster, including the hostname, FQDN, or IP address, and the port.
1618

1719
Make sure you use the correct port for your authentication method:
1820
* **API keys**: Use the port configured in the remote cluster interface of the remote cluster (defaults to `9443`).

deploy-manage/remote-clusters/_snippets/rcs-kibana-api-snippet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ It requires remote_type substitution to be defined
1818

1919
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
2020

21-
* **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.
21+
* **Remote address**: This value can be found on the **Security** page of the {{remote_type}} deployment you want to use as a remote. Copy the **Proxy address** from the **Remote cluster parameters** section.
2222

2323
::::{note}
2424
If you’re using API keys as security model, change the port to `9443`.
@@ -27,7 +27,7 @@ It requires remote_type substitution to be defined
2727
* **Configure advanced options** (optional): Expand this section if you need to customize additional settings.
2828
* **TLS server name**: Specify a value if the certificate presented by the remote cluster is signed for a different name than the remote address.
2929

30-
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.
30+
This value can be found on the **Security** page of the {{remote_type}} deployment you want to use as a remote. Copy the **Server name** from the **Remote cluster parameters** section.
3131

3232
* **Socket connections**: Define the number of connections to open with the remote cluster.
3333

deploy-manage/remote-clusters/ec-remote-cluster-ece.md

Lines changed: 12 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ applies_to:
99
products:
1010
- id: cloud-hosted
1111
sub:
12-
remote_type: Elastic Cloud Enterprise deployment
12+
remote_type: Elastic Cloud Enterprise
1313
---
1414

1515
# Connect {{ech}} deployments to an {{ece}} environment [ec-remote-cluster-ece]
@@ -58,47 +58,24 @@ The steps to follow depend on whether the Certificate Authority (CA) of the remo
5858

5959
::::
6060

61-
6261
::::{dropdown} The CA is private
63-
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
64-
2. On the home page, find your hosted deployment and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the **Hosted deployments** page to view all of your deployments.
65-
66-
On the **Hosted deployments** page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
67-
68-
3. Access the **Security** page of the deployment.
69-
4. Select **Remote Connections > Add trusted environment** and choose **{{ece}}**. Then click **Next**.
70-
5. Select **API keys** as authentication mechanism and click **Next**.
71-
6. Add a the API key:
72-
73-
1. Fill both fields.
7462

75-
* For the **Remote cluster name**, enter the the alias of your choice. You will use this alias to connect to the remote cluster later. It must be lowercase and only contain letters, numbers, dashes and underscores.
76-
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.
63+
Before configuring the local deployment, retrieve the CA certificate of the remote {{ece}} environment’s proxy or load-balancing infrastructure. To find this certificate:
7764

78-
2. Click **Add** to save the API key to the keystore.
79-
3. Repeat these steps for each API key you want to add. For example, if you want to use several deployments of the remote environment for CCR or CCS.
65+
1. In the remote {{ece}} environment, go to **Platform > Settings > TLS certificates**.
66+
2. Select **Show certificate chain** under **Proxy**.
67+
3. Click **Copy root certificate** and paste it into a new file. The root certificate is the last certificate shown in the chain.
8068

81-
7. Add the CA certificate of the private proxy or load balancing infrastructure of the remote environment. To find this certificate:
69+
:::{image} /deploy-manage/images/cloud-remote-clusters-proxy-certificate.png
70+
:alt: Certificate to copy from the chain
71+
:::
8272

83-
1. In the remote {{ece}} environment, go to **Platform > Settings > TLS certificates**.
84-
2. Select **Show certificate chain** under **Proxy**.
85-
3. Click **Copy root certificate** and paste it into a new file. The root certificate is the last certificate shown in the chain.
86-
4. Save that file as `.crt`. It is now ready to be uploaded.
73+
4. Save that file as `.crt`.
8774

88-
:::{image} /deploy-manage/images/cloud-remote-clusters-proxy-certificate.png
89-
:alt: Certificate to copy from the chain
90-
:::
75+
You can now proceed to configure the local deployment. The CA file you just saved will be used in one of the following steps.
9176

92-
8. Provide a name for the trusted environment. That name will appear in the trust summary of your deployment’s **Security** page.
93-
9. Select **Create trust** to complete the configuration.
94-
10. Restart the local deployment to reload the keystore with its new setting. To do that, go to the deployment’s main page (named after your deployment’s name), locate the **Actions** menu, and select **Restart {{es}}**.<br>
95-
96-
::::{note}
97-
If the local deployment runs on version 8.14 or greater, you no longer need to perform this step because the keystore is reloaded automatically with the new API keys.
98-
::::
99-
100-
101-
If you need to update the remote connection with different permissions later, refer to [Change a cross-cluster API key used for a remote connection](ec-edit-remove-trusted-environment.md#ec-edit-remove-trusted-environment-api-key).
77+
:::{include} _snippets/apikeys-local-ech-remote-private.md
78+
:::
10279

10380
::::
10481
::::::

deploy-manage/remote-clusters/ec-remote-cluster-other-ess.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ applies_to:
88
products:
99
- id: cloud-hosted
1010
sub:
11-
remote_type: Elastic Cloud Hosted deployment
11+
remote_type: Elastic Cloud Hosted
1212
---
1313

1414
# Connect to deployments in another {{ecloud}} organization [ec-remote-cluster-other-ess]

0 commit comments

Comments
 (0)