You're viewing version 2.8 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Cluster decommission

The cluster decommission operation adds support decommissioning based on awareness. It greatly benefits multi-zone deployments, where awareness attributes, such as zones, can aid in applying new upgrades to a cluster in a controlled fashion. This is especially useful during outages, in which case, you can decommission the unhealthy zone to prevent replication requests from stalling and prevent your request backlog from becoming too large.

For more information about allocation awareness, see Shard allocation awareness.

HTTP and Path methods

PUT  /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}
GET  /_cluster/decommission/awareness/{awareness_attribute_name}/_status
DELETE /_cluster/decommission/awareness

URL parameters

Example: Decommissioning and recommissioning a zone

You can use the following example requests to decommission and recommission a zone:

Request

The following example request decommissions zone-a:

PUT /_cluster/decommission/awareness/<zone>/<zone-a>

If you want to recommission a decommissioned zone, you can use the DELETE method:

DELETE /_cluster/decommission/awareness

Response

{
      "acknowledged": true
}

Example: Getting zone decommission status

The following example requests returns the decommission status of all zones.

Request

GET /_cluster/decommission/awareness/zone/_status

Response

{
     "zone-1": "INIT | DRAINING | IN_PROGRESS | SUCCESSFUL | FAILED"
}

Next steps

• For more information about zone awareness and weight, see Cluster awareness.
• For more information about allocation awareness, see Cluster formation.