1
0
Эх сурвалжийг харах

[DOCS] Forms role and privilege requirements as bulleted lists in DFA API docs (#50732)

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
István Zoltán Szabó 5 жил өмнө
parent
commit
bc21500201

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

@@ -21,8 +21,12 @@ experimental[]
 [[ml-delete-dfanalytics-prereq]]
 ==== {api-prereq-title}
 
-* You must have `machine_learning_admin` built-in role to use this API. For more
-information, see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
+
+* `machine_learning_admin`
+* `kibana_user` (UI only)
+
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-delete-dfanalytics-path-params]]

+ 6 - 3
docs/reference/ml/df-analytics/apis/delete-inference-trained-model.asciidoc

@@ -22,8 +22,12 @@ experimental[]
 [[ml-delete-inference-prereq]]
 ==== {api-prereq-title}
 
-* You must have `machine_learning_admin` built-in role to use this API. For more 
-information, see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
+
+* `machine_learning_admin`
+* `kibana_user` (UI only)
+
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-delete-inference-path-params]]
@@ -64,4 +68,3 @@ The API returns the following result:
 }
 ----
 
-

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

@@ -22,8 +22,11 @@ experimental[]
 [[ml-evaluate-dfanalytics-prereq]]
 ==== {api-prereq-title}
 
-* You must have `monitor_ml` privilege to use this API. For more 
-information, see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following privileges:
+
+* cluster: `monitor_ml`
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-evaluate-dfanalytics-desc]]
@@ -426,4 +429,4 @@ predictions associated with the class.
 <4> The number of cats in the dataset that are correctly identified as cats.
 <5> The number of cats in the dataset that are incorrectly classified as dogs.
 <6> The number of documents that are classified as a class that is not listed as 
-a `predicted_class`.
+a `predicted_class`.

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

@@ -28,8 +28,11 @@ experimental[]
 [[ml-explain-dfanalytics-prereq]]
 ==== {api-prereq-title}
 
-* You must have `monitor_ml` privilege to use this API. For more
-information, see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following privileges:
+
+* cluster: `monitor_ml`
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-explain-dfanalytics-desc]]

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

@@ -28,8 +28,11 @@ experimental[]
 [[ml-get-dfanalytics-stats-prereq]]
 ==== {api-prereq-title}
 
-* You must have `monitor_ml` privilege to use this API. For more 
-information, see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following privileges:
+
+* cluster: `monitor_ml`
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-get-dfanalytics-stats-path-params]]

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

@@ -27,8 +27,11 @@ experimental[]
 [[ml-get-dfanalytics-prereq]]
 ==== {api-prereq-title}
 
-* You must have `monitor_ml` privilege to use this API. For more information, 
-see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following privileges:
+
+* cluster: `monitor_ml`
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-get-dfanalytics-desc]]

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

@@ -29,8 +29,11 @@ experimental[]
 [[ml-get-inference-stats-prereq]]
 ==== {api-prereq-title}
 
-* You must have `monitor_ml` privilege to use this API. For more information, 
-see <<security-privileges>> and <<built-in-roles>>.
+Required privileges which should be added to a custom role:
+
+* cluster: `monitor_ml`
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-get-inference-stats-desc]]

+ 5 - 2
docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc

@@ -29,8 +29,11 @@ experimental[]
 [[ml-get-inference-prereq]]
 ==== {api-prereq-title}
 
-* You must have `monitor_ml` privilege to use this API. For more information, 
-see <<security-privileges>> and <<built-in-roles>>.
+Required privileges which should be added to a custom role:
+
+* cluster: `monitor_ml`
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-get-inference-desc]]

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

@@ -20,10 +20,17 @@ experimental[]
 [[ml-put-dfanalytics-prereq]]
 ==== {api-prereq-title}
 
-* 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 
-`read`, `create_index`, and `index` privileges on the destination index. For 
-more information, see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following built-in roles and privileges:
+
+* `machine_learning_admin`
+* `kibana_user` (UI only)
+
+
+* source index: `read`, `view_index_metadata`
+* destination index: `read`, `create_index`, `manage` and `index`
+* cluster: `monitor` (UI only)
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
 
 
 [[ml-put-dfanalytics-desc]]

+ 12 - 4
docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc

@@ -20,10 +20,18 @@ experimental[]
 [[ml-start-dfanalytics-prereq]]
 ==== {api-prereq-title}
 
-* 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 
-`read`, `create_index`, and `index` privileges on the destination index. For 
-more information, see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following built-in roles and privileges:
+
+* `machine_learning_admin`
+* `kibana_user` (UI only)
+
+
+* source index: `read`, `view_index_metadata`
+* destination index: `read`, `create_index`, `manage` and `index`
+* cluster: `monitor` (UI only)
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
+
 
 [[ml-start-dfanalytics-path-params]]
 ==== {api-path-parms-title}

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

@@ -24,8 +24,13 @@ experimental[]
 [[ml-stop-dfanalytics-prereq]]
 ==== {api-prereq-title}
 
-* You must have `machine_learning_admin` built-in role to use this API. For more 
-information, see <<security-privileges>> and <<built-in-roles>>.
+If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
+
+* `machine_learning_admin`
+* `kibana_user` (UI only)
+  
+For more information, see <<security-privileges>> and <<built-in-roles>>.
+
 
 [[ml-stop-dfanalytics-desc]]
 ==== {api-description-title}