Skip to content

Commit d7e02b1

Browse files
eedugoneedugon
committed
manage trusted environments converted to snippets
1 parent 51e1b0e commit d7e02b1

10 files changed

+87
-130
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,5 @@ It requires remote_type substitution to be defined
3333
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.
3434
::::
3535

36-
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+
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#edit-remove-trusted-environment-api-key).
3737

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ This snippet is in use in the following locations:
2626
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.
2727
::::
2828

29-
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).
29+
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#edit-remove-trusted-environment-api-key).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ It requires remote_type substitution to be defined
3333
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.
3434
::::
3535

36-
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).
36+
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#edit-remove-trusted-environment-api-key).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ This snippet is in use in the following locations:
2626
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.
2727
::::
2828

29-
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).
29+
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#edit-remove-trusted-environment-api-key).

‎deploy-manage/remote-clusters/_snippets/trusted-environment-change-api-key.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
This section describes the steps to change the API key used for an existing remote connection. For example, if the previous key expired and you need to rotate it with a new one.
2+
3+
::::{note}
4+
If you need to update the permissions granted by a cross-cluster API key for a remote connection, you only need to update the privileges granted by the API key directly in {{kib}}.
5+
::::
6+
7+
8+
1. On the deployment you will use as remote, use the [{{es}} API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) or [{{kib}}](../api-keys/elasticsearch-api-keys.md) to create a cross-cluster API key with the appropriate permissions. Configure it with access to the indices you want to use for {{ccs}} or {{ccr}}.
9+
2. Copy the encoded key (`encoded` in the response) to a safe location. You will need it in the next steps.
10+
3. From the navigation menu, select **Security** and locate the **Remote connections** section.
11+
4. Locate the API key currently used for connecting to the remote cluster, copy its current alias, and delete it.
12+
5. Add the new API key by selecting **Add API key**.
13+
14+
* For the **Remote cluster name**, enter the same alias that was used for the previous key.
15+
16+
::::{note}
17+
If you use a different alias, you also need to re-create the remote cluster in {{kib}} with a **Name** that matches the new alias.
18+
::::
19+
20+
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key, then click **Add** to save the API key to the keystore.
21+
22+
6. 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>
23+
24+
::::{note}
25+
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.
26+
::::
27+

‎deploy-manage/remote-clusters/_snippets/trusted-environment-manage.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
From a deployment's **Security** page, you can manage trusted environments that were created previously. This can happen when:
2+
3+
* You no longer need a trusted environment and want to remove it.
4+
* You want to refresh the certificate, or add or remove trusted deployments of an existing trusted environment relying on certificates as a security model.
5+
* You want to remove or update the access level granted by a cross-cluster API key.
6+

‎deploy-manage/remote-clusters/_snippets/trusted-environment-remove-cert.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
By removing a trusted environment, this deployment will no longer be able to establish remote connections using certificate trust to clusters of that environment. The remote environment will also no longer be able to connect to this deployment using certificate trust.
2+
3+
::::{note}
4+
With this method, you can only remove trusted environments relying exclusively on certificates. To remove remote connections that use API keys for authentication, refer to [Change a cross-cluster API key used for a remote connection](#edit-remove-trusted-environment-api-key).
5+
::::
6+
7+
1. Go to the deployment's **Security** page.
8+
2. In the list of trusted environments, locate the one you want to remove.
9+
3. Remove it using the corresponding `delete` icon.
10+
11+
:::{image} /deploy-manage/images/cloud-delete-trust-environment.png
12+
:alt: button for deleting a trusted environment
13+
:::
14+
15+
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).
16+
2. In the list of existing remote clusters, delete the ones corresponding to the trusted environment you removed earlier.
17+

‎deploy-manage/remote-clusters/_snippets/trusted-environment-update-cert.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
1. Go to the deployment's **Security** page.
2+
2. In the list of trusted environments, locate the one you want to edit.
3+
3. Open its details by selecting the `Edit` icon.
4+
5+
:::{image} /deploy-manage/images/cloud-edit-trust-environment.png
6+
:alt: button for editing a trusted environment
7+
:::
8+
9+
4. Edit the trust configuration for that environment:
10+
11+
* From the **Trust level** tab, you can add or remove trusted deployments.
12+
* From the **Environment settings** tab, you can manage the certificates and the label of the environment.
13+
14+
5. Save your changes.
15+

