OpenSearch/docs/reference
Jason Tedor 52ad5842a9
Introduce node.roles setting (#58512)
Today we have individual settings for configuring node roles such as
node.data and node.master. Additionally, roles are pluggable and we have
used this to introduce roles such as node.ml and node.voting_only. As
the number of roles is growing, managing these becomes harder for the
user. For example, to create a master-only node, today a user has to
configure:
 - node.data: false
 - node.ingest: false
 - node.remote_cluster_client: false
 - node.ml: false

at a minimum if they are relying on defaults, but also add:
 - node.master: true
 - node.transform: false
 - node.voting_only: false

If they want to be explicit. This is also challenging in cases where a
user wants to have configure a coordinating-only node which requires
disabling all roles, a list which we are adding to, requiring the user
to keep checking whether a node has acquired any of these roles.

This commit addresses this by adding a list setting node.roles for which
a user has explicit control over the list of roles that a node has. If
the setting is configured, the node has exactly the roles in the list,
and not any additional roles. This means to configure a master-only
node, the setting is merely 'node.roles: [master]', and to configure a
coordinating-only node, the setting is merely: 'node.roles: []'.

With this change we deprecate the existing 'node.*' settings such as
'node.data'.
2020-06-25 14:14:51 -04:00
..
aggregations Add Variable Width Histogram Aggregation (backport of #42035) (#58440) 2020-06-25 11:40:47 -04:00
analysis [DOCS] Reformat `pattern_replace` token filter (#57699) (#57995) 2020-06-11 12:19:38 -04:00
autoscaling Add get autoscaling policy API (#54762) 2020-04-04 18:04:25 -04:00
cat [DOCS] Updates pull and issue release attributes (#58348) 2020-06-18 12:55:02 -07:00
ccr Allow follower indices to override leader settings (#58103) 2020-06-18 11:56:06 -04:00
cluster [DOCS] Updates pull and issue release attributes (#58348) 2020-06-18 12:55:02 -07:00
commands Introduce node.roles setting (#58512) 2020-06-25 14:14:51 -04:00
data-streams [DOCS] Note that DS timestamp field mapping changes require reindex (#58444) (#58517) 2020-06-24 17:21:26 -04:00
docs [DOCS] Add data streams to bulk, delete, and index API docs (#58340) (#58434) 2020-06-23 09:40:25 -04:00
eql [7.x] EQL: Adds an ability to execute an asynchronous EQL search (#58192) 2020-06-25 14:11:57 -04:00
graph [DOCS] Collapse nested objects in Explore API docs (#55067) 2020-04-13 09:27:03 -04:00
high-availability [DOCS] Fixes license management links (#58213) 2020-06-16 16:49:48 -07:00
how-to [7.x][DOCS] Replace docdir attribute with es-repo-dir (#57489) (#57494) 2020-06-01 16:42:53 -07:00
ilm [DOCS] Make ILM documentation data stream aware (#58035) (#58110) 2020-06-15 15:16:14 +01:00
images add geo_shape documentation for supported aggregations (#58284) (#58354) 2020-06-18 12:36:24 -07:00
index-modules [DOCS] Relocate `shard allocation` module content (#56535) (#57448) 2020-06-01 13:15:08 -04:00
indices [DOCS] Update aliases to indicate array (#58469) 2020-06-24 09:41:23 -04:00
ingest Update hh to HH in date processor example (#58089) (#58144) 2020-06-15 17:04:14 -05:00
licensing Remove `_xpack` from license API example (#54698) (#54763) 2020-04-07 09:51:37 +03:00
mapping [DOCS] Move search API's `docvalue_fields` examples (#57760) (#57989) 2020-06-11 11:25:04 -04:00
migration [DOCS] Updates pull and issue release attributes (#58348) 2020-06-18 12:55:02 -07:00
ml [DOCS] Updates screenshots in ML population analysis (#58318) 2020-06-23 09:05:08 +02:00
modules Introduce node.roles setting (#58512) 2020-06-25 14:14:51 -04:00
monitoring [DOCS] Rename monitoring collection from internal to legacy (#56395) 2020-06-11 10:21:01 -07:00
query-dsl [DOCS] Extends geo_shape query docs to explain behavior when data is indexed as array of shapes (#57806) 2020-06-08 15:06:10 +02:00
release-notes Docs - Added field capabilities breaking change (#58509) 2020-06-24 18:39:01 +01:00
rest-api [DOCS] Add data streams to bulk, delete, and index API docs (#58340) (#58434) 2020-06-23 09:40:25 -04:00
rollup [DOCS] Adds collapsible sections to rollup APIs (#54690) 2020-04-02 17:51:16 -07:00
scripting Scripting: Deprecate general cache settings (#55753) (#58283) 2020-06-18 11:54:23 -06:00
search Field capabilities - make `keyword` a family of field types (#58315) (#58483) 2020-06-24 12:32:14 +01:00
searchable-snapshots/apis [7.x][DOCS] Replace docdir attribute with es-repo-dir (#57489) (#57494) 2020-06-01 16:42:53 -07:00
settings [DOCS] Fixes license management links (#58213) 2020-06-16 16:49:48 -07:00
setup [DOCS] Fixes license management links (#58213) 2020-06-16 16:49:48 -07:00
slm [DOCS] Editorial ILM cleanup (#57565) (#57776) 2020-06-05 18:55:51 -07:00
snapshot-restore [DOCS] Fixes problematic terminology (#58184) 2020-06-16 11:43:22 -07:00
sql SQL: [Docs] Fix TIME_PARSE documentation (#58182) (#58317) 2020-06-18 16:09:13 +02:00
transform [DOCS] Adds web session details example to painless transform examples (#57942) 2020-06-15 15:19:02 +02:00
upgrade [DOCS] Relocate `shard allocation` module content (#56535) (#57448) 2020-06-01 13:15:08 -04:00
vectors Remove the 'experimental' marking from vector fields. (#49120) 2019-11-18 12:42:46 -08:00
aggregations.asciidoc [Docs] Update aggregations.asciidoc (#29265) 2018-03-28 15:01:45 +02:00
analysis.asciidoc [DOCS] Reformat `stop` token filter (#53059) 2020-03-03 13:22:52 -05:00
api-conventions.asciidoc [DOCS] Replaces docdir attributes in ML APIs (#57390) (#57467) 2020-06-01 13:46:15 -07:00
async-search.asciidoc [DOCS] add docs for async search (#53675) 2020-03-20 14:46:38 +01:00
cat.asciidoc [Transform] renamed _cat/transform to _cat/transforms (#53743) (#53771) 2020-03-18 19:54:03 -04:00
cluster.asciidoc Password-protected Keystore Feature Branch PR (#51123) (#51510) 2020-01-28 05:32:32 -05:00
data-rollup-transform.asciidoc [DOCS] Adds transforms to Elasticsearch book (#46846) (#47055) 2019-09-25 08:11:37 -07:00
docs.asciidoc [DOCS] Remove heading offsets for REST APIs (#44568) 2019-07-19 14:36:06 -04:00
frozen-indices.asciidoc Add heuristics to compute pre_filter_shard_size when unspecified (#53873) (#54007) 2020-03-24 02:05:15 +01:00
getting-started.asciidoc [DOCS] Switch to standard ESS trial links (#52552) 2020-02-21 12:07:10 -05:00
glossary.asciidoc [DOCS] Make ILM documentation data stream aware (#58035) (#58110) 2020-06-15 15:16:14 +01:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
high-availability.asciidoc [DOCS] Add docs for designing resilient clusters (#47233) (#57743) 2020-06-05 12:08:45 -04:00
how-to.asciidoc [DOCS] Add 'how to' doc about avoiding oversharding (#55480) 2020-04-22 10:44:16 -04:00
index-modules.asciidoc [DOCS] Add search pagination docs (#56785) (#57477) 2020-06-01 16:43:06 -04:00
index.asciidoc [DOCS] Reformat release highlights as What's new. (#58073) 2020-06-15 13:26:03 -07:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc [DOCS] Reformat data streams intro and overview (#57954) (#57993) 2020-06-11 11:32:09 -04:00
ingest.asciidoc Replace required pipeline with final pipeline (#49470) 2019-11-22 14:37:36 -05:00
intro.asciidoc [DOCS] Add documentation for near real-time search (#57560) (#58138) 2020-06-15 16:42:57 -04:00
mapping.asciidoc [7.x][DOCS] Replace docdir attribute with es-repo-dir (#57489) (#57494) 2020-06-01 16:42:53 -07:00
query-dsl.asciidoc Add a cluster setting to disallow expensive queries (#51385) (#52279) 2020-02-12 22:56:14 +01:00
redirects.asciidoc [DOCS] Move search API's `docvalue_fields` examples (#57760) (#57989) 2020-06-11 11:25:04 -04:00
release-notes.asciidoc Scripting: Deprecate general cache settings (#55753) (#58283) 2020-06-18 11:54:23 -06:00
scripting.asciidoc [DOCS] Move 'Scripting' section to top-level navigation. (#42939) 2019-06-06 10:46:02 -04:00
search.asciidoc [7.x] EQL: Adds an ability to execute an asynchronous EQL search (#58192) 2020-06-25 14:11:57 -04:00
setup.asciidoc [DOCS] Relocate discovery module content (#56611) (#57454) 2020-06-01 14:13:13 -04:00
upgrade.asciidoc [DOCS] Update upgrade docs for 7.8 (#56281) 2020-05-06 11:47:39 -04:00