Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved shard allocation awareness attributes documentation #8268

Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions _tuning-your-cluster/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,11 +192,17 @@ To better understand and monitor your cluster, use the [CAT API]({{site.url}}{{s

## (Advanced) Step 6: Configure shard allocation awareness or forced awareness

To further fine-tune your shard allocation, you can set custom node attributes for shard allocation awareness or forced awareness.

### Shard allocation awareness

If your nodes are spread across several geographical zones, you can configure shard allocation awareness to allocate all replica shards to a zone that’s different from their primary shard.
You can set custom node attributes on OpenSearch nodes to be used for shard allocation awareness. For example, you can set the `zone` attribute on each node to represent the zone in which the node is located. You can also use the `zone` attribute to ensure that primary shard and its replica shards are allocated in a balanced manner across available distinct zones, for example, maximum shard copies per zone would equal `ceil (number_of_shard_copies/number_of_distinct_zones)`.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

Shard allocation awareness attempts to separate primary and replica shards across multiple zones. However, if only one zone is available (such as after a zone failure), OpenSearch allocates replica shards to the only remaining zone. If your index has total 5 shard copies (1 primary and 4 replicas) and nodes in only 3 distinct zones, then OpenSearch will not allocate more than 2 shards per zone, so you need at least 2 nodes in 2 zones each and at least 1 node in the 3rd zone to allocate all 5 shard copies.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

With shard allocation awareness, if the nodes in one of your zones fail, you can be assured that your replica shards are spread across your other zones. It adds a layer of fault tolerance to ensure your data survives a zone failure beyond just individual node failures.
If you have 3 nodes in the 1st zone and 1 node each in every remaining zone, then OpenSearch will only allocate 2,1,1 shard copies leaving the 5th copy unallocated.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

With shard allocation awareness, if the nodes in one of your zones fail, you can be assured that your replica shards are spread across your other zones, adding a layer of fault tolerance to ensure your data survives zone failures.
patelsmit32123 marked this conversation as resolved.
Show resolved Hide resolved

To configure shard allocation awareness, add zone attributes to `opensearch-d1` and `opensearch-d2`, respectively:

Expand All @@ -219,6 +225,8 @@ PUT _cluster/settings
}
```

You can also use multiple attributes for shard allocation awareness by providing the attributes as a comma separated string, for example `zone,rack`.
patelsmit32123 marked this conversation as resolved.
Show resolved Hide resolved

You can either use `persistent` or `transient` settings. We recommend the `persistent` setting because it persists through a cluster reboot. Transient settings don't persist through a cluster reboot.

Shard allocation awareness attempts to separate primary and replica shards across multiple zones. However, if only one zone is available (such as after a zone failure), OpenSearch allocates replica shards to the only remaining zone.
Expand Down