Skip to content

Commit 00263ab

Browse files
eedugoneedugon
authored
remote clusters UI api key and alias updates (#2966)
Fixes #1642
1 parent e5d9fab commit 00263ab

8 files changed

+83
-40
lines changed

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ The steps to follow depend on whether the Certificate Authority (CA) of the remo
6161
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.
6262

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

66-
1. Add a setting:
66+
1. Fill both fields.
6767

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

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

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

9696
1. Fill both fields.
9797

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

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

204-
* **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.
204+
* **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.
205+
206+
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
205207
* **Proxy address**: This value can be found on the **Security** page of the {{ech}} deployment you want to use as a remote.<br>
206208

207209
::::{tip}
@@ -251,6 +253,9 @@ PUT /_cluster/settings
251253
}
252254
```
253255

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

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

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ The API key created previously will be used by the local deployment to authentic
6161
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.
6262

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

6666
1. Fill both fields.
6767

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

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

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

146-
* **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.
146+
* **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.
147+
148+
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
147149
* **Proxy address**: This value can be found on the **Security** page of the {{ech}} deployment you want to use as a remote.<br>
148150

149151
::::{tip}
@@ -193,6 +195,10 @@ PUT /_cluster/settings
193195
}
194196
```
195197

198+
::::{note}
199+
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
200+
::::
201+
196202
### Using the {{ecloud}} RESTful API [ec_using_the_elasticsearch_service_restful_api_2]
197203

198204
::::{note}

‎deploy-manage/remote-clusters/ec-remote-cluster-same-ess.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ The API key created previously will be used by the local deployment to authentic
6161
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.
6262

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

6666
1. Fill both fields.
6767

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

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

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

175-
* **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.
175+
* **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.
176+
177+
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
176178
* **Proxy address**: This value can be found on the **Security** page of the {{ech}} deployment you want to use as a remote.<br>
177179

178180
::::{tip}
@@ -222,6 +224,9 @@ PUT /_cluster/settings
222224
}
223225
```
224226

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

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

‎deploy-manage/remote-clusters/ec-remote-cluster-self-managed.md‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ The steps to follow depend on whether the Certificate Authority (CA) of the remo
6161
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.
6262

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

66-
1. Add a setting:
66+
1. Fill both fields.
6767

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

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

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

9696
1. Fill both fields.
9797

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

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

228-
* **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.
228+
* **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.
229+
230+
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
229231
* **Proxy address**: This value can be found on the **Security** page of the {{ech}} deployment you want to use as a remote.<br>
230232

231233
::::{tip}
@@ -275,6 +277,10 @@ PUT /_cluster/settings
275277
}
276278
```
277279

280+
::::{note}
281+
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
282+
::::
283+
278284
### Using the {{ecloud}} RESTful API [ec_using_the_elasticsearch_service_restful_api_4]
279285

280286
::::{note}

‎deploy-manage/remote-clusters/ece-remote-cluster-ece-ess.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ The API key created previously will be used by the local deployment to authentic
5757
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
5858

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

6262
1. Fill both fields.
6363

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

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

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

147-
* **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.
147+
* **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.
148+
149+
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
148150
* **Proxy address**: This value can be found on the **Security** page of the {{ece}} deployment you want to use as a remote.<br>
149151

150152
::::{tip}
@@ -204,6 +206,10 @@ PUT /_cluster/settings
204206
}
205207
```
206208

209+
::::{note}
210+
When using API key authentication, the cluster alias must match the one you configured when adding the API key in the Cloud UI.
211+
::::
212+
207213
### Using the {{ece}} RESTful API [ece_using_the_elastic_cloud_enterprise_restful_api_3]
208214

209215
::::{note}

‎deploy-manage/remote-clusters/ece-remote-cluster-other-ece.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ The steps to follow depend on whether the Certificate Authority (CA) of the remo
5959
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
6060

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

64-
1. Add a setting:
64+
1. Fill both fields.
6565

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

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

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

220-
* **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.
220+
* **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.
221+
222+
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
221223
* **Proxy address**: This value can be found on the **Security** page of the {{ece}} deployment you want to use as a remote.<br>
222224

223225
::::{tip}
@@ -277,6 +279,9 @@ PUT /_cluster/settings
277279
}
278280
```
279281

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

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

‎deploy-manage/remote-clusters/ece-remote-cluster-same-ece.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ The API key created previously will be used by the local deployment to authentic
5757
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
5858

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

6262
1. Fill both fields.
6363

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

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

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

176-
* **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.
176+
* **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.
177+
178+
When using API key authentication, this alias must match the **Remote cluster name** you configured when adding the API key in the Cloud UI.
177179
* **Proxy address**: This value can be found on the **Security** page of the {{ece}} deployment you want to use as a remote.<br>
178180

179181
::::{tip}
@@ -233,6 +235,9 @@ PUT /_cluster/settings
233235
}
234236
```
235237

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

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

0 commit comments

Comments
 (0)