Update workload management topic and doc review of workload management in dashboards (#10673)

* added wlm dashboard documentation

Signed-off-by: Lingxi Chen <[email protected]>

* added more pics

Signed-off-by: Lingxi Chen <[email protected]>

* more action-oriented

Signed-off-by: Lingxi Chen <[email protected]>

* added more detailed description

Signed-off-by: Lingxi Chen <[email protected]>

* Doc review and rewrite of workload management

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Signed-off-by: Nathan Bower <[email protected]>

* Add a better screenshot

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Lingxi Chen <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Nathan Bower <[email protected]>
Co-authored-by: Lingxi Chen <[email protected]>
Co-authored-by: Lindsay-00 <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>

Author: 4 people

_install-and-configure/additional-plugins/index.md

@@ -35,8 +35,9 @@ There are many more plugins available in addition to those provided by the stand
 | `repository-s3`                                                                                                          | 1.0.0                      |
 | `store-smb`                                                                                                              | 1.0.0                      |
 | `transport-grpc`                                                                                                         | 3.0.0                      |
+| `workload-management` | 2.18.0 |
 
-## Related articles
+## Related documentation
 
 [Installing plugins]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/)
 [`ingest-attachment` plugin]({{site.url}}{{site.baseurl}}/install-and-configure/additional-plugins/ingest-attachment-plugin/)

_install-and-configure/configuring-opensearch/plugin-settings.md

@@ -97,4 +97,8 @@ For information about security analytics settings, see [Security Analytics setti
 
 ## SQL plugin settings
 
-For information about settings related to SQL and PPL, see [SQL settings]({{site.url}}{{site.baseurl}}/search-plugins/sql/settings/).
+For information about settings related to SQL and PPL, see [SQL settings]({{site.url}}{{site.baseurl}}/search-plugins/sql/settings/).
+
+## Workload Management plugin settings
+
+For information about workload management settings, see [Workload management settings]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/workload-management/wlm-feature-overview/#workload-management-settings).

_tuning-your-cluster/availability-and-recovery/rule-based-autotagging/autotagging.md

@@ -1,9 +1,9 @@
 ---
 layout: default
 title: Rule-based auto-tagging
-nav_order: 20
-parent: Workload management
-grand_parent: Availability and recovery
+nav_order: 80
+parent: Availability and recovery
+has_children: true
 ---
 
 # Rule-based auto-tagging
@@ -44,7 +44,7 @@ The following rule schema includes matching attributes and a feature-specific va
 ```json
 {
   "_id": "fwehf8302582mglfio349==",  
-  "index_patterns": ["logs-prod-*"],  
+  "index_pattern": ["logs-prod-*"],  
   "other_attribute": ["value1", "value2"],
   "workload_group": "production_workload_id",
   "updated_at": 1683256789000
@@ -53,30 +53,7 @@ The following rule schema includes matching attributes and a feature-specific va
 
 ### Managing rules
 
-Use the following API operations to manage rules for workload management.
-
-#### Create or update a rule
-
-```http
-PUT /_rules/workload_group
-{
-  "index_patterns": ["prod-logs-*"],
-  "other_attribute": ["value1"],
-  "workload_group": "production_workload_id"
-}
-```
-
-#### List rules
-
-```http
-GET /_rules/workload_group
-```
-
-#### Delete a rule
-
-```http
-DELETE /_rules/workload_group/{rule_id}
-```
+Use the [Rules API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/rule-based-autotagging/rule-lifecycle-api/) to manage rules.
 
 ## Attribute matching
 
@@ -123,13 +100,13 @@ These examples demonstrate how rule-based auto-tagging works in workload managem
 
 ```json
 {
-  "index_patterns": ["logs-prod-*"],
+  "index_pattern": ["logs-prod-*"],
   "request_type": ["search", "count"],
   "workload_group": "production_search_workload_id"
 }
 
 {
-  "index_patterns": ["logs-prod-*"],
+  "index_pattern": ["logs-prod-*"],
   "workload_group": "production_workload_id"
 }
 ```
@@ -138,12 +115,12 @@ These examples demonstrate how rule-based auto-tagging works in workload managem
 
 ```json
 {
-  "index_patterns": ["logs-*"],
+  "index_pattern": ["logs-*"],
   "workload_group": "general_workload_id"
 }
 
 {
-  "index_patterns": ["logs-prod-service-*"],
+  "index_pattern": ["logs-prod-service-*"],
   "workload_group": "prod_service_workload_id"
 }
 ```
@@ -199,4 +176,4 @@ You can resolve both issues by validating your configuration using one of the fo
 
 - **Test rules with sample requests**: First, create a rule using the REST API, and then send a request that matches the rule's attributes. For example, for a rule with `"index_pattern": ["logs*", "events*"]`, you can send a request to a `logs` or `events` index. Then verify the workload management statistics by querying the [Workload Management Stats API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/workload-management/wlm-feature-overview/#workload-management-stats-api).
 
-- **Use the [List rules API](#list-rules)** to confirm rule definitions.
+- **Use the [Get Rule API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/rule-based-autotagging/rule-lifecycle-api/#get-a-rule)** to confirm rule definitions.

_tuning-your-cluster/availability-and-recovery/rule-based-autotagging/rule-lifecycle-api.md

@@ -1,14 +1,14 @@
 ---
 layout: default
-title: Rule Lifecycle API
+title: Rules API
 nav_order: 20
-parent: Rule based autotagging
+parent: Rule-based auto-tagging
 grand_parent: Availability and recovery
 ---
 
-# Rule Lifecycle API
+# Rules API
 
-The Rule Lifecycle API allows you to create, update, retrieve, and delete rules. Each rule is associated with a specific feature type and contains a feature value and at least one attribute.
+The Rules API allows you to create, update, retrieve, and delete rules. Each rule is associated with a specific feature type and contains a feature value and at least one attribute.
 These rules are designed to automatically assign feature values to incoming queries based on the specified attributes, helping to categorize and manage queries automatically.
 
 ## Endpoints
@@ -81,7 +81,7 @@ The following table lists the fields available in the request body.
 
 ## Example requests
 
-The following example demonstrates how to use the Rule Lifecycle API to create a rule.
+The following example demonstrates how to use the Rules API to create a rule.
 
 ### Create a rule
 
@@ -114,7 +114,7 @@ PUT _rules/workload_group/0A6RULxkQ9yLqn4r8LPrIg
 You can't change the `feature_type`. Fields that are not updated can be omitted.
 {: .note }
 
-### Get a rule
+### Retrieve a rule
 
 The following request retrieves a rule by ID:
 
@@ -143,7 +143,7 @@ To retrieve the next page, send another request to the same endpoint using the s
 The following example continues the search for all rules of the `workload_group` feature type where the `index_pattern` attribute contains the values `a` or `b`:
 
 ```json
-"GET /_rules/workload_group?index_pattern=a,b&search_after=z1MJApUB0zgMcDmz-UQq"
+GET /_rules/workload_group?index_pattern=a,b&search_after=z1MJApUB0zgMcDmz-UQq
 ```
 {% include copy-curl.html %}