Browse Source

[DOCS] Expands DFA and TM API docs with required privileges info (#71335)

István Zoltán Szabó 4 years ago
parent
commit
ce9dd74cf5

+ 2 - 6
docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc

@@ -19,12 +19,8 @@ Deletes an existing {dfanalytics-job}.
 [[ml-delete-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following 
-built-in roles or equivalent privileges:
-
-* `machine_learning_admin`
-
-For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
+Requires the `manage_ml` cluster privilege. This privilege is included in the 
+`machine_learning_admin` built-in role.
 
 
 [[ml-delete-dfanalytics-path-params]]

+ 2 - 6
docs/reference/ml/df-analytics/apis/delete-trained-models-aliases.asciidoc

@@ -19,13 +19,9 @@ Deletes a trained model alias.
 [[ml-delete-trained-models-aliases-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-built-in roles and privileges:
+Requires the `manage_ml` cluster privilege. This privilege is included in the 
+`machine_learning_admin` built-in role.
 
-* `machine_learning_admin`
-
-For more information, see <<built-in-roles>>, <<security-privileges>>, and
-{ml-docs-setup-privileges}.
 
 [[ml-delete-trained-models-aliases-desc]]
 == {api-description-title}

+ 2 - 6
docs/reference/ml/df-analytics/apis/delete-trained-models.asciidoc

@@ -20,12 +20,8 @@ ingest pipeline.
 [[ml-delete-trained-models-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-built-in roles or equivalent privileges:
-
-* `machine_learning_admin`
-
-For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
+Requires the `manage_ml` cluster privilege. This privilege is included in the 
+`machine_learning_admin` built-in role.
 
 
 [[ml-delete-trained-models-path-params]]

+ 4 - 6
docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc

@@ -20,13 +20,11 @@ Evaluates the {dfanalytics} for an annotated index.
 [[ml-evaluate-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following 
-privileges:
+Requires the following privileges:
 
-* cluster: `monitor_ml`
-  
-For more information, see <<security-privileges>> and 
-{ml-docs-setup-privileges}.
+* cluster: `monitor_ml` (the `machine_learning_user` built-in role grants this 
+  privilege)
+* destination index: `read`
 
 
 [[ml-evaluate-dfanalytics-desc]]

+ 3 - 6
docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc

@@ -26,14 +26,11 @@ Explains a {dataframe-analytics-config}.
 [[ml-explain-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following 
-privileges:
+Requires the following privileges:
 
-* cluster: `monitor_ml`
+* cluster: `monitor_ml` (the `machine_learning_user` built-in role grants this 
+  privilege)
 * source indices: `read`, `view_index_metadata`
-  
-For more information, see <<security-privileges>> and 
-{ml-docs-setup-privileges}.
 
 
 [[ml-explain-dfanalytics-desc]]

+ 2 - 5
docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc

@@ -27,12 +27,9 @@ Retrieves usage information for {dfanalytics-jobs}.
 [[ml-get-dfanalytics-stats-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following 
-privileges:
+Requires the `monitor_ml` cluster privilege. This privilege is included in the 
+`machine_learning_user` built-in role.
 
-* cluster: `monitor_ml`
-  
-For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
 
 [[ml-get-dfanalytics-stats-path-params]]
 == {api-path-parms-title}

+ 2 - 6
docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc

@@ -25,12 +25,8 @@ Retrieves configuration information for {dfanalytics-jobs}.
 [[ml-get-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-privileges:
-
-* cluster: `monitor_ml`
-
-For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
+Requires the `monitor_ml` cluster privilege. This privilege is included in the 
+`machine_learning_user` built-in role.
 
 
 [[ml-get-dfanalytics-desc]]

+ 2 - 5
docs/reference/ml/df-analytics/apis/get-trained-models-stats.asciidoc

@@ -27,12 +27,9 @@ Retrieves usage information for trained models.
 [[ml-get-trained-models-stats-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-privileges:
+Requires the `monitor_ml` cluster privilege. This privilege is included in the 
+`machine_learning_user` built-in role.
 
-* cluster: `monitor_ml`
-
-For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
 
 [[ml-get-trained-models-stats-desc]]
 == {api-description-title}

+ 2 - 7
docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc

@@ -27,13 +27,8 @@ Retrieves configuration information for a trained model.
 [[ml-get-trained-models-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-privileges:
-
-* cluster: `monitor_ml`
-
-For more information, see <<security-privileges>> and
-{ml-docs-setup-privileges}.
+Requires the `monitor_ml` cluster privilege. This privilege is included in the 
+`machine_learning_user` built-in role.
 
 
 [[ml-get-trained-models-desc]]

+ 2 - 6
docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc

@@ -26,12 +26,8 @@ Previews the features used by a {dataframe-analytics-config}.
 [[ml-preview-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-privileges:
-
-* cluster: `monitor_ml`
-
-For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
+Requires the `monitor_ml` cluster privilege. This privilege is included in the 
+`machine_learning_user` built-in role.
 
 
 [[ml-preview-dfanalytics-desc]]

+ 4 - 7
docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc

@@ -19,17 +19,14 @@ Instantiates a {dfanalytics-job}.
 [[ml-put-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-built-in roles and privileges:
 
-* `machine_learning_admin`
+Requires the following privileges:
+
+* cluster: `manage_ml` (the `machine_learning_admin` built-in role grants this 
+  privilege)
 * source indices: `read`, `view_index_metadata`
 * destination index: `read`, `create_index`, `manage` and `index`
 
-For more information, see <<built-in-roles>>, <<security-privileges>>, 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
 those same roles. If you provide

+ 2 - 6
docs/reference/ml/df-analytics/apis/put-trained-models-aliases.asciidoc

@@ -21,13 +21,9 @@ A trained model alias is a logical name used to reference a single trained model
 [[ml-put-trained-models-aliases-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-built-in role:
+Requires the `manage_ml` cluster privilege. This privilege is included in the 
+`machine_learning_admin` built-in role.
 
-* `machine_learning_admin`
-
-For more information, see <<built-in-roles>>, <<security-privileges>>, and
-{ml-docs-setup-privileges}.
 
 [[ml-put-trained-models-aliases-desc]]
 == {api-description-title}

+ 2 - 6
docs/reference/ml/df-analytics/apis/put-trained-models.asciidoc

@@ -24,12 +24,8 @@ WARNING: Models created in version 7.8.0 are not backwards compatible
 [[ml-put-trained-models-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following
-built-in roles or equivalent privileges:
-
-* `machine_learning_admin`
-
-For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
+Requires the `manage_ml` cluster privilege. This privilege is included in the 
+`machine_learning_admin` built-in role.
 
 
 [[ml-put-trained-models-desc]]

+ 3 - 5
docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc

@@ -19,15 +19,13 @@ Starts a {dfanalytics-job}.
 [[ml-start-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following 
-built-in roles and privileges:
+Requires the following privileges:
 
-* `machine_learning_admin`
+* cluster: `manage_ml` (the `machine_learning_admin` built-in role grants this 
+  privilege)
 * source indices: `read`, `view_index_metadata`
 * destination index: `read`, `create_index`, `manage` and `index`
 
-For more information, see <<built-in-roles>>, <<security-privileges>>, and
-{ml-docs-setup-privileges}.
 
 [[ml-start-dfanalytics-desc]]
 == {api-description-title}

+ 2 - 6
docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc

@@ -23,12 +23,8 @@ Stops one or more {dfanalytics-jobs}.
 [[ml-stop-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following 
-built-in roles or equivalent privileges:
-
-* `machine_learning_admin`
-  
-For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
+Requires the `manage_ml` cluster privilege. This privilege is included in the 
+`machine_learning_admin` built-in role.
 
 
 [[ml-stop-dfanalytics-desc]]

+ 4 - 6
docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc

@@ -19,15 +19,12 @@ Updates an existing {dfanalytics-job}.
 [[ml-update-dfanalytics-prereq]]
 == {api-prereq-title}
 
-If the {es} {security-features} are enabled, you must have the following 
-built-in roles and privileges:
+Requires the following privileges:
 
-* `machine_learning_admin`
+* cluster: `manage_ml` (the `machine_learning_admin` built-in role grants this 
+  privilege)
 * source indices: `read`, `view_index_metadata`
 * destination index: `read`, `create_index`, `manage` and `index`
-  
-For more information, see <<built-in-roles>>, <<security-privileges>>, and
-{ml-docs-setup-privileges}.
 
 NOTE: The {dfanalytics-job} remembers which roles the user who updated it had at
 the time of the update. When you start the job, it performs the analysis using
@@ -35,6 +32,7 @@ those same roles. If you provide
 <<http-clients-secondary-authorization,secondary authorization headers>>, 
 those credentials are used instead.
 
+
 [[ml-update-dfanalytics-desc]]
 == {api-description-title}