[DOCS] Cleans up links to security content (#47610) (#47703)

This commit is contained in:
Lisa Cawley 2019-10-07 15:23:19 -07:00 committed by GitHub
parent 74876811c2
commit 39ef795085
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
166 changed files with 295 additions and 348 deletions

View File

@ -41,13 +41,13 @@ DELETE /_ccr/auto_follow/<auto_follow_pattern_name>
* If the {es} {security-features} are enabled, you must have `manage_ccr` cluster * If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information, privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges]. see <<security-privileges>>.
[[ccr-delete-auto-follow-pattern-desc]] [[ccr-delete-auto-follow-pattern-desc]]
==== {api-description-title} ==== {api-description-title}
This API deletes a configured collection of This API deletes a configured collection of
{stack-ov}/ccr-auto-follow.html[auto-follow patterns]. <<ccr-auto-follow,auto-follow patterns>>.
[[ccr-delete-auto-follow-pattern-path-parms]] [[ccr-delete-auto-follow-pattern-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -53,12 +53,12 @@ GET /_ccr/auto_follow/<auto_follow_pattern_name>
* If the {es} {security-features} are enabled, you must have `manage_ccr` cluster * If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information, privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges]. see <<security-privileges>>.
[[ccr-get-auto-follow-pattern-desc]] [[ccr-get-auto-follow-pattern-desc]]
==== {api-description-title} ==== {api-description-title}
This API gets configured {stack-ov}/ccr-auto-follow.html[auto-follow patterns]. This API gets configured <<ccr-auto-follow,auto-follow patterns>>.
This API will return the specified auto-follow pattern collection. This API will return the specified auto-follow pattern collection.
[[ccr-get-auto-follow-pattern-path-parms]] [[ccr-get-auto-follow-pattern-path-parms]]

View File

@ -45,14 +45,13 @@ DELETE /_ccr/auto_follow/auto_follow_pattern_name
* If the {es} {security-features} are enabled, you must have `read` and `monitor` * If the {es} {security-features} are enabled, you must have `read` and `monitor`
index privileges for the leader index patterns. You must also have `manage_ccr` index privileges for the leader index patterns. You must also have `manage_ccr`
cluster privileges on the cluster that contains the follower index. For more cluster privileges on the cluster that contains the follower index. For more
information, see information, see <<security-privileges>>.
{stack-ov}/security-privileges.html[Security privileges].
[[ccr-put-auto-follow-pattern-desc]] [[ccr-put-auto-follow-pattern-desc]]
==== {api-description-title} ==== {api-description-title}
This API creates a new named collection of This API creates a new named collection of
{stack-ov}/ccr-auto-follow.html[auto-follow patterns] against the remote cluster <<ccr-auto-follow,auto-follow patterns>> against the remote cluster
specified in the request body. Newly created indices on the remote cluster specified in the request body. Newly created indices on the remote cluster
matching any of the specified patterns will be automatically configured as follower matching any of the specified patterns will be automatically configured as follower
indices. indices.

View File

@ -42,8 +42,7 @@ GET /<index>/_ccr/info
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `monitor` cluster * If the {es} {security-features} are enabled, you must have `monitor` cluster
privileges. For more information, see privileges. For more information, see <<security-privileges>>.
{stack-ov}/security-privileges.html[Security privileges].
[[ccr-get-follow-info-desc]] [[ccr-get-follow-info-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -43,7 +43,7 @@ GET /<index>/_ccr/stats
* If the {es} {security-features} are enabled, you must have `monitor` cluster * If the {es} {security-features} are enabled, you must have `monitor` cluster
privileges on the cluster that contains the follower index. For more information, privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges]. see <<security-privileges>>.
[[ccr-get-follow-stats-desc]] [[ccr-get-follow-stats-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -70,7 +70,7 @@ POST /<leader_index>/_ccr/forget_follower
* If the {es} {security-features} are enabled, you must have `manage_leader_index` * If the {es} {security-features} are enabled, you must have `manage_leader_index`
index privileges for the leader index. For more information, see index privileges for the leader index. For more information, see
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ccr-post-forget-follower-desc]] [[ccr-post-forget-follower-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -37,7 +37,7 @@ POST /<follower_index>/_ccr/pause_follow
* If the {es} {security-features} are enabled, you must have `manage_ccr` cluster * If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information, privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges]. see <<security-privileges>>.
[[ccr-post-pause-follow-desc]] [[ccr-post-pause-follow-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -51,7 +51,7 @@ POST /<follower_index>/_ccr/resume_follow
index privileges for the follower index. You must have `read` and `monitor` index privileges for the follower index. You must have `read` and `monitor`
index privileges for the leader index. You must also have `manage_ccr` cluster index privileges for the leader index. You must also have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information, privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges]. see <<security-privileges>>.
[[ccr-post-resume-follow-desc]] [[ccr-post-resume-follow-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -41,7 +41,7 @@ POST /<follower_index>/_ccr/unfollow
* If the {es} {security-features} are enabled, you must have `manage_follow_index` * If the {es} {security-features} are enabled, you must have `manage_follow_index`
index privileges for the follower index. For more information, see index privileges for the follower index. For more information, see
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ccr-post-unfollow-desc]] [[ccr-post-unfollow-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -41,8 +41,7 @@ PUT /<follower_index>/_ccr/follow?wait_for_active_shards=1
and `manage_follow_index` index privileges for the follower index. You must have and `manage_follow_index` index privileges for the follower index. You must have
`read` and `monitor` index privileges for the leader index. You must also have `read` and `monitor` index privileges for the leader index. You must also have
`manage_ccr` cluster privileges on the cluster that contains the follower index. `manage_ccr` cluster privileges on the cluster that contains the follower index.
For more information, see For more information, see <<security-privileges>>.
{stack-ov}/security-privileges.html[Security privileges].
[[ccr-put-follow-desc]] [[ccr-put-follow-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -42,7 +42,7 @@ GET /_ccr/stats
* If the {es} {security-features} are enabled, you must have `monitor` cluster * If the {es} {security-features} are enabled, you must have `monitor` cluster
privileges on the cluster that contains the follower index. For more information, privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges]. see <<security-privileges>>.
[[ccr-get-stats-desc]] [[ccr-get-stats-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -34,7 +34,7 @@ to control which users have authority to manage {ccr}.
By default, you can perform all of the steps in this tutorial by By default, you can perform all of the steps in this tutorial by
using the built-in `elastic` user. However, a password must be set for this user using the built-in `elastic` user. However, a password must be set for this user
before the user can do anything. For information about how to set that password, before the user can do anything. For information about how to set that password,
see {stack-ov}/security-getting-started.html[Tutorial: Getting started with security]. see <<security-getting-started>>.
If you are performing these steps in a production environment, take extra care If you are performing these steps in a production environment, take extra care
because the `elastic` user has the `superuser` role and you could inadvertently because the `elastic` user has the `superuser` role and you could inadvertently

View File

@ -224,7 +224,7 @@ Alternatively, you can specify the `--ca-pass`, `--out`, and `--pass` parameters
By default, this command generates a file called `elastic-certificates.p12`, By default, this command generates a file called `elastic-certificates.p12`,
which you can copy to the relevant configuration directory for each Elastic which you can copy to the relevant configuration directory for each Elastic
product that you want to configure. For more information, see product that you want to configure. For more information, see
{xpack-ref}/ssl-tls.html[Setting Up TLS on a Cluster]. <<ssl-tls>>.
[float] [float]
[[certutil-silent]] [[certutil-silent]]

View File

@ -4,7 +4,7 @@
== elasticsearch-setup-passwords == elasticsearch-setup-passwords
The `elasticsearch-setup-passwords` command sets the passwords for the The `elasticsearch-setup-passwords` command sets the passwords for the
{stack-ov}/built-in-users.html[built-in users]. <<built-in-users,built-in users>>.
[float] [float]
=== Synopsis === Synopsis
@ -21,7 +21,7 @@ bin/elasticsearch-setup-passwords auto|interactive
This command is intended for use only during the initial configuration of the This command is intended for use only during the initial configuration of the
{es} {security-features}. It uses the {es} {security-features}. It uses the
{stack-ov}/built-in-users.html#bootstrap-elastic-passwords[`elastic` bootstrap password] <<bootstrap-elastic-passwords,`elastic` bootstrap password>>
to run user management API requests. After you set a password for the `elastic` to run user management API requests. After you set a password for the `elastic`
user, the bootstrap password is no longer active and you cannot use this command. user, the bootstrap password is no longer active and you cannot use this command.
Instead, you can change passwords by using the *Management > Users* UI in {kib} Instead, you can change passwords by using the *Management > Users* UI in {kib}
@ -36,7 +36,7 @@ location, ensure that the *ES_PATH_CONF* environment variable returns the
correct path before you run the `elasticsearch-setup-passwords` command. You can correct path before you run the `elasticsearch-setup-passwords` command. You can
override settings in your `elasticsearch.yml` file by using the `-E` command override settings in your `elasticsearch.yml` file by using the `-E` command
option. For more information about debugging connection failures, see option. For more information about debugging connection failures, see
{stack-ov}/trb-security-setup.html[`elasticsearch-setup-passwords` command fails due to connection failure]. <<trb-security-setup>>.
[float] [float]
=== Parameters === Parameters

View File

@ -33,7 +33,7 @@ Leading or trailing whitespace is not allowed.
Passwords must be at least 6 characters long. Passwords must be at least 6 characters long.
For more information, see {xpack-ref}/file-realm.html[File-based User Authentication]. For more information, see <<file-realm>>.
TIP: To ensure that {es} can read the user and role information at startup, run TIP: To ensure that {es} can read the user and role information at startup, run
`elasticsearch-users useradd` as the same user you use to run {es}. Running the `elasticsearch-users useradd` as the same user you use to run {es}. Running the

View File

@ -31,7 +31,7 @@ current master node fails.
The {ccr} feature enables you to replicate indices in remote clusters to your The {ccr} feature enables you to replicate indices in remote clusters to your
local cluster. For more information, see local cluster. For more information, see
{stack-ov}/xpack-ccr.html[{ccr-cap}]. {ref}/xpack-ccr.html[{ccr-cap}].
[[glossary-ccs]] {ccs} (CCS):: [[glossary-ccs]] {ccs} (CCS)::

View File

@ -95,7 +95,7 @@ prevent non-administrators exfiltrating data.
+ +
-- --
The following example creates a new user `snapshot_user` in the The following example creates a new user `snapshot_user` in the
{stack-ov}/native-realm.html[native realm], but it is not important which <<native-realm,native realm>>, but it is not important which
realm the user is a member of: realm the user is a member of:
[source,console] [source,console]
@ -202,7 +202,7 @@ Then log into one of the node hosts, navigate to {es} installation directory,
and follow these steps: and follow these steps:
. Add a new user with the `superuser` built-in role to the . Add a new user with the `superuser` built-in role to the
{stack-ov}/file-realm.html[file realm]. <<file-realm,file realm>>.
+ +
-- --
For example, create a user named `restore_user`: For example, create a user named `restore_user`:

View File

@ -22,6 +22,6 @@ It does *not* grant privileges to create repositories, restore snapshots, or
search within indices. Hence, the user can view and snapshot all indices, but cannot search within indices. Hence, the user can view and snapshot all indices, but cannot
access or modify any data. access or modify any data.
For more information, see {stack-ov}/security-privileges.html[Security privileges] For more information, see <<security-privileges>>
and {stack-ov}/built-in-roles.html[Built-in roles]. and <<built-in-roles>>.
==== ====

View File

@ -30,7 +30,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
==== Authorization ==== Authorization
You must have the `manage_ilm` cluster privilege to use this API. You must have the `manage_ilm` cluster privilege to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -41,7 +41,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
You must have the `view_index_metadata` or `manage_ilm` or both privileges on the indices You must have the `view_index_metadata` or `manage_ilm` or both privileges on the indices
being managed to use this API. being managed to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -30,7 +30,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
==== Authorization ==== Authorization
You must have the `manage_ilm` or `read_ilm` or both cluster privileges to use this API. You must have the `manage_ilm` or `read_ilm` or both cluster privileges to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -28,7 +28,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
==== Authorization ==== Authorization
You must have the `manage_ilm` or `read_ilm` or both cluster privileges to use this API. You must have the `manage_ilm` or `read_ilm` or both cluster privileges to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -39,7 +39,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
==== Authorization ==== Authorization
You must have the `manage_ilm` privileges on the indices being managed to use this API. You must have the `manage_ilm` privileges on the indices being managed to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -36,7 +36,7 @@ You must have the `manage_ilm` cluster privilege to use this API. You must
also have the `manage` index privilege on all indices being managed by `policy`. also have the `manage` index privilege on all indices being managed by `policy`.
All operations executed by {ilm} for a policy are executed as the user that All operations executed by {ilm} for a policy are executed as the user that
put the latest version of a policy. put the latest version of a policy.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -30,7 +30,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
==== Authorization ==== Authorization
You must have the `manage_ilm` privileges on the indices being managed to use this API. You must have the `manage_ilm` privileges on the indices being managed to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -30,7 +30,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
==== Authorization ==== Authorization
You must have the `manage_ilm` privileges on the indices being managed to use this API. You must have the `manage_ilm` privileges on the indices being managed to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -43,7 +43,7 @@ You must have the `manage_slm` cluster privilege to use this API. You must also
have the `manage` index privilege on all indices being managed by `policy`. All have the `manage` index privilege on all indices being managed by `policy`. All
operations executed by {slm} for a policy are executed as the user that put the operations executed by {slm} for a policy are executed as the user that put the
latest version of a policy. For more information, see latest version of a policy. For more information, see
{stack-ov}/security-privileges.html[Security Privileges]. <<security-privileges>>.
==== Example ==== Example

View File

@ -27,7 +27,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
==== Authorization ==== Authorization
You must have the `manage_ilm` cluster privilege to use this API. You must have the `manage_ilm` cluster privilege to use this API.
For more information, see {stack-ov}/security-privileges.html[Security privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -32,7 +32,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
==== Authorization ==== Authorization
You must have the `manage_ilm` cluster privilege to use this API. You must have the `manage_ilm` cluster privilege to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges]. For more information, see <<security-privileges>>.
==== Examples ==== Examples

View File

@ -17,14 +17,14 @@ This API enables you to delete licensing information.
==== Description ==== Description
When your license expires, {xpack} operates in a degraded mode. For more When your license expires, {xpack} operates in a degraded mode. For more
information, see {xpack-ref}/license-expiration.html[License Expiration]. information, see {stack-ov}/license-expiration.html[License Expiration].
[float] [float]
==== Authorization ==== Authorization
You must have `manage` cluster privileges to use this API. You must have `manage` cluster privileges to use this API.
For more information, see For more information, see
{xpack-ref}/security-privileges.html[Security Privileges]. <<security-privileges>>.
[float] [float]
==== Examples ==== Examples

View File

@ -25,8 +25,7 @@ https://www.elastic.co/subscriptions.
==== Authorization ==== Authorization
You must have `monitor` cluster privileges to use this API. You must have `monitor` cluster privileges to use this API.
For more information, see For more information, see <<security-privileges>>.
{xpack-ref}/security-privileges.html[Security Privileges].
[float] [float]
==== Examples ==== Examples

View File

@ -35,8 +35,7 @@ https://www.elastic.co/subscriptions.
==== Authorization ==== Authorization
You must have `monitor` cluster privileges to use this API. You must have `monitor` cluster privileges to use this API.
For more information, see For more information, see <<security-privileges>>.
{xpack-ref}/security-privileges.html[Security Privileges].
[float] [float]

View File

@ -32,7 +32,7 @@ https://www.elastic.co/subscriptions.
You must have `monitor` cluster privileges to use this API. You must have `monitor` cluster privileges to use this API.
For more information, see For more information, see
{xpack-ref}/security-privileges.html[Security Privileges]. <<security-privileges>>.
[float] [float]
==== Examples ==== Examples

View File

@ -32,7 +32,7 @@ https://www.elastic.co/subscriptions.
You must have `manage` cluster privileges to use this API. You must have `manage` cluster privileges to use this API.
For more information, see For more information, see
{xpack-ref}/security-privileges.html[Security Privileges]. <<security-privileges>>.
[float] [float]
==== Examples ==== Examples

View File

@ -35,7 +35,7 @@ https://www.elastic.co/subscriptions.
You must have `manage` cluster privileges to use this API. You must have `manage` cluster privileges to use this API.
For more information, see For more information, see
{xpack-ref}/security-privileges.html[Security Privileges]. <<security-privileges>>.
[float] [float]
==== Examples ==== Examples

View File

@ -160,4 +160,4 @@ curl -XPUT -u elastic 'http://<host>:<port>/_license?acknowledge=true' -H "Conte
// NOTCONSOLE // NOTCONSOLE
For more information about the features that are disabled when you downgrade For more information about the features that are disabled when you downgrade
your license, see {xpack-ref}/license-expiration.html[License Expiration]. your license, see {stack-ov}/license-expiration.html[License Expiration].

View File

@ -26,7 +26,7 @@ operations, but you can still explore and navigate results.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-close-job-desc]] [[ml-close-job-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -9,7 +9,7 @@ A {dfeed} resource has the following properties:
(object) If set, the {dfeed} performs aggregation searches. (object) If set, the {dfeed} performs aggregation searches.
Support for aggregations is limited and should only be used with Support for aggregations is limited and should only be used with
low cardinality data. For more information, see low cardinality data. For more information, see
{xpack-ref}/ml-configuring-aggregation.html[Aggregating Data for Faster Performance]. {stack-ov}/ml-configuring-aggregation.html[Aggregating Data for Faster Performance].
`chunking_config`:: `chunking_config`::
(object) Specifies how data searches are split into time chunks. (object) Specifies how data searches are split into time chunks.
@ -53,7 +53,7 @@ A {dfeed} resource has the following properties:
The <<ml-detectorconfig,detector configuration objects>> in a job can contain The <<ml-detectorconfig,detector configuration objects>> in a job can contain
functions that use these script fields. functions that use these script fields.
For more information, see For more information, see
{xpack-ref}/ml-configuring-transform.html[Transforming Data With Script Fields]. {stack-ov}/ml-configuring-transform.html[Transforming Data With Script Fields].
`scroll_size`:: `scroll_size`::
(unsigned integer) The `size` parameter that is used in {es} searches. (unsigned integer) The `size` parameter that is used in {es} searches.

View File

@ -18,7 +18,7 @@ Deletes scheduled events from a calendar.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-delete-calendar-event-desc]] [[ml-delete-calendar-event-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Deletes {anomaly-jobs} from a calendar.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-delete-calendar-job-path-parms]] [[ml-delete-calendar-job-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -18,7 +18,7 @@ Deletes a calendar.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-delete-calendar-desc]] [[ml-delete-calendar-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -22,7 +22,7 @@ Deletes an existing {dfeed}.
can delete it. can delete it.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-delete-datafeed-path-parms]] [[ml-delete-datafeed-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -18,7 +18,7 @@ Deletes expired and unused machine learning data.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-delete-expired-data-desc]] [[ml-delete-expired-data-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Deletes a filter.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-delete-filter-desc]] [[ml-delete-filter-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -22,7 +22,7 @@ Deletes forecasts from a {ml} job.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-delete-forecast-desc]] [[ml-delete-forecast-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -17,8 +17,7 @@ Deletes an existing {anomaly-job}.
==== {api-prereq-title} ==== {api-prereq-title}
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage` * If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
cluster privileges to use this API. See cluster privileges to use this API. See <<security-privileges>>.
{stack-ov}/security-privileges.html[Security privileges].
[[ml-delete-job-desc]] [[ml-delete-job-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -17,8 +17,7 @@ Deletes an existing model snapshot.
==== {api-prereq-title} ==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See <<security-privileges>>.
{stack-ov}/security-privileges.html[Security privileges].
[[ml-delete-snapshot-desc]] [[ml-delete-snapshot-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -24,4 +24,4 @@ An events resource has the following properties:
in milliseconds since the epoch or ISO 8601 format. in milliseconds since the epoch or ISO 8601 format.
For more information, see For more information, see
{xpack-ref}/ml-calendars.html[Calendars and Scheduled Events]. {stack-ov}/ml-calendars.html[Calendars and Scheduled Events].

View File

@ -21,7 +21,7 @@ suitable to be ingested into {es}.
* If the {es} {security-features} are enabled, you must have `monitor_ml` or * If the {es} {security-features} are enabled, you must have `monitor_ml` or
`monitor` cluster privileges to use this API. See `monitor` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-find-file-structure-desc]] [[ml-find-file-structure-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Forces any buffered data to be processed by the job.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-flush-job-desc]] [[ml-flush-job-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Predicts the future behavior of a time series by using its historical behavior.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-forecast-desc]] [[ml-forecast-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -23,8 +23,8 @@ Retrieves {anomaly-job} results for one or more buckets.
need `read` index privilege on the index that stores the results. The need `read` index privilege on the index that stores the results. The
`machine_learning_admin` and `machine_learning_user` roles provide these `machine_learning_admin` and `machine_learning_user` roles provide these
privileges. For more information, see privileges. For more information, see
{stack-ov}/security-privileges.html[Security privileges] and <<security-privileges>> and
{stack-ov}/built-in-roles.html[Built-in roles]. <<built-in-roles>>.
[[ml-get-bucket-desc]] [[ml-get-bucket-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -20,7 +20,7 @@ Retrieves information about the scheduled events in calendars.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-get-calendar-event-desc]] [[ml-get-calendar-event-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -20,7 +20,7 @@ Retrieves configuration information for calendars.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-get-calendar-desc]] [[ml-get-calendar-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -22,8 +22,8 @@ Retrieves {anomaly-job} results for one or more categories.
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
need `read` index privilege on the index that stores the results. The need `read` index privilege on the index that stores the results. The
`machine_learning_admin` and `machine_learning_user` roles provide these `machine_learning_admin` and `machine_learning_user` roles provide these
privileges. See {stack-ov}/security-privileges.html[Security privileges] and privileges. See <<security-privileges>> and
{stack-ov}/built-in-roles.html[Built-in roles]. <<built-in-roles>>.
[[ml-get-category-desc]] [[ml-get-category-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -26,7 +26,7 @@ Retrieves usage information for {dfeeds}.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-get-datafeed-stats-desc]] [[ml-get-datafeed-stats-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -26,7 +26,7 @@ Retrieves configuration information for {dfeeds}.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-get-datafeed-desc]] [[ml-get-datafeed-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -20,7 +20,7 @@ Retrieves filters.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-get-filter-desc]] [[ml-get-filter-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -20,8 +20,8 @@ Retrieves {anomaly-job} results for one or more influencers.
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
need `read` index privilege on the index that stores the results. The need `read` index privilege on the index that stores the results. The
`machine_learning_admin` and `machine_learning_user` roles provide these `machine_learning_admin` and `machine_learning_user` roles provide these
privileges. See {stack-ov}/security-privileges.html[Security privileges] and privileges. See <<security-privileges>> and
{stack-ov}/built-in-roles.html[Built-in roles]. <<built-in-roles>>.
[[ml-get-influencer-path-parms]] [[ml-get-influencer-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -24,7 +24,7 @@ Retrieves usage information for {anomaly-jobs}.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-get-job-stats-desc]] [[ml-get-job-stats-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -24,7 +24,7 @@ Retrieves configuration information for {anomaly-jobs}.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-get-job-desc]] [[ml-get-job-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -21,8 +21,8 @@ Returns defaults and limits used by machine learning.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. The `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. The
`machine_learning_admin` and `machine_learning_user` roles provide these `machine_learning_admin` and `machine_learning_user` roles provide these
privileges. See {stack-ov}/security-privileges.html[Security privileges] and privileges. See <<security-privileges>> and
{stack-ov}/built-in-roles.html[Built-in roles]. <<built-in-roles>>.
[[get-ml-info-desc]] [[get-ml-info-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -25,8 +25,7 @@ Retrieves overall bucket results that summarize the bucket results of multiple
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
need `read` index privilege on the index that stores the results. The need `read` index privilege on the index that stores the results. The
`machine_learning_admin` and `machine_learning_user` roles provide these `machine_learning_admin` and `machine_learning_user` roles provide these
privileges. See {stack-ov}/security-privileges.html[Security privileges] and privileges. See <<security-privileges>> and <<built-in-roles>>.
{stack-ov}/built-in-roles.html[Built-in roles].
[[ml-get-overall-buckets-desc]] [[ml-get-overall-buckets-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -20,8 +20,7 @@ Retrieves anomaly records for an {anomaly-job}.
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
need `read` index privilege on the index that stores the results. The need `read` index privilege on the index that stores the results. The
`machine_learning_admin` and `machine_learning_user` roles provide these `machine_learning_admin` and `machine_learning_user` roles provide these
privileges. See {stack-ov}/security-privileges.html[Security privileges] and privileges. See <<security-privileges>> and <<built-in-roles>>.
{stack-ov}/built-in-roles.html[Built-in roles].
[[ml-get-record-path-parms]] [[ml-get-record-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -20,7 +20,7 @@ Retrieves information about model snapshots.
* If the {es} {security-features} are enabled, you must have `monitor_ml`, * If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-get-snapshot-path-parms]] [[ml-get-snapshot-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -33,7 +33,7 @@ so do not set the `background_persist_interval` value too low.
`custom_settings`:: `custom_settings`::
(object) Advanced configuration option. Contains custom meta data about the (object) Advanced configuration option. Contains custom meta data about the
job. For example, it can contain custom URL information as shown in job. For example, it can contain custom URL information as shown in
{xpack-ref}/ml-configuring-url.html[Adding Custom URLs to Machine Learning Results]. {stack-ov}/ml-configuring-url.html[Adding Custom URLs to Machine Learning Results].
`data_description`:: `data_description`::
(object) Describes the data format and how APIs parse timestamp fields. (object) Describes the data format and how APIs parse timestamp fields.
@ -110,7 +110,7 @@ An analysis configuration object has the following properties:
be categorized. The resulting categories must be used in a detector by setting be categorized. The resulting categories must be used in a detector by setting
`by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword
`mlcategory`. For more information, see `mlcategory`. For more information, see
{xpack-ref}/ml-configuring-categories.html[Categorizing Log Messages]. {stack-ov}/ml-configuring-categories.html[Categorizing Log Messages].
`categorization_filters`:: `categorization_filters`::
(array of strings) If `categorization_field_name` is specified, (array of strings) If `categorization_field_name` is specified,
@ -120,7 +120,7 @@ An analysis configuration object has the following properties:
tune the categorization by excluding sequences from consideration when tune the categorization by excluding sequences from consideration when
categories are defined. For example, you can exclude SQL statements that categories are defined. For example, you can exclude SQL statements that
appear in your log files. For more information, see appear in your log files. For more information, see
{xpack-ref}/ml-configuring-categories.html[Categorizing Log Messages]. {stack-ov}/ml-configuring-categories.html[Categorizing Log Messages].
This property cannot be used at the same time as `categorization_analyzer`. This property cannot be used at the same time as `categorization_analyzer`.
If you only want to define simple regular expression filters that are applied If you only want to define simple regular expression filters that are applied
prior to tokenization, setting this property is the easiest method. prior to tokenization, setting this property is the easiest method.
@ -243,14 +243,14 @@ NOTE: The `field_name` cannot contain double quotes or backslashes.
`function`:: `function`::
(string) The analysis function that is used. (string) The analysis function that is used.
For example, `count`, `rare`, `mean`, `min`, `max`, and `sum`. For more For example, `count`, `rare`, `mean`, `min`, `max`, and `sum`. For more
information, see {xpack-ref}/ml-functions.html[Function Reference]. information, see {stack-ov}/ml-functions.html[Function Reference].
`over_field_name`:: `over_field_name`::
(string) The field used to split the data. (string) The field used to split the data.
In particular, this property is used for analyzing the splits with respect to In particular, this property is used for analyzing the splits with respect to
the history of all splits. It is used for finding unusual values in the the history of all splits. It is used for finding unusual values in the
population of all splits. For more information, see population of all splits. For more information, see
{xpack-ref}/ml-configuring-pop.html[Performing Population Analysis]. {stack-ov}/ml-configuring-pop.html[Performing population analysis].
`partition_field_name`:: `partition_field_name`::
(string) The field used to segment the analysis. (string) The field used to segment the analysis.
@ -406,7 +406,7 @@ the categorization analyzer produces then you find the original document that
the categorization field value came from. the categorization field value came from.
For more information, see For more information, see
{xpack-ref}/ml-configuring-categories.html[Categorizing Log Messages]. {stack-ov}/ml-configuring-categories.html[Categorizing log messages].
[float] [float]
[[ml-detector-custom-rule]] [[ml-detector-custom-rule]]
@ -489,7 +489,7 @@ The `analysis_limits` object has the following properties:
-- --
NOTE: The `categorization_examples_limit` only applies to analysis that uses categorization. NOTE: The `categorization_examples_limit` only applies to analysis that uses categorization.
For more information, see For more information, see
{xpack-ref}/ml-configuring-categories.html[Categorizing Log Messages]. {stack-ov}/ml-configuring-categories.html[Categorizing log messages].
-- --

View File

@ -18,7 +18,7 @@ Opens one or more {anomaly-jobs}.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-open-job-desc]] [[ml-open-job-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Posts scheduled events in a calendar.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-post-calendar-event-desc]] [[ml-post-calendar-event-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Sends data to an anomaly detection job for analysis.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-post-data-desc]] [[ml-post-data-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -20,7 +20,7 @@ Previews a {dfeed}.
* If {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, * If {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`,
`manage_ml`, or `manage` cluster privileges to use this API. See `manage_ml`, or `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-preview-datafeed-desc]] [[ml-preview-datafeed-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Adds an {anomaly-job} to a calendar.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-put-calendar-job-path-parms]] [[ml-put-calendar-job-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -18,7 +18,7 @@ Instantiates a calendar.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-put-calendar-desc]] [[ml-put-calendar-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -21,7 +21,7 @@ Instantiates a {dfeed}.
* You must create an {anomaly-job} before you create a {dfeed}. * You must create an {anomaly-job} before you create a {dfeed}.
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage` * If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
cluster privileges to use this API. See cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-put-datafeed-desc]] [[ml-put-datafeed-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Instantiates a filter.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-put-filter-desc]] [[ml-put-filter-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Instantiates an {anomaly-job}.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-put-job-desc]] [[ml-put-job-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -38,7 +38,7 @@ Categorization results contain the definitions of _categories_ that have been
identified. These are only applicable for jobs that are configured to analyze identified. These are only applicable for jobs that are configured to analyze
unstructured log data using categorization. These results do not contain a unstructured log data using categorization. These results do not contain a
timestamp or any calculated scores. For more information, see timestamp or any calculated scores. For more information, see
{xpack-ref}/ml-configuring-categories.html[Categorizing Log Messages]. {stack-ov}/ml-configuring-categories.html[Categorizing log messages].
* <<ml-results-buckets,Buckets>> * <<ml-results-buckets,Buckets>>
* <<ml-results-influencers,Influencers>> * <<ml-results-influencers,Influencers>>

View File

@ -19,7 +19,7 @@ Reverts to a specific snapshot.
* Before you revert to a saved snapshot, you must close the job. * Before you revert to a saved snapshot, you must close the job.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-revert-snapshot-desc]] [[ml-revert-snapshot-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -29,7 +29,7 @@ POST /_ml/set_upgrade_mode?enabled=false&timeout=10m
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-set-upgrade-mode-desc]] [[ml-set-upgrade-mode-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -22,7 +22,7 @@ Starts one or more {dfeeds}.
error occurs. error occurs.
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage` * If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
cluster privileges to use this API. See cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-start-datafeed-desc]] [[ml-start-datafeed-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -24,7 +24,7 @@ Stops one or more {dfeeds}.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-stop-datafeed-desc]] [[ml-stop-datafeed-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -22,7 +22,7 @@ Updates certain properties of a {dfeed}.
* If {es} {security-features} are enabled, you must have `manage_ml`, or `manage` * If {es} {security-features} are enabled, you must have `manage_ml`, or `manage`
cluster privileges to use this API. See cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-update-datafeed-desc]] [[ml-update-datafeed-desc]]

View File

@ -18,7 +18,7 @@ Updates the description of a filter, adds items, or removes items.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-update-filter-path-parms]] [[ml-update-filter-path-parms]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -18,7 +18,7 @@ Updates certain properties of an {anomaly-job}.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-update-job-path-parms]] [[ml-update-job-path-parms]]

View File

@ -18,7 +18,7 @@ Updates certain properties of a snapshot.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-update-snapshot-path-parms]] [[ml-update-snapshot-path-parms]]

View File

@ -18,7 +18,7 @@ Validates detector configuration information.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-valid-detector-desc]] [[ml-valid-detector-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -18,7 +18,7 @@ Validates {anomaly-job} configuration information.
* If the {es} {security-features} are enabled, you must have `manage_ml` or * If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See `manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[ml-valid-job-desc]] [[ml-valid-job-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -20,8 +20,7 @@ experimental[]
==== {api-prereq-title} ==== {api-prereq-title}
* You must have `machine_learning_admin` built-in role to use this API. For more * You must have `machine_learning_admin` built-in role to use this API. For more
information, see {stack-ov}/security-privileges.html[Security privileges] and information, see <<security-privileges>> and <<built-in-roles>>.
{stack-ov}/built-in-roles.html[Built-in roles].
[[ml-delete-dfanalytics-path-params]] [[ml-delete-dfanalytics-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -21,8 +21,7 @@ experimental[]
==== {api-prereq-title} ==== {api-prereq-title}
* You must have `monitor_ml` privilege to use this API. For more * You must have `monitor_ml` privilege to use this API. For more
information, see {stack-ov}/security-privileges.html[Security privileges] and information, see <<security-privileges>> and <<built-in-roles>>.
{stack-ov}/built-in-roles.html[Built-in roles].
[[ml-estimate-memory-usage-dfanalytics-desc]] [[ml-estimate-memory-usage-dfanalytics-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -21,8 +21,7 @@ experimental[]
==== {api-prereq-title} ==== {api-prereq-title}
* You must have `monitor_ml` privilege to use this API. For more * You must have `monitor_ml` privilege to use this API. For more
information, see {stack-ov}/security-privileges.html[Security privileges] and information, see <<security-privileges>> and <<built-in-roles>>.
{stack-ov}/built-in-roles.html[Built-in roles].
[[ml-evaluate-dfanalytics-desc]] [[ml-evaluate-dfanalytics-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -29,8 +29,7 @@ experimental[]
==== {api-prereq-title} ==== {api-prereq-title}
* You must have `monitor_ml` privilege to use this API. For more * You must have `monitor_ml` privilege to use this API. For more
information, see {stack-ov}/security-privileges.html[Security privileges] and information, see <<security-privileges>> and <<built-in-roles>>.
{stack-ov}/built-in-roles.html[Built-in roles].
[[ml-get-dfanalytics-stats-path-params]] [[ml-get-dfanalytics-stats-path-params]]

View File

@ -26,8 +26,7 @@ experimental[]
==== {api-prereq-title} ==== {api-prereq-title}
* You must have `monitor_ml` privilege to use this API. For more * You must have `monitor_ml` privilege to use this API. For more
information, see {stack-ov}/security-privileges.html[Security privileges] and information, see <<security-privileges>> and <<built-in-roles>>.
{stack-ov}/built-in-roles.html[Built-in roles].
[[ml-get-dfanalytics-desc]] [[ml-get-dfanalytics-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -23,8 +23,7 @@ experimental[]
* You must have `machine_learning_admin` built-in role to use this API. You must * You must have `machine_learning_admin` built-in role to use this API. You must
also have `read` and `view_index_metadata` privileges on the source index and also have `read` and `view_index_metadata` privileges on the source index and
`read`, `create_index`, and `index` privileges on the destination index. For `read`, `create_index`, and `index` privileges on the destination index. For
more information, see {stack-ov}/security-privileges.html[Security privileges] more information, see <<security-privileges>> and <<built-in-roles>>.
and {stack-ov}/built-in-roles.html[Built-in roles].
[[ml-put-dfanalytics-desc]] [[ml-put-dfanalytics-desc]]

View File

@ -23,8 +23,7 @@ experimental[]
* You must have `machine_learning_admin` built-in role to use this API. You must * You must have `machine_learning_admin` built-in role to use this API. You must
also have `read` and `view_index_metadata` privileges on the source index and also have `read` and `view_index_metadata` privileges on the source index and
`read`, `create_index`, and `index` privileges on the destination index. For `read`, `create_index`, and `index` privileges on the destination index. For
more information, see {stack-ov}/security-privileges.html[Security privileges] more information, see <<security-privileges>> and <<built-in-roles>>.
and {stack-ov}/built-in-roles.html[Built-in roles].
[[ml-start-dfanalytics-path-params]] [[ml-start-dfanalytics-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -25,8 +25,7 @@ experimental[]
==== {api-prereq-title} ==== {api-prereq-title}
* You must have `machine_learning_admin` built-in role to use this API. For more * You must have `machine_learning_admin` built-in role to use this API. For more
information, see {stack-ov}/security-privileges.html[Security privileges] and information, see <<security-privileges>> and <<built-in-roles>>.
{stack-ov}/built-in-roles.html[Built-in roles].
[[ml-stop-dfanalytics-desc]] [[ml-stop-dfanalytics-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -9,7 +9,7 @@ endif::[]
ifdef::include-xpack[] ifdef::include-xpack[]
The _remote clusters_ module enables you to establish uni-directional The _remote clusters_ module enables you to establish uni-directional
connections to a remote cluster. This functionality is used in connections to a remote cluster. This functionality is used in
{stack-ov}/xpack-ccr.html[{ccr}] and <<xpack-ccr,{ccr}>> and
<<modules-cross-cluster-search,{ccs}>>. <<modules-cross-cluster-search,{ccs}>>.
endif::[] endif::[]

View File

@ -18,8 +18,7 @@ Advanced monitoring settings enable you to control how frequently data is
collected, configure timeouts, and set the retention period for locally-stored collected, configure timeouts, and set the retention period for locally-stored
monitoring indices. You can also adjust how monitoring data is displayed. monitoring indices. You can also adjust how monitoring data is displayed.
To learn about monitoring in general, see To learn about monitoring in general, see <<monitor-elasticsearch-cluster>>.
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
. Configure your cluster to collect monitoring data: . Configure your cluster to collect monitoring data:
@ -131,9 +130,9 @@ xpack.monitoring.exporters:
must provide appropriate credentials when data is shipped to the monitoring cluster: must provide appropriate credentials when data is shipped to the monitoring cluster:
... Create a user on the monitoring cluster that has the ... Create a user on the monitoring cluster that has the
{stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role]. <<built-in-roles,`remote_monitoring_agent` built-in role>>.
Alternatively, use the Alternatively, use the
{stack-ov}/built-in-users.html[`remote_monitoring_user` built-in user]. <<built-in-users,`remote_monitoring_user` built-in user>>.
... Add the user ID and password settings to the HTTP exporter settings in the ... Add the user ID and password settings to the HTTP exporter settings in the
`elasticsearch.yml` file on each node. + `elasticsearch.yml` file on each node. +
@ -197,8 +196,7 @@ xpack.monitoring.exporters:
. Configure your cluster to route monitoring data from sources such as {kib}, . Configure your cluster to route monitoring data from sources such as {kib},
Beats, and {ls} to the monitoring cluster. For information about configuring Beats, and {ls} to the monitoring cluster. For information about configuring
each product to collect and send monitoring data, see each product to collect and send monitoring data, see <<monitor-elasticsearch-cluster>>.
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
. If you updated settings in the `elasticsearch.yml` files on your production . If you updated settings in the `elasticsearch.yml` files on your production
cluster, restart {es}. See <<stopping-elasticsearch>> and <<starting-elasticsearch>>. cluster, restart {es}. See <<stopping-elasticsearch>> and <<starting-elasticsearch>>.

View File

@ -39,12 +39,12 @@ For more information, see <<monitoring-settings>> and <<cluster-update-settings>
+ +
-- --
The {filebeat} {es} module can handle The {filebeat} {es} module can handle
{stack-ov}/audit-log-output.html[audit logs], <<audit-log-output,audit logs>>,
{ref}/logging.html#deprecation-logging[deprecation logs], <<deprecation-logging,deprecation logs>>,
{ref}/gc-logging.html[gc logs], {ref}/logging.html[server logs], and <<gc-logging,gc logs>>, <<logging,server logs>>, and
{ref}/index-modules-slowlog.html[slow logs]. <<index-modules-slowlog,slow logs>>.
For more information about the location of your {es} logs, see the For more information about the location of your {es} logs, see the
{ref}/path-settings.html[path.logs] setting. <<path-settings,path.logs>> setting.
IMPORTANT: If there are both structured (`*.json`) and unstructured (plain text) IMPORTANT: If there are both structured (`*.json`) and unstructured (plain text)
versions of the logs, you must use the structured logs. Otherwise, they might versions of the logs, you must use the structured logs. Otherwise, they might
@ -117,7 +117,7 @@ If {security-features} are enabled, you must provide a valid user ID and
password so that {filebeat} can connect to {kib}: password so that {filebeat} can connect to {kib}:
.. Create a user on the monitoring cluster that has the .. Create a user on the monitoring cluster that has the
{stack-ov}/built-in-roles.html[`kibana_user` built-in role] or equivalent <<built-in-roles,`kibana_user` built-in role>> or equivalent
privileges. privileges.
.. Add the `username` and `password` settings to the {es} output information in .. Add the `username` and `password` settings to the {es} output information in
@ -175,7 +175,7 @@ to file ownership or permissions when you try to run {filebeat} modules. See
. Check whether the appropriate indices exist on the monitoring cluster. . Check whether the appropriate indices exist on the monitoring cluster.
+ +
-- --
For example, use the {ref}/cat-indices.html[cat indices] command to verify For example, use the <<cat-indices,cat indices>> command to verify
that there are new `filebeat-*` indices. that there are new `filebeat-*` indices.
TIP: If you want to use the *Monitoring* UI in {kib}, there must also be TIP: If you want to use the *Monitoring* UI in {kib}, there must also be

View File

@ -14,9 +14,6 @@ as described in <<collecting-monitoring-data>>.
image::monitoring/images/metricbeat.png[Example monitoring architecture] image::monitoring/images/metricbeat.png[Example monitoring architecture]
To learn about monitoring in general, see
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
//NOTE: The tagged regions are re-used in the Stack Overview. //NOTE: The tagged regions are re-used in the Stack Overview.
. Enable the collection of monitoring data. + . Enable the collection of monitoring data. +
@ -106,9 +103,9 @@ If Elastic {security-features} are enabled, you must also provide a user ID
and password so that {metricbeat} can collect metrics successfully: and password so that {metricbeat} can collect metrics successfully:
.. Create a user on the production cluster that has the .. Create a user on the production cluster that has the
{stack-ov}/built-in-roles.html[`remote_monitoring_collector` built-in role]. <<built-in-roles,`remote_monitoring_collector` built-in role>>.
Alternatively, use the Alternatively, use the
{stack-ov}/built-in-users.html[`remote_monitoring_user` built-in user]. <<built-in-users,`remote_monitoring_user` built-in user>>.
.. Add the `username` and `password` settings to the {es} module configuration .. Add the `username` and `password` settings to the {es} module configuration
file. file.
@ -171,9 +168,9 @@ provide a valid user ID and password so that {metricbeat} can send metrics
successfully: successfully:
.. Create a user on the monitoring cluster that has the .. Create a user on the monitoring cluster that has the
{stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role]. <<built-in-roles,`remote_monitoring_agent` built-in role>>.
Alternatively, use the Alternatively, use the
{stack-ov}/built-in-users.html[`remote_monitoring_user` built-in user]. <<built-in-users,`remote_monitoring_user` built-in user>>.
.. Add the `username` and `password` settings to the {es} output information in .. Add the `username` and `password` settings to the {es} output information in
the {metricbeat} configuration file. the {metricbeat} configuration file.

View File

@ -60,12 +60,12 @@ credentials must be valid on both the {kib} server and the monitoring cluster.
*** If you plan to use {metricbeat} to collect data about {es} or {kib}, *** If you plan to use {metricbeat} to collect data about {es} or {kib},
create a user that has the `remote_monitoring_collector` built-in role and a create a user that has the `remote_monitoring_collector` built-in role and a
user that has the `remote_monitoring_agent` user that has the `remote_monitoring_agent`
{stack-ov}/built-in-roles.html#built-in-roles-remote-monitoring-agent[built-in role]. Alternatively, use the <<built-in-roles-remote-monitoring-agent,built-in role>>. Alternatively, use the
`remote_monitoring_user` {stack-ov}/built-in-users.html[built-in user]. `remote_monitoring_user` <<built-in-users,built-in user>>.
*** If you plan to use HTTP exporters to route data through your production *** If you plan to use HTTP exporters to route data through your production
cluster, create a user that has the `remote_monitoring_agent` cluster, create a user that has the `remote_monitoring_agent`
{stack-ov}/built-in-roles.html#built-in-roles-remote-monitoring-agent[built-in role]. <<built-in-roles-remote-monitoring-agent,built-in role>>.
+ +
-- --
For example, the For example, the
@ -83,7 +83,7 @@ POST /_security/user/remote_monitor
--------------------------------------------------------------- ---------------------------------------------------------------
// TEST[skip:needs-gold+-license] // TEST[skip:needs-gold+-license]
Alternatively, use the `remote_monitoring_user` {stack-ov}/built-in-users.html[built-in user]. Alternatively, use the `remote_monitoring_user` <<built-in-users,built-in user>>.
-- --
. Configure your production cluster to collect data and send it to the . Configure your production cluster to collect data and send it to the

View File

@ -21,7 +21,7 @@ experimental[]
* If the {es} {security-features} are enabled, you must have `manage` or * If the {es} {security-features} are enabled, you must have `manage` or
`manage_rollup` cluster privileges to use this API. For more information, see `manage_rollup` cluster privileges to use this API. For more information, see
{stack-ov}/security-privileges.html[Security privileges]. <<security-privileges>>.
[[rollup-delete-job-desc]] [[rollup-delete-job-desc]]
==== {api-description-title} ==== {api-description-title}

Some files were not shown because too many files have changed in this diff Show More