Skip to content

Commit 7de48a4

Browse files
lcawlgithub-actions[bot]
authored andcommitted
[DOCS] Edit node lifecycle summaries (#3309)
(cherry picked from commit 0a8b60a)
1 parent cb6399b commit 7de48a4

File tree

5 files changed

+66
-17
lines changed

5 files changed

+66
-17
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 24 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,18 @@ import { NodeId } from '@_types/common'
2222
import { TimeUnit } from '@_types/Time'
2323

2424
/**
25+
* Cancel node shutdown preparations.
26+
* Remove a node from the shutdown list so it can resume normal operations.
27+
* You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.
28+
* Shutdown requests are never removed automatically by Elasticsearch.
29+
*
30+
* NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
31+
* Direct use is not supported.
32+
*
33+
* If the operator privileges feature is enabled, you must be an operator to use this API.
2534
* @rest_spec_name shutdown.delete_node
2635
* @availability stack since=7.13.0 stability=stable
36+
* @cluster_privileges manage
2737
*/
2838
export interface Request extends RequestBase {
2939
path_parts: {

specification/shutdown/get_node/ShutdownGetNodeRequest.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,17 @@ import { NodeIds } from '@_types/common'
2222
import { TimeUnit } from '@_types/Time'
2323

2424
/**
25+
* Get the shutdown status.
26+
*
27+
* Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.
28+
* The API returns status information for each part of the shut down process.
29+
*
30+
* NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
31+
*
32+
* If the operator privileges feature is enabled, you must be an operator to use this API.
2533
* @rest_spec_name shutdown.get_node
2634
* @availability stack since=7.13.0 stability=stable
35+
* @cluster_privileges manage
2736
*/
2837
export interface Request extends RequestBase {
2938
path_parts: {

specification/shutdown/put_node/ShutdownPutNodeRequest.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,23 @@ import { TimeUnit } from '@_types/Time'
2323
import { Type } from '../_types/types'
2424

2525
/**
26+
* Prepare a node to be shut down.
27+
*
28+
* NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
29+
*
30+
* If the operator privileges feature is enabled, you must be an operator to use this API.
31+
*
32+
* The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.
33+
* This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.
34+
*
35+
* You must specify the type of shutdown: `restart`, `remove`, or `replace`.
36+
* If a node is already being prepared for shutdown, you can use this API to change the shutdown type.
37+
*
38+
* IMPORTANT: This API does NOT terminate the Elasticsearch process.
39+
* Monitor the node shutdown status to determine when it is safe to stop Elasticsearch.
2640
* @rest_spec_name shutdown.put_node
2741
* @availability stack since=7.13.0 stability=stable
42+
* @cluster_privileges manage
2843
*/
2944
export interface Request extends RequestBase {
3045
path_parts: {

0 commit comments

Comments
 (0)