Skip to content

remote clusters UI api key and alias updates #2966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 18, 2025
Merged

remote clusters UI api key and alias updates #2966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cb8c21
remote clusters UI api key and alias updates
eedugon Sep 16, 2025
7002de1
Merge branch 'main' into remote_clusters_api_key_ui
eedugon Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions deploy-manage/remote-clusters/ec-remote-cluster-ece.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ The steps to follow depend on whether the Certificate Authority (CA) of the remo
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.

3. From the navigation menu, select **Security**.
4. Locate **Remote connections** and select **Add API key**.
4. Locate **Remote Connections > Trust management > Connections using API keys** and select **Add API key**.

1. Add a setting:
1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

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

Expand Down Expand Up @@ -95,8 +95,8 @@ If you need to update the remote connection with different permissions later, re

1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

2. Click **Add** to save the API key to the keystore.
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.
Expand Down Expand Up @@ -201,7 +201,9 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

* **Name**: This *cluster alias* is a unique identifier that represents the connection to the remote cluster and is used to distinguish between local and remote indices.
* **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.
* **Proxy address**: This value can be found on the **Security** page of the {{ech}} deployment you want to use as a remote.<br>

::::{tip}
Expand Down Expand Up @@ -251,6 +253,9 @@ PUT /_cluster/settings
}
```

::::{note}
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
::::

### Using the {{ecloud}} RESTful API [ec_using_the_elasticsearch_service_restful_api_3]

Expand Down
14 changes: 10 additions & 4 deletions deploy-manage/remote-clusters/ec-remote-cluster-other-ess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ The API key created previously will be used by the local deployment to authentic
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.

3. From the navigation menu, select **Security**.
4. Locate **Remote connections** and select **Add API key**.
4. Locate **Remote Connections > Trust management > Connections using API keys** and select **Add API key**.

1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

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

Expand Down Expand Up @@ -143,7 +143,9 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

* **Name**: This *cluster alias* is a unique identifier that represents the connection to the remote cluster and is used to distinguish between local and remote indices.
* **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.
* **Proxy address**: This value can be found on the **Security** page of the {{ech}} deployment you want to use as a remote.<br>

::::{tip}
Expand Down Expand Up @@ -193,6 +195,10 @@ PUT /_cluster/settings
}
```

::::{note}
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
::::

### Using the {{ecloud}} RESTful API [ec_using_the_elasticsearch_service_restful_api_2]

::::{note}
Expand Down
13 changes: 9 additions & 4 deletions deploy-manage/remote-clusters/ec-remote-cluster-same-ess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ The API key created previously will be used by the local deployment to authentic
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.

3. From the navigation menu, select **Security**.
4. Locate **Remote connections** and select **Add API key**.
4. Locate **Remote Connections > Trust management > Connections using API keys** and select **Add API key**.

1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

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

Expand Down Expand Up @@ -172,7 +172,9 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

* **Name**: This *cluster alias* is a unique identifier that represents the connection to the remote cluster and is used to distinguish between local and remote indices.
* **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.
* **Proxy address**: This value can be found on the **Security** page of the {{ech}} deployment you want to use as a remote.<br>

::::{tip}
Expand Down Expand Up @@ -222,6 +224,9 @@ PUT /_cluster/settings
}
```

::::{note}
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
::::

### Using the {{ecloud}} RESTful API [ec_using_the_elasticsearch_service_restful_api]

Expand Down
20 changes: 13 additions & 7 deletions deploy-manage/remote-clusters/ec-remote-cluster-self-managed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ The steps to follow depend on whether the Certificate Authority (CA) of the remo
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.

3. From the navigation menu, select **Security**.
4. Locate **Remote connections** and select **Add API key**.
4. Locate **Remote Connections > Trust management > Connections using API keys** and select **Add API key**.

1. Add a setting:
1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

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

Expand Down Expand Up @@ -95,8 +95,8 @@ If you need to update the remote connection with different permissions later, re

1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

2. Click **Add** to save the API key to the keystore.
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.
Expand Down Expand Up @@ -225,7 +225,9 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

* **Name**: This *cluster alias* is a unique identifier that represents the connection to the remote cluster and is used to distinguish between local and remote indices.
* **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.
* **Proxy address**: This value can be found on the **Security** page of the {{ech}} deployment you want to use as a remote.<br>

::::{tip}
Expand Down Expand Up @@ -275,6 +277,10 @@ PUT /_cluster/settings
}
```

