Browse Source

Document all shard allocation filtering attributes (#46992)

This commit adds coverage to the docs for some missing built-in shard
allocation attributes.
weizijun 6 years ago
parent
commit
22042cc199

+ 2 - 1
docs/reference/index-modules/allocation/filtering.asciidoc

@@ -7,7 +7,7 @@ a particular index. These per-index filters are applied in conjunction with
 <<allocation-awareness, allocation awareness>>.
 <<allocation-awareness, allocation awareness>>.
 
 
 Shard allocation filters can be based on custom node attributes or the built-in
 Shard allocation filters can be based on custom node attributes or the built-in
-`_name`, `host_ip`, `publish_ip`, `_ip`, and `_host` attributes.
+`_name`, `_host_ip`, `_publish_ip`, `_ip`, `_host` and `_id` attributes.
 <<index-lifecycle-management, Index lifecycle management>> uses filters based
 <<index-lifecycle-management, Index lifecycle management>> uses filters based
 on custom node attributes to determine how to reallocate shards when moving
 on custom node attributes to determine how to reallocate shards when moving
 between phases.
 between phases.
@@ -101,6 +101,7 @@ The index allocation settings support the following built-in attributes:
 `_publish_ip`:: Match nodes by publish IP address
 `_publish_ip`:: Match nodes by publish IP address
 `_ip`::         Match either `_host_ip` or `_publish_ip`
 `_ip`::         Match either `_host_ip` or `_publish_ip`
 `_host`::       Match nodes by hostname
 `_host`::       Match nodes by hostname
+`_id`::         Match nodes by node id
 
 
 You can use wildcards when specifying attribute values, for example:
 You can use wildcards when specifying attribute values, for example:
 
 

+ 9 - 4
docs/reference/modules/cluster/allocation_filtering.asciidoc

@@ -7,7 +7,7 @@ conjunction with <<shard-allocation-filtering, per-index allocation filtering>>
 and <<allocation-awareness, allocation awareness>>.
 and <<allocation-awareness, allocation awareness>>.
 
 
 Shard allocation filters can be based on custom node attributes or the built-in
 Shard allocation filters can be based on custom node attributes or the built-in
-`_name`, `_ip`, and `_host` attributes.
+`_name`, `_host_ip`, `_publish_ip`, `_ip`, `_host` and `_id` attributes.
 
 
 The `cluster.routing.allocation` settings are dynamic, enabling live indices to
 The `cluster.routing.allocation` settings are dynamic, enabling live indices to
 be moved from one set of nodes to another. Shards are only relocated if it is
 be moved from one set of nodes to another. Shards are only relocated if it is
@@ -50,9 +50,14 @@ PUT _cluster/settings
 The cluster allocation settings support the following built-in attributes:
 The cluster allocation settings support the following built-in attributes:
 
 
 [horizontal]
 [horizontal]
-`_name`::   Match nodes by node names
-`_ip`::     Match nodes by IP addresses (the IP address associated with the hostname)
-`_host`::   Match nodes by hostnames
+`_name`::       Match nodes by node name
+`_host_ip`::    Match nodes by host IP address (IP associated with hostname)
+`_publish_ip`:: Match nodes by publish IP address
+`_ip`::         Match either `_host_ip` or `_publish_ip`
+`_host`::       Match nodes by hostname
+`_id`::         Match nodes by node id
+
+
 
 
 You can use wildcards when specifying attribute values, for example:
 You can use wildcards when specifying attribute values, for example: