Skip to content

Docs for monitor_stats privilege #116533

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
Nov 12, 2024
Merged

Docs for monitor_stats privilege #116533

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
7296e6c
wip
jakelandis Nov 8, 2024
22452ca
Merge remote-tracking branch 'upstream/main' into monitor_stats_docs
jakelandis Nov 8, 2024
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
4 changes: 3 additions & 1 deletion docs/reference/rest-api/security/bulk-create-roles.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,9 @@ They have no effect for remote clusters configured with the <<remote-clusters-ce
`clusters` (required)::: (list) A list of cluster aliases to which the permissions
in this entry apply.
`privileges`(required)::: (list) The cluster level privileges that the owners of the role
have in the specified clusters.
have in the specified clusters. Note - only a subset of the cluster privileges are supported for remote clusters.
The <<security-api-get-builtin-privileges-request, builtin privileges API>> can be used to determine
which privileges are allowed per version.


For more information, see <<defining-roles>>.
Expand Down
22 changes: 16 additions & 6 deletions docs/reference/rest-api/security/create-roles.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,9 @@ They have no effect for remote clusters configured with the <<remote-clusters-ce
`clusters` (required)::: (list) A list of cluster aliases to which the permissions
in this entry apply.
`privileges`(required)::: (list) The cluster level privileges that the owners of the role
have in the specified clusters.
have in the specified clusters. Note - only a subset of the cluster privileges are supported for remote clusters.
The <<security-api-get-builtin-privileges-request, builtin privileges API>> can be used to determine
which privileges are allowed per version.

For more information, see <<defining-roles>>.

Expand Down Expand Up @@ -176,21 +178,29 @@ POST /_security/role/cli_or_drivers_minimal
--------------------------------------------------
// end::sql-queries-permission[]

The following example configures a role with remote indices privileges on a remote cluster:
The following example configures a role with remote indices and remote cluster privileges for a remote cluster:
[source,console]
--------------------------------------------------
POST /_security/role/role_with_remote_indices
POST /_security/role/only_remote_access_role
{
"remote_indices": [
{
"clusters": [ "my_remote" ], <1>
"clusters": ["my_remote"], <1>
"names": ["logs*"], <2>
"privileges": ["read", "read_cross_cluster", "view_index_metadata"] <3>
}
],
"remote_cluster": [
{
"clusters": ["my_remote"], <1>
"privileges": ["monitor_stats"] <4>
}
]
}
--------------------------------------------------

<1> The remote indices privileges apply to remote cluster with the alias `my_remote`.
<2> Privileges are granted for indices matching pattern `logs*` on the remote cluster ( `my_remote`).
<1> The remote indices and remote cluster privileges apply to remote cluster with the alias `my_remote`.
<2> Privileges are granted for indices matching pattern `logs*` on the remote cluster (`my_remote`).
<3> The actual <<privileges-list-indices,index privileges>> granted for `logs*` on `my_remote`.
<4> The actual <<privileges-list-cluster,cluster privileges>> granted for `my_remote`.
Note - only a subset of the cluster privileges are supported for remote clusters.
8 changes: 3 additions & 5 deletions docs/reference/security/authorization/managing-roles.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,12 +249,10 @@ The following describes the structure of a remote cluster permissions entry:
<<api-multi-index,wildcards>> and <<regexp-syntax,regular expressions>>.
This field is required.
<2> The cluster level privileges for the remote cluster. The allowed values here are a subset of the
<<privileges-list-cluster,cluster privileges>>. This field is required.
<<privileges-list-cluster,cluster privileges>>.
The <<security-api-get-builtin-privileges-request, builtin privileges API>> can be used to determine
which privileges are allowed here. This field is required.

The `monitor_enrich` privilege for remote clusters was introduced in version
8.15.0. Currently, this is the only privilege available for remote clusters and
is required to enable users to use the `ENRICH` keyword in ES|QL queries across
clusters.

==== Example

Expand Down
5 changes: 5 additions & 0 deletions docs/reference/security/authorization/privileges.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,11 @@ Privileges to list and view details on existing repositories and snapshots.
+
This privilege is not available in {serverless-full}.

`monitor_stats`::
Privileges to list and view details of stats.
+
This privilege is not available in {serverless-full}.

`monitor_text_structure`::
All read-only operations related to the <<find-structure,find structure API>>.
+
Expand Down
Loading