‎deploy-manage/remote-clusters/ec-edit-remove-trusted-environment.md‎

Lines changed: 9 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -11,77 +11,23 @@ products:
1111

1212
# Manage trusted environments for remote connections in {{ech}} [ec-edit-remove-trusted-environment]
1313

14-
From a deployment’s **Security** page, you can manage trusted environments that were created previously. This can happen when:
15-
16-
* You no longer need a trusted environment and want to remove it.
17-
* You want to refresh the certificate, or add or remove trusted deployments of an existing trusted environment relying on certificates as a security model.
18-
* You want to remove or update the access level granted by a cross-cluster API key.
14+
:::{include} _snippets/trusted-environment-manage.md
15+
:::
1916

2017

2118
## Remove a certificate-based trusted environment [ec_remove_a_trusted_environment]
2219

23-
By removing a trusted environment, this deployment will no longer be able to establish remote connections using certificate trust to clusters of that environment. The remote environment will also no longer be able to connect to this deployment using certificate trust.
24-
25-
::::{note}
26-
With this method, you can only remove trusted environments relying exclusively on certificates. To remove remote connections that use API keys for authentication, refer to [Change a cross-cluster API key used for a remote connection](#ec-edit-remove-trusted-environment-api-key).
27-
::::
28-
29-
30-
1. Go to the deployment’s **Security** page.
31-
2. In the list of trusted environments, locate the one you want to remove.
32-
3. Remove it using the corresponding `delete` icon.
33-
34-
:::{image} /deploy-manage/images/cloud-delete-trust-environment.png
35-
:alt: button for deleting a trusted environment
36-
:::
37-
38-
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).
39-
2. In the list of existing remote clusters, delete the ones corresponding to the trusted environment you removed earlier.
20+
:::{include} _snippets/trusted-environment-remove-cert.md
21+
:::
4022

4123

4224
## Update a certificate-based trusted environment [ec_update_a_certificate_based_trusted_environment]
4325

44-
1. Go to the deployment’s **Security** page.
45-
2. In the list of trusted environments, locate the one you want to edit.
46-
3. Open its details by selecting the `Edit` icon.
47-
48-
:::{image} /deploy-manage/images/cloud-edit-trust-environment.png
49-
:alt: button for editing a trusted environment
50-
:::
51-
52-
4. Edit the trust configuration for that environment:
53-
54-
* From the **Trust level** tab, you can add or remove trusted deployments.
55-
* From the **Environment settings** tab, you can manage the certificates and the label of the environment.
56-
57-
5. Save your changes.
58-
59-
60-
## Change a cross-cluster API key used for a remote connection [ec-edit-remove-trusted-environment-api-key]
61-
62-
This section describes the steps to change the API key used for an existing remote connection. For example, if the previous key expired and you need to rotate it with a new one.
63-
64-
::::{note}
65-
If you need to update the permissions granted by a cross-cluster API key for a remote connection, you only need to update the privileges granted by the API key directly in {{kib}}.
66-
::::
67-
68-
69-
1. On the deployment you will use as remote, use the [{{es}} API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) or [{{kib}}](../api-keys/elasticsearch-api-keys.md) to create a cross-cluster API key with the appropriate permissions. Configure it with access to the indices you want to use for {{ccs}} or {{ccr}}.
70-
2. Copy the encoded key (`encoded` in the response) to a safe location. You will need it in the next steps.
71-
3. From the navigation menu, select **Security** and locate the **Remote connections** section.
72-
4. Locate the API key currently used for connecting to the remote cluster, copy its current alias, and delete it.
73-
5. Add the new API key by selecting **Add API key**.
74-
75-
* For the **Remote cluster name**, enter the same alias that was used for the previous key.
76-
77-
::::{note}
78-
If you use a different alias, you also need to re-create the remote cluster in {{kib}} with a **Name** that matches the new alias.
79-
::::
26+
:::{include} _snippets/trusted-environment-update-cert.md
27+
:::
8028

81-
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key, then click **Add** to save the API key to the keystore.
8229

83-
6. 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>
30+
## Change a cross-cluster API key used for a remote connection [edit-remove-trusted-environment-api-key]
8431

85-
::::{note}
86-
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.
87-
::::
32+
:::{include} _snippets/trusted-environment-change-api-key.md
33+
:::

