[DOCS] Edit cluster operation summaries (#3256) (#3257)

github-actions[bot] · lcawl · web-flow · commit b5e7786c0f50 · 2024-12-05T13:12:37.000-08:00
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> (cherry picked from commit 0215517) Co-authored-by: Lisa Cawley <lcawley@elastic.co>
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv
@@ -1,3 +1,4 @@
+add-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html
 analysis-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-analyzers.html
 analysis-charfilters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html
 analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html
diff --git a/specification/_global/health_report/Request.ts b/specification/_global/health_report/Request.ts
@@ -22,6 +22,24 @@ import { integer } from '@_types/Numeric'
 import { Duration } from '@_types/Time'
 
 /**
+ * Get the cluster health.
+ * Get a report with the health status of an Elasticsearch cluster.
+ * The report contains a list of indicators that compose Elasticsearch functionality.
+ *
+ * Each indicator has a health status of: green, unknown, yellow or red.
+ * The indicator will provide an explanation and metadata describing the reason for its current health status.
+ *
+ * The cluster’s status is controlled by the worst indicator status.
+ *
+ * In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.
+ * Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.
+ *
+ * Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.
+ * The root cause and remediation steps are encapsulated in a diagnosis.
+ * A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.
+ *
+ * NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.
+ * When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.
  * @rest_spec_name health_report
  * @availability stack since=8.7.0 stability=stable
  * @availability serverless stability=stable visibility=private
diff --git a/specification/_global/ping/PingRequest.ts b/specification/_global/ping/PingRequest.ts
@@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base'
 
 /**
  * Ping the cluster.
- * Returns whether the cluster is running.
+ * Get information about whether the cluster is running.
  * @rest_spec_name ping
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=public
diff --git a/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts b/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts
@@ -22,6 +22,11 @@ import { IndexName } from '@_types/common'
 import { integer } from '@_types/Numeric'
 
 /**
+ * Explain the shard allocations.
+ * Get explanations for shard allocations in the cluster.
+ * For unassigned shards, it provides an explanation for why the shard is unassigned.
+ * For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.
+ * This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.
  * @rest_spec_name cluster.allocation_explain
  * @availability stack since=5.0.0 stability=stable
  * @availability serverless stability=stable visibility=private
diff --git a/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts b/specification/cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts
@@ -20,9 +20,12 @@
 import { RequestBase } from '@_types/Base'
 
 /**
+ * Clear cluster voting config exclusions.
+ * Remove master-eligible nodes from the voting configuration exclusion list.
  * @rest_spec_name cluster.delete_voting_config_exclusions
  * @availability stack since=7.0.0 stability=stable
  * @doc_id voting-config-exclusions
+ * @ext_doc_id add-nodes
  */
 export interface Request extends RequestBase {
   query_parameters: {
diff --git a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts
@@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base'
 import { Duration } from '@_types/Time'
 
 /**
- * Returns cluster-wide settings.
+ * Get cluster-wide settings.
  * By default, it returns only settings that have been explicitly defined.
  * @rest_spec_name cluster.get_settings
  * @availability stack stability=stable
diff --git a/specification/cluster/health/ClusterHealthRequest.ts b/specification/cluster/health/ClusterHealthRequest.ts
@@ -30,8 +30,16 @@ import { integer } from '@_types/Numeric'
 import { Duration } from '@_types/Time'
 
 /**
- * The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.
- * The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.
+ * Get the cluster health status.
+ * You can also use the API to get the health status of only specified data streams and indices.
+ * For data streams, the API retrieves the health status of the stream’s backing indices.
+ *
+ * The cluster health status is: green, yellow or red.
+ * On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.
+ * The index level status is controlled by the worst shard status.
+ *
+ * One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.
+ * The cluster status is controlled by the worst index status.
  * @rest_spec_name cluster.health
  * @availability stack since=1.3.0 stability=stable
  * @availability serverless stability=stable visibility=private
diff --git a/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts b/specification/cluster/pending_tasks/ClusterPendingTasksRequest.ts
@@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base'
 import { Duration } from '@_types/Time'
 
 /**
- * Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
+ * Get the pending cluster tasks.
+ * Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.
+ *
  * NOTE: This API returns a list of any pending updates to the cluster state.
- * These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
+ * These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
  * However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.
  * @rest_spec_name cluster.pending_tasks
  * @availability stack stability=stable
diff --git a/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts b/specification/cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts
@@ -22,9 +22,28 @@ import { Ids, Names } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
+ * Update voting configuration exclusions.
+ * Update the cluster voting config exclusions by node IDs or node names.
+ * By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.
+ * If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually.
+ * The API adds an entry for each specified node to the cluster’s voting configuration exclusions list.
+ * It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.
+ *
+ * Clusters should have no voting configuration exclusions in normal operation.
+ * Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`.
+ * This API waits for the nodes to be fully removed from the cluster before it returns.
+ * If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.
+ *
+ * A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.
+ * If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration.
+ * In that case, you may safely retry the call.
+ *
+ * NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period.
+ * They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.
  * @rest_spec_name cluster.post_voting_config_exclusions
  * @availability stack since=7.0.0 stability=stable
  * @doc_id voting-config-exclusions
+ * @ext_doc_id add-nodes
  */
 export interface Request extends RequestBase {
   query_parameters: {
diff --git a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts
@@ -23,6 +23,24 @@ import { RequestBase } from '@_types/Base'
 import { Duration } from '@_types/Time'
 
 /**
+ * Update the cluster settings.
+ * Configure and update dynamic settings on a running cluster.
+ * You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.
+ *
+ * Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.
+ * You can also reset transient or persistent settings by assigning them a null value.
+ *
+ * If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.
+ * For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.
+ * However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.
+ *
+ * TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.
+ * If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.
+ * Only use `elasticsearch.yml` for static cluster settings and node settings.
+ * The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.
+ *
+ * WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.
+ * If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.
  * @rest_spec_name cluster.put_settings
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=private
diff --git a/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts b/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts
@@ -20,9 +20,9 @@
 import { RequestBase } from '@_types/Base'
 
 /**
- * The cluster remote info API allows you to retrieve all of the configured
- * remote cluster information. It returns connection and endpoint information
- * keyed by the configured remote cluster alias.
+ * Get remote cluster information.
+ * Get all of the configured remote cluster information.
+ * This API returns connection and endpoint information keyed by the configured remote cluster alias.
  * @rest_spec_name cluster.remote_info
  * @availability stack since=6.1.0 stability=stable
  * @doc_id cluster-remote-info
diff --git a/specification/cluster/reroute/ClusterRerouteRequest.ts b/specification/cluster/reroute/ClusterRerouteRequest.ts
@@ -23,6 +23,20 @@ import { Duration } from '@_types/Time'
 import { Command } from './types'
 
 /**
+ * Reroute the cluster.
+ * Manually change the allocation of individual shards in the cluster.
+ * For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.
+ *
+ * It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state.
+ * For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.
+ *
+ * The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting.
+ * If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.
+ *
+ * The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated.
+ * This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.
+ *
+ * Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards.
  * @rest_spec_name cluster.reroute
  * @availability stack since=5.0.0 stability=stable
  * @availability serverless stability=stable visibility=private
@@ -31,12 +45,13 @@ import { Command } from './types'
 export interface Request extends RequestBase {
   query_parameters: {
     /**
-     * If true, then the request simulates the operation only and returns the resulting state.
+     * If true, then the request simulates the operation.
+     * It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.
      * @server_default false
      */
     dry_run?: boolean
     /**
-     * If true, then the response contains an explanation of why the commands can or cannot be executed.
+     * If true, then the response contains an explanation of why the commands can or cannot run.
      * @server_default false
      */
     explain?: boolean
diff --git a/specification/cluster/state/ClusterStateRequest.ts b/specification/cluster/state/ClusterStateRequest.ts
@@ -27,6 +27,25 @@ import {
 import { Duration } from '@_types/Time'
 
 /**
+ * Get the cluster state.
+ * Get comprehensive information about the state of the cluster.
+ *
+ * The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.
+ *
+ * The elected master node ensures that every node in the cluster has a copy of the same cluster state.
+ * This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.
+ * You may need to consult the Elasticsearch source code to determine the precise meaning of the response.
+ *
+ * By default the API will route requests to the elected master node since this node is the authoritative source of cluster states.
+ * You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.
+ *
+ * Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data.
+ * If you use this API repeatedly, your cluster may become unstable.
+ *
+ * WARNING: The response is a representation of an internal data structure.
+ * Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version.
+ * Do not query this API using external monitoring tools.
+ * Instead, obtain the information you require using other more stable cluster APIs.
  * @rest_spec_name cluster.state
  * @availability stack since=1.3.0 stability=stable
  * @availability serverless stability=stable visibility=private
diff --git a/specification/cluster/stats/ClusterStatsRequest.ts b/specification/cluster/stats/ClusterStatsRequest.ts
@@ -22,8 +22,8 @@ import { NodeIds } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
- * Returns cluster statistics.
- * It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
+ * Get cluster statistics.
+ * Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
  * @rest_spec_name cluster.stats
  * @availability stack since=1.3.0 stability=stable
  * @availability serverless stability=stable visibility=private
diff --git a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts
@@ -22,7 +22,8 @@ import { NodeIds } from '@_types/common'
 import { long } from '@_types/Numeric'
 
 /**
- * You can use this API to clear the archived repositories metering information in the cluster.
+ * Clear the archived repositories metering.
+ * Clear the archived repositories metering information in the cluster.
  * @rest_spec_name nodes.clear_repositories_metering_archive
  * @availability stack since=7.16.0 stability=experimental
  * @availability serverless stability=experimental visibility=private
diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts
@@ -21,10 +21,10 @@ import { RequestBase } from '@_types/Base'
 import { NodeIds } from '@_types/common'
 
 /**
- * You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
- * This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the
- * information needed to compute aggregations over a period of time. Additionally, the information exposed by this
- * API is volatile, meaning that it won’t be present after node restarts.
+ * Get cluster repositories metering.
+ * Get repositories metering information for a cluster.
+ * This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.
+ * Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.
  * @rest_spec_name nodes.get_repositories_metering_info
  * @availability stack since=7.16.0 stability=experimental
  * @availability serverless stability=experimental visibility=private
diff --git a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts
@@ -23,8 +23,9 @@ import { long } from '@_types/Numeric'
 import { Duration } from '@_types/Time'
 
 /**
- * This API yields a breakdown of the hot threads on each selected node in the cluster.
- * The output is plain text with a breakdown of each node’s top hot threads.
+ * Get the hot threads for nodes.
+ * Get a breakdown of the hot threads on each selected node in the cluster.
+ * The output is plain text with a breakdown of the top hot threads for each node.
  * @rest_spec_name nodes.hot_threads
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=private
diff --git a/specification/nodes/info/NodesInfoRequest.ts b/specification/nodes/info/NodesInfoRequest.ts
@@ -22,7 +22,8 @@ import { Metrics, NodeIds } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
- * Returns cluster nodes information.
+ * Get node information.
+ * By default, the API returns all attributes and core settings for cluster nodes.
  * @rest_spec_name nodes.info
  * @availability stack since=1.3.0 stability=stable
  * @availability serverless stability=stable visibility=private
diff --git a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts
diff --git a/specification/nodes/stats/NodesStatsRequest.ts b/specification/nodes/stats/NodesStatsRequest.ts
diff --git a/specification/nodes/usage/NodesUsageRequest.ts b/specification/nodes/usage/NodesUsageRequest.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+add-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html`
`1`	`2`	`analysis-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-analyzers.html`
`2`	`3`	`analysis-charfilters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html`
`3`	`4`	`analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html`