From 2665bfffcebfd7da55c5d0296b490cc3c027f8c1 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 23 Jul 2020 16:43:10 -0700 Subject: [PATCH] [DOCS] Fix security links in machine learning APIs (#60098) (#60152) --- docs/reference/cat/anomaly-detectors.asciidoc | 2 +- docs/reference/cat/datafeeds.asciidoc | 2 +- docs/reference/cat/dataframeanalytics.asciidoc | 2 +- docs/reference/cat/trainedmodel.asciidoc | 3 +-- docs/reference/index.asciidoc | 1 + docs/reference/links.asciidoc | 4 ++++ .../ml/anomaly-detection/apis/close-job.asciidoc | 2 +- .../anomaly-detection/apis/delete-calendar-event.asciidoc | 2 +- .../anomaly-detection/apis/delete-calendar-job.asciidoc | 2 +- .../ml/anomaly-detection/apis/delete-calendar.asciidoc | 2 +- .../ml/anomaly-detection/apis/delete-datafeed.asciidoc | 2 +- .../anomaly-detection/apis/delete-expired-data.asciidoc | 2 +- .../ml/anomaly-detection/apis/delete-filter.asciidoc | 2 +- .../ml/anomaly-detection/apis/delete-forecast.asciidoc | 2 +- .../ml/anomaly-detection/apis/delete-job.asciidoc | 3 ++- .../ml/anomaly-detection/apis/delete-snapshot.asciidoc | 3 ++- .../anomaly-detection/apis/estimate-model-memory.asciidoc | 6 +++--- .../anomaly-detection/apis/find-file-structure.asciidoc | 3 ++- .../ml/anomaly-detection/apis/flush-job.asciidoc | 2 +- .../reference/ml/anomaly-detection/apis/forecast.asciidoc | 4 ++-- .../ml/anomaly-detection/apis/get-bucket.asciidoc | 5 ++--- .../ml/anomaly-detection/apis/get-calendar-event.asciidoc | 2 +- .../ml/anomaly-detection/apis/get-calendar.asciidoc | 2 +- .../ml/anomaly-detection/apis/get-category.asciidoc | 4 ++-- .../ml/anomaly-detection/apis/get-datafeed-stats.asciidoc | 2 +- .../ml/anomaly-detection/apis/get-datafeed.asciidoc | 2 +- .../ml/anomaly-detection/apis/get-filter.asciidoc | 2 +- .../ml/anomaly-detection/apis/get-influencer.asciidoc | 4 ++-- .../ml/anomaly-detection/apis/get-job-stats.asciidoc | 2 +- docs/reference/ml/anomaly-detection/apis/get-job.asciidoc | 2 +- .../ml/anomaly-detection/apis/get-ml-info.asciidoc | 4 ++-- .../anomaly-detection/apis/get-overall-buckets.asciidoc | 3 ++- .../ml/anomaly-detection/apis/get-record.asciidoc | 3 ++- .../ml/anomaly-detection/apis/get-snapshot.asciidoc | 2 +- .../reference/ml/anomaly-detection/apis/open-job.asciidoc | 2 +- .../anomaly-detection/apis/post-calendar-event.asciidoc | 2 +- .../ml/anomaly-detection/apis/post-data.asciidoc | 2 +- .../ml/anomaly-detection/apis/preview-datafeed.asciidoc | 2 +- .../ml/anomaly-detection/apis/put-calendar-job.asciidoc | 2 +- .../ml/anomaly-detection/apis/put-calendar.asciidoc | 2 +- .../ml/anomaly-detection/apis/put-datafeed.asciidoc | 4 ++-- .../ml/anomaly-detection/apis/put-filter.asciidoc | 2 +- docs/reference/ml/anomaly-detection/apis/put-job.asciidoc | 2 +- .../ml/anomaly-detection/apis/revert-snapshot.asciidoc | 2 +- .../ml/anomaly-detection/apis/set-upgrade-mode.asciidoc | 2 +- .../ml/anomaly-detection/apis/start-datafeed.asciidoc | 2 +- .../ml/anomaly-detection/apis/stop-datafeed.asciidoc | 2 +- .../ml/anomaly-detection/apis/update-datafeed.asciidoc | 2 +- .../ml/anomaly-detection/apis/update-filter.asciidoc | 2 +- .../ml/anomaly-detection/apis/update-job.asciidoc | 2 +- .../ml/anomaly-detection/apis/update-snapshot.asciidoc | 2 +- .../ml/anomaly-detection/apis/validate-detector.asciidoc | 2 +- .../ml/anomaly-detection/apis/validate-job.asciidoc | 2 +- .../ml/df-analytics/apis/delete-dfanalytics.asciidoc | 3 +-- .../apis/delete-inference-trained-model.asciidoc | 3 +-- .../ml/df-analytics/apis/evaluate-dfanalytics.asciidoc | 2 +- .../ml/df-analytics/apis/explain-dfanalytics.asciidoc | 2 +- .../ml/df-analytics/apis/get-dfanalytics-stats.asciidoc | 2 +- .../ml/df-analytics/apis/get-dfanalytics.asciidoc | 2 +- .../apis/get-inference-trained-model-stats.asciidoc | 3 +-- .../apis/get-inference-trained-model.asciidoc | 2 +- .../ml/df-analytics/apis/put-dfanalytics.asciidoc | 8 +++----- .../reference/ml/df-analytics/apis/put-inference.asciidoc | 4 ++-- .../ml/df-analytics/apis/start-dfanalytics.asciidoc | 8 +++----- .../ml/df-analytics/apis/stop-dfanalytics.asciidoc | 3 +-- .../ml/df-analytics/apis/update-dfanalytics.asciidoc | 7 ++----- docs/reference/transform/apis/put-transform.asciidoc | 6 ++---- .../en/security/authorization/built-in-roles.asciidoc | 6 ++---- 68 files changed, 92 insertions(+), 99 deletions(-) create mode 100644 docs/reference/links.asciidoc diff --git a/docs/reference/cat/anomaly-detectors.asciidoc b/docs/reference/cat/anomaly-detectors.asciidoc index 2cbbdc88c50..419775e484c 100644 --- a/docs/reference/cat/anomaly-detectors.asciidoc +++ b/docs/reference/cat/anomaly-detectors.asciidoc @@ -20,7 +20,7 @@ Returns configuration and usage information about {anomaly-jobs}. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<> and {ml-docs}/setup.html[Set up {ml-features}]. +<> and {ml-docs-setup-privileges}. [[cat-anomaly-detectors-desc]] diff --git a/docs/reference/cat/datafeeds.asciidoc b/docs/reference/cat/datafeeds.asciidoc index e891d66b68b..0e89cedf7ee 100644 --- a/docs/reference/cat/datafeeds.asciidoc +++ b/docs/reference/cat/datafeeds.asciidoc @@ -20,7 +20,7 @@ Returns configuration and usage information about {dfeeds}. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<> and {ml-docs}/setup.html[Set up {ml-features}]. +<> and {ml-docs-setup-privileges}. [[cat-datafeeds-desc]] diff --git a/docs/reference/cat/dataframeanalytics.asciidoc b/docs/reference/cat/dataframeanalytics.asciidoc index fec1ce329a8..3f9bcca40c4 100644 --- a/docs/reference/cat/dataframeanalytics.asciidoc +++ b/docs/reference/cat/dataframeanalytics.asciidoc @@ -25,7 +25,7 @@ privileges: * cluster: `monitor_ml` -For more information, see <> and {ml-docs}/setup.html[Set up {ml-features}]. +For more information, see <> and {ml-docs-setup-privileges}. //// diff --git a/docs/reference/cat/trainedmodel.asciidoc b/docs/reference/cat/trainedmodel.asciidoc index 5d994c73a9b..fa9da773ac7 100644 --- a/docs/reference/cat/trainedmodel.asciidoc +++ b/docs/reference/cat/trainedmodel.asciidoc @@ -23,8 +23,7 @@ privileges: * cluster: `monitor_ml` -For more information, see <> and -{ml-docs}/setup.html[Set up {ml-features}]. +For more information, see <> and {ml-docs-setup-privileges}. //// diff --git a/docs/reference/index.asciidoc b/docs/reference/index.asciidoc index 3ee7f13435c..c6a4d4ee4fb 100644 --- a/docs/reference/index.asciidoc +++ b/docs/reference/index.asciidoc @@ -8,6 +8,7 @@ :es-repo-dir: {elasticsearch-root}/docs/reference include::../Versions.asciidoc[] +include::links.asciidoc[] include::intro.asciidoc[] diff --git a/docs/reference/links.asciidoc b/docs/reference/links.asciidoc new file mode 100644 index 00000000000..11b6629d867 --- /dev/null +++ b/docs/reference/links.asciidoc @@ -0,0 +1,4 @@ +// These attributes define common links in the Elasticsearch Reference + +:ml-docs-setup: {ml-docs}/setup.html[Set up {ml-features}] +:ml-docs-setup-privileges: {ml-docs}/setup.html#setup-privileges[{ml-cap} security privileges] diff --git a/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc index 41a66d60add..12febfb2ee8 100644 --- a/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc @@ -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 `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. * Before you can close an {anomaly-job}, you must stop its {dfeed}. See <>. diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc index 16674eb46ac..04120ff327f 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc @@ -18,7 +18,7 @@ Deletes scheduled events from a calendar. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-delete-calendar-event-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc index 57f034cf63f..d16a742e5dc 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc @@ -18,7 +18,7 @@ Deletes {anomaly-jobs} from a calendar. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-delete-calendar-job-path-parms]] == {api-path-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc index 52bc134a805..90115a839d3 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc @@ -18,7 +18,7 @@ Deletes a calendar. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-delete-calendar-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc index 575d1e2fdad..2f60d869cb2 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc @@ -22,7 +22,7 @@ Deletes an existing {dfeed}. can delete it. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-delete-datafeed-path-parms]] == {api-path-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc index aafdf10f650..bfe45e4c27b 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc @@ -20,7 +20,7 @@ Deletes expired and unused machine learning data. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-delete-expired-data-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc index 09cf2a3135b..89a897a42ce 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc @@ -18,7 +18,7 @@ Deletes a filter. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-delete-filter-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc index 0d914597dc9..3eadef83728 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc @@ -22,7 +22,7 @@ Deletes forecasts from a {ml} job. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-delete-forecast-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc index b6f51702de3..2923e64ba2f 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc @@ -17,7 +17,8 @@ Deletes an existing {anomaly-job}. == {api-prereq-title} * 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 <> and +{ml-docs-setup-privileges}. * Before you can delete a job, you must delete the {dfeeds} that are associated with it. See <>. * Before you can delete a job, you must close it (unless you specify the `force` parameter). See <>. diff --git a/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc index b38b76f4536..26cb641c6b6 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc @@ -17,7 +17,8 @@ Deletes an existing model snapshot. == {api-prereq-title} * 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 <> and +{ml-docs-setup-privileges}. [[ml-delete-snapshot-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc b/docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc index 6acedec9fca..c4759a8d2c9 100644 --- a/docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc @@ -19,12 +19,12 @@ fields it references. [[ml-estimate-model-memory-prereqs]] == {api-prereq-title} -If the {es} {security-features} are enabled, you must have the following -equivalent privileges: +If the {es} {security-features} are enabled, you must have the following privileges: * `manage_ml` or cluster: `manage` -For more information, see <>. +For more information, see <> and +{ml-docs-setup-privileges}. [[ml-estimate-model-memory-request-body]] diff --git a/docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc b/docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc index 693b78e9fb0..e2529edee56 100644 --- a/docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc @@ -23,7 +23,8 @@ suitable to be ingested into {es}. * If the {es} {security-features} are enabled, you must have `monitor_ml` or `monitor` cluster privileges to use this API. See -<>. +<> and +{ml-docs-setup-privileges}. [[ml-find-file-structure-desc]] diff --git a/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc index 5a15c4072ba..983e3d76e6e 100644 --- a/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc @@ -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 `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-flush-job-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc b/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc index e22bf00bfea..2e92b278a9c 100644 --- a/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc @@ -18,13 +18,13 @@ 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 `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-forecast-desc]] == {api-description-title} You can create a forecast job based on an {anomaly-job} to extrapolate future -behavior. Refer to +behavior. Refer to {ml-docs}/ml-overview.html#ml-forecasting[Forecasting the future] and {ml-docs}/ml-limitations.html#ml-forecast-limitations[forecast limitations] to learn more. diff --git a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc index 5af2afdff6f..5b206d26f34 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc @@ -22,9 +22,8 @@ Retrieves {anomaly-job} results for one or more buckets. `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 `machine_learning_admin` and `machine_learning_user` roles provide these -privileges. For more information, see -<> and -<>. +privileges. For more information, see <>, +<>, and {ml-docs-setup-privileges}. [[ml-get-bucket-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc index 96676dcd1cd..5c0d2f5aed5 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc @@ -20,7 +20,7 @@ Retrieves information about the scheduled events in calendars. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-get-calendar-event-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc index 7b3b7cbd2e6..aaa5787fac0 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc @@ -20,7 +20,7 @@ Retrieves configuration information for calendars. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-get-calendar-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc index ea71d0e2759..e98bd282b9a 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc @@ -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 need `read` index privilege on the index that stores the results. The `machine_learning_admin` and `machine_learning_user` roles provide these -privileges. See <> and -<>. +privileges. See <>, <>, and +{ml-docs-setup-privileges}. [[ml-get-category-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc index 9176a4e8598..ae7a6688fe4 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc @@ -26,7 +26,7 @@ Retrieves usage information for {dfeeds}. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-get-datafeed-stats-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc index 2796ee66f82..a924e4b6ec7 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc @@ -26,7 +26,7 @@ Retrieves configuration information for {dfeeds}. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-get-datafeed-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc index c7b2bc9d8af..a0c4a1697da 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc @@ -20,7 +20,7 @@ Retrieves filters. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-get-filter-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc index 9a71676270b..b374c445474 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc @@ -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 need `read` index privilege on the index that stores the results. The `machine_learning_admin` and `machine_learning_user` roles provide these -privileges. See <> and -<>. +privileges. See <>, <>, and +{ml-docs-setup-privileges}. [[ml-get-influencer-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc index ec70338cf99..fb5feec8fbc 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc @@ -24,7 +24,7 @@ Retrieves usage information for {anomaly-jobs}. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-get-job-stats-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc index 4cdd820bd74..08b99346669 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc @@ -24,7 +24,7 @@ Retrieves configuration information for {anomaly-jobs}. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-get-job-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-ml-info.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-ml-info.asciidoc index fc7f21dd8eb..b62701373c1 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-ml-info.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-ml-info.asciidoc @@ -21,8 +21,8 @@ Returns defaults and limits used by machine learning. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. The `machine_learning_admin` and `machine_learning_user` roles provide these -privileges. See <> and -<>. +privileges. See <>, <> and +{ml-docs-setup-privileges}. [[get-ml-info-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc index 8b664e26605..78ac80fb2ba 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc @@ -25,7 +25,8 @@ Retrieves overall bucket results that summarize the bucket results of multiple `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 `machine_learning_admin` and `machine_learning_user` roles provide these -privileges. See <> and <>. +privileges. See <>, <>, and +{ml-docs-setup-privileges}. [[ml-get-overall-buckets-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc index 83715528864..e4841e28995 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc @@ -20,7 +20,8 @@ Retrieves anomaly records for an {anomaly-job}. `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 `machine_learning_admin` and `machine_learning_user` roles provide these -privileges. See <> and <>. +privileges. See <>, <>, and +{ml-docs-setup-privileges}. [[ml-get-record-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc index 174938e07f8..7ece93cc4b6 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc @@ -20,7 +20,7 @@ Retrieves information about model snapshots. * If the {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-get-snapshot-path-parms]] == {api-path-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc index b80a69e5db5..ea4593aa8f0 100644 --- a/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc @@ -18,7 +18,7 @@ Opens one or more {anomaly-jobs}. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-open-job-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc b/docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc index c26b68c2eef..cba26ffbeca 100644 --- a/docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc @@ -18,7 +18,7 @@ Posts scheduled events in a calendar. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-post-calendar-event-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc b/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc index 09a71546e2f..42b385a5159 100644 --- a/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc @@ -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 `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-post-data-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc index e033b39701b..e36f9cc9cd5 100644 --- a/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc @@ -20,7 +20,7 @@ Previews a {dfeed}. * If {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-preview-datafeed-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc index f0e9b0e2426..93ea1b2156c 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc @@ -18,7 +18,7 @@ Adds an {anomaly-job} to a calendar. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-put-calendar-job-path-parms]] == {api-path-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc index ce9f28052be..52369c8766c 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc @@ -18,7 +18,7 @@ Instantiates a calendar. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-put-calendar-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc index cd77b9dc587..7bc529bfba2 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc @@ -20,8 +20,8 @@ Instantiates 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` -cluster privileges to use this API. See -<>. +cluster privileges to use this API. See <> and +{ml-docs-setup-privileges}. [[ml-put-datafeed-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc index 25e183e0d49..4b9d05de734 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc @@ -18,7 +18,7 @@ Instantiates a filter. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-put-filter-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc index 35528a24f8d..cf479d17c3e 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc @@ -18,7 +18,7 @@ Instantiates an {anomaly-job}. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-put-job-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc index 56f4eced05d..b37cf0795da 100644 --- a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc @@ -19,7 +19,7 @@ Reverts to a specific snapshot. * 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 `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-revert-snapshot-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc b/docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc index 574181bafe8..3e47feee971 100644 --- a/docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc @@ -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 `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-set-upgrade-mode-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc index 0900e3fecfe..5e6b618ce35 100644 --- a/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc @@ -22,7 +22,7 @@ Starts one or more {dfeeds}. error occurs. * If {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-start-datafeed-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc index 37fcc093020..0a19ececd63 100644 --- a/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc @@ -24,7 +24,7 @@ Stops one or more {dfeeds}. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-stop-datafeed-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc index ca72e51ab06..6f42c2a2358 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc @@ -22,7 +22,7 @@ Updates certain properties of a {dfeed}. * If {es} {security-features} are enabled, you must have `manage_ml`, or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-update-datafeed-desc]] diff --git a/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc index ad2390d4036..56ba55c50e5 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc @@ -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 `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-update-filter-path-parms]] == {api-path-parms-title} diff --git a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc index 0841ed98b08..92c6341da67 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc @@ -18,7 +18,7 @@ Updates certain properties of an {anomaly-job}. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-update-job-path-parms]] diff --git a/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc index c7429e26fa9..2f6c55f5caa 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc @@ -18,7 +18,7 @@ Updates certain properties of a snapshot. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-update-snapshot-path-parms]] diff --git a/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc b/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc index da0524cd331..d588bb61d28 100644 --- a/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc @@ -18,7 +18,7 @@ Validates detector configuration information. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-valid-detector-desc]] == {api-description-title} diff --git a/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc index 6cb2d458adb..c522c76b3f5 100644 --- a/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc @@ -18,7 +18,7 @@ Validates {anomaly-job} configuration information. * If the {es} {security-features} are enabled, you must have `manage_ml` or `manage` cluster privileges to use this API. See -<>. +<> and {ml-docs-setup-privileges}. [[ml-valid-job-desc]] == {api-description-title} diff --git a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc index 86c31e0357f..374359c7f4b 100644 --- a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc @@ -24,9 +24,8 @@ experimental[] If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: * `machine_learning_admin` -* `kibana_admin` (UI only) -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-delete-dfanalytics-path-params]] diff --git a/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc index 5df785a78dd..7f082652a99 100644 --- a/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc @@ -25,9 +25,8 @@ experimental[] If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: * `machine_learning_admin` -* `kibana_admin` (UI only) -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-delete-inference-path-params]] diff --git a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc index 16f930193f2..e3c08869bd2 100644 --- a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc @@ -26,7 +26,7 @@ If the {es} {security-features} are enabled, you must have the following privile * cluster: `monitor_ml` -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-evaluate-dfanalytics-desc]] diff --git a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc index a9d176e2f01..e51fc2570d2 100644 --- a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc @@ -32,7 +32,7 @@ If the {es} {security-features} are enabled, you must have the following privile * cluster: `monitor_ml` -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-explain-dfanalytics-desc]] diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc index 4b48c917129..12ee0fa8693 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc @@ -32,7 +32,7 @@ If the {es} {security-features} are enabled, you must have the following privile * cluster: `monitor_ml` -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-get-dfanalytics-stats-path-params]] == {api-path-parms-title} diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc index 25df1557e83..2de63dd23a3 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc @@ -31,7 +31,7 @@ If the {es} {security-features} are enabled, you must have the following privile * cluster: `monitor_ml` -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-get-dfanalytics-desc]] diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc index 467973957eb..37bc73cce20 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc @@ -32,9 +32,8 @@ experimental[] Required privileges which should be added to a custom role: * cluster: `monitor_ml` - -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-get-inference-stats-desc]] == {api-description-title} diff --git a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc index 0a796304a86..c9fe7786853 100644 --- a/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc @@ -33,7 +33,7 @@ Required privileges which should be added to a custom role: * cluster: `monitor_ml` -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-get-inference-desc]] diff --git a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc index c02baad09e4..d3ecb60ecda 100644 --- a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc @@ -23,14 +23,12 @@ experimental[] If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: * `machine_learning_admin` -* `kibana_admin` (UI only) - - * source indices: `read`, `view_index_metadata` * destination index: `read`, `create_index`, `manage` and `index` -* cluster: `monitor` (UI only) -For more information, see <> and <>. +For more information, see <>, <>, and +{ml-docs-setup-privileges}. + NOTE: The {dfanalytics-job} remembers which roles the user who created it had at the time of creation. When you start the job, it performs the analysis using diff --git a/docs/reference/ml/df-analytics/apis/put-inference.asciidoc b/docs/reference/ml/df-analytics/apis/put-inference.asciidoc index 868ab207215..6eab6cfae1f 100644 --- a/docs/reference/ml/df-analytics/apis/put-inference.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-inference.asciidoc @@ -28,11 +28,11 @@ experimental[] == {api-prereq-title} If the {es} {security-features} are enabled, you must have the following -built-in roles and privileges: +built-in roles or equivalent privileges: * `machine_learning_admin` -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-put-inference-desc]] diff --git a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc index 7902c340137..6004e5a8f94 100644 --- a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc @@ -23,13 +23,11 @@ experimental[] If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: * `machine_learning_admin` -* `kibana_admin` (UI only) - * source indices: `read`, `view_index_metadata` * destination index: `read`, `create_index`, `manage` and `index` -* cluster: `monitor` (UI only) - -For more information, see <> and <>. + +For more information, see <>, <>, and +{ml-docs-setup-privileges}. [[ml-start-dfanalytics-desc]] == {api-description-title} diff --git a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc index ef399ca05db..c24c05b6772 100644 --- a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc @@ -27,9 +27,8 @@ experimental[] If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges: * `machine_learning_admin` -* `kibana_admin` (UI only) -For more information, see <> and <>. +For more information, see <> and {ml-docs-setup-privileges}. [[ml-stop-dfanalytics-desc]] diff --git a/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc index b27a2fb455f..a5152999670 100644 --- a/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc @@ -24,14 +24,11 @@ If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: * `machine_learning_admin` -* `kibana_admin` (UI only) - - * source indices: `read`, `view_index_metadata` * destination index: `read`, `create_index`, `manage` and `index` -* cluster: `monitor` (UI only) -For more information, see <> and <>. +For more information, see <>, <>, and +{ml-docs-setup-privileges}. NOTE: The {dfanalytics-job} remembers which roles the user who created it had at the time of creation. When you start the job, it performs the analysis using diff --git a/docs/reference/transform/apis/put-transform.asciidoc b/docs/reference/transform/apis/put-transform.asciidoc index 86dcead55a0..e7b9309204b 100644 --- a/docs/reference/transform/apis/put-transform.asciidoc +++ b/docs/reference/transform/apis/put-transform.asciidoc @@ -22,13 +22,11 @@ If the {es} {security-features} are enabled, you must have the following built-in roles and privileges: * `transform_admin` -* `kibana_admin` (UI only) - * source index: `read`, `view_index_metadata` * destination index: `read`, `create_index`, `manage` and `index` -* cluster: `monitor` (UI only) -For more information, see <> and <>. +For more information, see <>, <>, and +{ml-docs-setup-privileges}. [[put-transform-desc]] diff --git a/x-pack/docs/en/security/authorization/built-in-roles.asciidoc b/x-pack/docs/en/security/authorization/built-in-roles.asciidoc index 297839d5350..4bef9a921fc 100644 --- a/x-pack/docs/en/security/authorization/built-in-roles.asciidoc +++ b/x-pack/docs/en/security/authorization/built-in-roles.asciidoc @@ -111,8 +111,7 @@ use of the {ml} APIs. Grants `manage_ml` cluster privileges, read access to `.ml-anomalies*`, `.ml-notifications*`, `.ml-state*`, `.ml-meta*` indices and write access to `.ml-annotations*` indices. {ml-cap} administrators also need index privileges for source and destination indices and roles that grant -access to {kib}. -See {ml-docs}/setup.html#setup-privileges[{ml-cap} security privileges]. +access to {kib}. See {ml-docs-setup-privileges}. [[built-in-roles-ml-user]] `machine_learning_user`:: Grants the minimum privileges required to view {ml} configuration, @@ -120,8 +119,7 @@ status, and work with results. This role grants `monitor_ml` cluster privileges, read access to the `.ml-notifications` and `.ml-anomalies*` indices (which store {ml} results), and write access to `.ml-annotations*` indices. {ml-cap} users also need index privileges for source and destination -indices and roles that grant access to {kib}. See -{ml-docs}/setup.html#setup-privileges[{ml-cap} security privileges]. +indices and roles that grant access to {kib}. See {ml-docs-setup-privileges}. [[built-in-roles-monitoring-user]] `monitoring_user`:: Grants the minimum privileges required for any user of {monitoring} other than those