::::{note}
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
::::

### Using the {{ecloud}} RESTful API [ec_using_the_elasticsearch_service_restful_api_4]

::::{note}
Expand Down
14 changes: 10 additions & 4 deletions deploy-manage/remote-clusters/ece-remote-cluster-ece-ess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ The API key created previously will be used by the local deployment to authentic
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.

3. From the deployment menu, select **Security**.
4. Locate **Remote connections** and select **Add an API key**.
4. Locate **Remote Connections > Trust management > Connections using API keys** and select **Add API key**.

1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

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

Expand Down Expand Up @@ -144,7 +144,9 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

* **Name**: This *cluster alias* is a unique identifier that represents the connection to the remote cluster and is used to distinguish between local and remote indices.
* **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.
* **Proxy address**: This value can be found on the **Security** page of the {{ece}} deployment you want to use as a remote.<br>

::::{tip}
Expand Down Expand Up @@ -204,6 +206,10 @@ PUT /_cluster/settings
}
```

::::{note}
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
::::

### Using the {{ece}} RESTful API [ece_using_the_elastic_cloud_enterprise_restful_api_3]

::::{note}
Expand Down
15 changes: 10 additions & 5 deletions deploy-manage/remote-clusters/ece-remote-cluster-other-ece.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ The steps to follow depend on whether the Certificate Authority (CA) of the remo
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.

3. From the deployment menu, select **Security**.
4. Locate **Remote connections** and select **Add an API key**.
4. Locate **Remote Connections > Trust management > Connections using API keys** and select **Add API key**.

1. Add a setting:
1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

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

Expand Down Expand Up @@ -217,7 +217,9 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

* **Name**: This *cluster alias* is a unique identifier that represents the connection to the remote cluster and is used to distinguish between local and remote indices.
* **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.
* **Proxy address**: This value can be found on the **Security** page of the {{ece}} deployment you want to use as a remote.<br>

::::{tip}
Expand Down Expand Up @@ -277,6 +279,9 @@ PUT /_cluster/settings
}
```

::::{note}
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
::::

### Using the {{ece}} RESTful API [ece_using_the_elastic_cloud_enterprise_restful_api_2]

Expand Down
13 changes: 9 additions & 4 deletions deploy-manage/remote-clusters/ece-remote-cluster-same-ece.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ The API key created previously will be used by the local deployment to authentic
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.

3. From the deployment menu, select **Security**.
4. Locate **Remote connections** and select **Add an API key**.
4. Locate **Remote Connections > Trust management > Connections using API keys** and select **Add API key**.

1. Fill both fields.

* For the **Setting 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.
* For the **Secret**, paste the encoded cross-cluster API key.
* 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.
* For the **Cross-cluster API key**, paste the encoded cross-cluster API key.

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

Expand Down Expand Up @@ -173,7 +173,9 @@ On the local cluster, add the remote cluster using {{kib}} or the {{es}} API.
2. Enable **Manually enter proxy address and server name**.
3. Fill in the following fields:

* **Name**: This *cluster alias* is a unique identifier that represents the connection to the remote cluster and is used to distinguish between local and remote indices.
* **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.
* **Proxy address**: This value can be found on the **Security** page of the {{ece}} deployment you want to use as a remote.<br>

::::{tip}
Expand Down Expand Up @@ -233,6 +235,9 @@ PUT /_cluster/settings
}
```

::::{note}
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
::::

### Using the {{ece}} RESTful API [ece_using_the_elastic_cloud_enterprise_restful_api]

Expand Down
Loading
Loading