Skip to content

Commit 10934b3

Browse files
authored
Fix missing remote_cluster docs (#116366) (#116439)
Documentation for the remote_cluster in the role was added in #111682 and #108840, but a few places were missed. This commit fill the gaps in the documentation.
1 parent fca2f43 commit 10934b3

File tree

5 files changed

+33
-8
lines changed

5 files changed

+33
-8
lines changed

docs/reference/modules/cluster/remote-clusters-migration.asciidoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@ indices that were created from the auto-follow pattern.
6666
On the local cluster:
6767

6868
. Enhance any roles used by local cluster users with the required
69-
<<roles-remote-indices-priv,remote indices privileges>> for {ccr} and {ccs}.
69+
<<roles-remote-indices-priv,remote indices privileges>> or
70+
<<roles-remote-cluster-priv, remote cluster privileges>> for {ccr} and {ccs}.
7071
Refer to <<remote-clusters-privileges-api-key>>. Note:
7172

72-
** You only need to assign additional `remote_indices` privileges to existing
73+
** You only need to assign additional `remote_indices` or `remote_cluster` privileges to existing
7374
roles used for cross-cluster operations. You should be able to copy these
7475
privileges from the original roles on the remote cluster, where they are defined
7576
under the certification based security model.
@@ -197,7 +198,7 @@ authentication.
197198
Resume any persistent tasks that you stopped earlier. Tasks should be restarted
198199
by the same user or API key that created the task before the migration. Ensure
199200
the roles of this user or API key have been updated with the required
200-
`remote_indices` privileges. For users, tasks capture the caller's credentials
201+
`remote_indices` or `remote_cluster` privileges. For users, tasks capture the caller's credentials
201202
when started and run in that user's security context. For API keys, restarting a
202203
task will update the task with the updated API key.
203204

@@ -246,7 +247,7 @@ If you need to roll back, follow these steps on the local cluster:
246247
. Remove the remote cluster definition by setting the remote cluster settings to
247248
`null`.
248249

249-
. Remove the `remote_indices` privileges from any roles that were updated during
250+
. Remove the `remote_indices` or 'remote_cluster' privileges from any roles that were updated during
250251
the migration.
251252

252253
. On each node, remove the `remote_cluster_client.ssl.*` settings from

docs/reference/modules/cluster/remote-clusters-troubleshooting.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ This does not show up in any logs.
399399

400400
====== Resolution
401401

402-
. Check that the local user has the necessary `remote_indices` privileges. Grant sufficient `remote_indices` privileges if necessary.
402+
. Check that the local user has the necessary `remote_indices` or `remote_cluster` privileges. Grant sufficient `remote_indices` or `remote_cluster` privileges if necessary.
403403
. If permission is not an issue locally, ask the remote cluster administrator to
404404
create and distribute a
405405
<<security-api-create-cross-cluster-api-key,cross-cluster API key>>. Replace the

docs/reference/rest-api/security/bulk-create-roles.asciidoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ that begin with `_` are reserved for system usage.
7575
For more information, see
7676
<<run-as-privilege>>.
7777
78-
`remote_indices`:: beta:[] (list) A list of remote indices permissions entries.
78+
`remote_indices`:: (list) A list of remote indices permissions entries.
7979
+
8080
--
8181
NOTE: Remote indices are effective for <<remote-clusters-api-key,remote clusters configured with the API key based model>>.
@@ -94,6 +94,18 @@ have on the specified indices.
9494
read access to. A document within the specified indices must match this query in
9595
order for it to be accessible by the owners of the role.
9696
97+
`remote_cluster`:: (list) A list of remote cluster permissions entries.
98+
+
99+
--
100+
NOTE: Remote cluster permissions are effective for <<remote-clusters-api-key,remote clusters configured with the API key based model>>.
101+
They have no effect for remote clusters configured with the <<remote-clusters-cert,certificate based model>>.
102+
--
103+
`clusters` (required)::: (list) A list of cluster aliases to which the permissions
104+
in this entry apply.
105+
`privileges`(required)::: (list) The cluster level privileges that the owners of the role
106+
have in the specified clusters.
107+
108+
97109
For more information, see <<defining-roles>>.
98110
====
99111

docs/reference/rest-api/security/create-roles.asciidoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,17 @@ have on the specified indices.
9696
read access to. A document within the specified indices must match this query in
9797
order for it to be accessible by the owners of the role.
9898

99+
`remote_cluster`:: (list) A list of remote cluster permissions entries.
100+
+
101+
--
102+
NOTE: Remote cluster permissions are effective for <<remote-clusters-api-key,remote clusters configured with the API key based model>>.
103+
They have no effect for remote clusters configured with the <<remote-clusters-cert,certificate based model>>.
104+
--
105+
`clusters` (required)::: (list) A list of cluster aliases to which the permissions
106+
in this entry apply.
107+
`privileges`(required)::: (list) The cluster level privileges that the owners of the role
108+
have in the specified clusters.
109+
99110
For more information, see <<defining-roles>>.
100111

101112
[[security-api-put-role-example]]

docs/reference/security/authentication/remote-clusters-privileges-api-key.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
=== Configure roles and users
33

44
To use a remote cluster for {ccr} or {ccs}, you need to create user roles with
5-
<<roles-remote-indices-priv,remote indices privileges>> on the local cluster.
5+
<<roles-remote-indices-priv,remote indices privileges>> or
6+
<<roles-remote-cluster-priv, remote cluster privileges>> on the local cluster.
67

78
You can manage users and roles from Stack Management in {kib} by selecting
89
*Security > Roles* from the side navigation. You can also use the
@@ -80,7 +81,7 @@ POST /_security/role/remote-search
8081
"privileges": [
8182
"read",
8283
"read_cross_cluster",
83-
"view_index_metadata"
84+
"view_index_metadata"
8485
]
8586
}
8687
]

0 commit comments

Comments
 (0)