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
|The name of awareness attribute, usually
|The value of the awareness attribute. For example, if you have shards allocated in two different zones, you can give each zone a value of
zoneb. The cluster decommission operation decommissions the zone listed in the method.
Example: Decommissioning and recommissioning a zone
You can use the following example requests to decommission and recommission a zone:
The following example request decommissions
If you want to recommission a decommissioned zone, you can use the
Example: Getting zone decommission status
The following example requests returns the decommission status of all zones.
"zone-1": "INIT | DRAINING | IN_PROGRESS | SUCCESSFUL | FAILED"
- For more information about zone awareness and weight, see Cluster awareness.
- For more information about allocation awareness, see Cluster formation.