‎deploy-manage/remote-clusters/ece-edit-remove-trusted-environment.md‎

Lines changed: 9 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -11,77 +11,23 @@ products:
1111

1212
# Manage trusted environments for remote connections in {{ece}} [ece-edit-remove-trusted-environment]
1313

14-
From a deployment’s **Security** page, you can manage trusted environments that were created previously. This can happen when:
15-
16-
* You no longer need a trusted environment and want to remove it.
17-
* You want to refresh the certificate, or add or remove trusted deployments of an existing trusted environment relying on certificates as a security model.
18-
* You want to remove or update the access level granted by a cross-cluster API key.
14+
:::{include} _snippets/trusted-environment-manage.md
15+
:::
1916

2017

2118
## Remove a certificate-based trusted environment [ece_remove_a_trusted_environment]
2219

23-
By removing a trusted environment, this deployment will no longer be able to establish remote connections using certificate trust to clusters of that environment. The remote environment will also no longer be able to connect to this deployment using certificate trust.
24-
25-
::::{note}
26-
With this method, you can only remove trusted environments relying exclusively on certificates. To remove remote connections that use API keys for authentication, refer to [Update the access level of a remote cluster connection relying on a cross-cluster API key](#ece-edit-remove-trusted-environment-api-key).
27-
::::
28-
29-
30-
1. Go to the deployment’s **Security** page.
31-
2. In the list of trusted environments, locate the one you want to remove.
32-
3. Remove it using the corresponding `delete` icon.
33-
34-
:::{image} /deploy-manage/images/cloud-enterprise-delete-trust-environment.png
35-
:alt: button for deleting a trusted environment
36-
:::
37-
38-
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).
39-
2. In the list of existing remote clusters, delete the ones corresponding to the trusted environment you removed earlier.
20+
:::{include} _snippets/trusted-environment-remove-cert.md
21+
:::
4022

4123

4224
## Update a certificate-based trusted environment [ece_update_a_certificate_based_trusted_environment]
4325

44-
1. Go to the deployment’s **Security** page.
45-
2. In the list of trusted environments, locate the one you want to edit.
46-
3. Open its details by selecting the `Edit` icon.
47-
48-
:::{image} /deploy-manage/images/cloud-enterprise-edit-trust-environment.png
49-
:alt: button for editing a trusted environment
50-
:::
51-
52-
4. Edit the trust configuration for that environment:
53-
54-
* From the **Trust level** tab, you can add or remove trusted deployments.
55-
* From the **Environment settings** tab, you can manage the certificates and the label of the environment.
56-
57-
5. Save your changes.
58-
59-
60-
## Change a cross-cluster API key used for a remote connection [ece-edit-remove-trusted-environment-api-key]
61-
62-
This section describes the steps to change the API key used for an existing remote connection. For example, if the previous key expired and you need to rotate it with a new one.
63-
64-
::::{note}
65-
If you need to update the permissions granted by a cross-cluster API key for a remote connection, you only need to update the privileges granted by the API key directly in {{kib}}.
66-
::::
67-
68-
69-
1. On the deployment you will use as remote, use the [{{es}} API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) or [{{kib}}](../api-keys/elasticsearch-api-keys.md) to create a cross-cluster API key with the appropriate permissions. Configure it with access to the indices you want to use for {{ccs}} or {{ccr}}.
70-
2. Copy the encoded key (`encoded` in the response) to a safe location. You will need it in the next steps.
71-
3. From the navigation menu, select **Security** and locate the **Remote connections** section.
72-
4. Locate the API key currently used for connecting to the remote cluster, copy its current alias, and delete it.
73-
5. Add the new API key by selecting **Add API key**.
74-
75-
* For the **Remote cluster name**, enter the same alias that was used for the previous key.
76-
77-
::::{note}
78-
If you use a different alias, you also need to re-create the remote cluster in {{kib}} with a **Name** that matches the new alias.
79-
::::
26+
:::{include} _snippets/trusted-environment-update-cert.md
27+
:::
8028

81-
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key, then click **Add** to save the API key to the keystore.
8229

83-
6. 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>
30+
## Change a cross-cluster API key used for a remote connection [edit-remove-trusted-environment-api-key]
8431

85-
::::{note}
86-
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.
87-
::::
32+
:::{include} _snippets/trusted-environment-change-api-key.md
33+
:::

0 commit comments

Comments
 (0)