Skip to content

[DOCS] Add operator privileges to APIs and settings #69903

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.

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 5 commits into from
Mar 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,12 @@ DELETE /_autoscaling/policy/<name>
[[autoscaling-delete-autoscaling-policy-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`manage_autoscaling` cluster privileges. For more information, see
<<security-privileges>>.
* If the {es} {security-features} are enabled, you must have the
`manage_autoscaling` <<privileges-list-cluster,cluster privilege>> to use this
API.

* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
users can use this API.

[[autoscaling-delete-autoscaling-policy-desc]]
==== {api-description-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,12 @@ DELETE /_autoscaling/policy/name
[[autoscaling-put-autoscaling-policy-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have
`manage_autoscaling` cluster privileges. For more information, see
<<security-privileges>>.
* If the {es} {security-features} are enabled, you must have the
`manage_autoscaling` <<privileges-list-cluster,cluster privilege>> to use this
API.

* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
users can use this API.

[[autoscaling-put-autoscaling-policy-desc]]
==== {api-description-title}
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/cluster/voting-exclusions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Adds or removes master-eligible nodes from the
* If the {es} {security-features} are enabled, you must have the `manage`
<<privileges-list-cluster,cluster privilege>> to use this API.

* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
users can use this API.

[[voting-config-exclusions-api-desc]]
==== {api-description-title}

Expand Down
12 changes: 7 additions & 5 deletions docs/reference/licensing/delete-license.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,14 @@ When your license expires, {xpack} operates in a degraded mode. For more
information, see
{kibana-ref}/managing-licenses.html#license-expiration[License expiration].

[discrete]
==== Authorization
[[delete-license-api-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have the `manage`
<<privileges-list-cluster,cluster privilege>> to use this API.

You must have `manage` cluster privileges to use this API.
For more information, see
<<security-privileges>>.
* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
users can use this API.

[discrete]
==== Examples
Expand Down
9 changes: 6 additions & 3 deletions docs/reference/licensing/update-license.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@ Updates the license for your {es} cluster.
[[update-license-api-prereqs]]
==== {api-prereq-title}

If {es} {security-features} are enabled, you need `manage` cluster privileges to
install the license.
* If {es} {security-features} are enabled, you need `manage`
<<privileges-list-cluster,cluster privilege>> to install the license.

If {es} {security-features} are enabled and you are installing a gold or higher
* If {es} {security-features} are enabled and you are installing a gold or higher
license, you must enable TLS on the transport networking layer before you
install the license. See <<configuring-tls>>.

* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
users can use this API.

[[update-license-api-desc]]
==== {api-description-title}

Expand Down
10 changes: 10 additions & 0 deletions docs/reference/snapshot-restore/apis/repo-analysis-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ POST /_snapshot/my_repository/_analyze?blob_count=10&max_blob_size=1mb&timeout=1

`POST /_snapshot/<repository>/_analyze`

[[repo-analysis-api-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have the `manage`
<<privileges-list-cluster,cluster privilege>> to use this API. For more
information, see <<security-privileges>>.

* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
users can use this API.

[[repo-analysis-api-desc]]
==== {api-description-title}

Expand Down
4 changes: 3 additions & 1 deletion x-pack/docs/en/security/using-ip-filtering.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ NOTE: Elasticsearch installations are not designed to be publicly accessible
=== Enabling IP filtering

The {es} {security-features} contain an access control feature that allows or
rejects hosts, domains, or subnets.
rejects hosts, domains, or subnets. If the
<<operator-privileges,{operator-feature}>> is enabled, only operator users can
update these settings.

You configure IP filtering by specifying the `xpack.security.transport.filter.allow` and
`xpack.security.transport.filter.deny` settings in `elasticsearch.yml`. Allow rules
Expand Down