honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Clarifies transform node settings (#59023) (#59192)

This commit is contained in:
Lisa Cawley 2020-07-07 13:54:54 -07:00 committed by GitHub
parent d4a0f80c32
commit 2e71db71b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/reference/modules/node.asciidoc
View File

@ -15,7 +15,7 @@ All nodes know about all the other nodes in the cluster and can forward client
requests to the appropriate node.
By default, a node is all of the following types: master-eligible, data, ingest,
and (if available) machine learning and transform.
and (if available) machine learning. All data nodes are also transform nodes.
// end::modules-node-description-tag[]
TIP: As the cluster grows and in particular if you have large {ml} jobs or
{ctransforms}, consider separating dedicated master-eligible nodes from
@ -259,12 +259,9 @@ xpack.ml.enabled: true <1>
[[transform-node]]
==== [xpack]#{transform-cap} node#
{transform-cap} nodes run {transforms} and handle {transform} API requests.
If you want to use {transforms} in clients (including {kib}), it must also be
enabled on all coordinating nodes. You must also have at least one node with the
`transform` role. This is the default behavior. If you have the {oss-dist}, do
not use these settings. For more information, see <<transform-settings>>.
{transform-cap} nodes run {transforms} and handle {transform} API requests. By
default, data nodes are also transform nodes. If you have the {oss-dist}, do not
use these settings. For more information, see <<transform-settings>>.
To create a dedicated {transform} node in the {default-dist}, set:

4
docs/reference/settings/transform-settings.asciidoc
View File

@ -7,7 +7,8 @@
<titleabbrev>{transforms-cap} settings</titleabbrev>
++++
You do not need to configure any settings to use {transforms}. It is enabled by default.
You do not need to configure any settings to use {transforms}. It is enabled by
default.
All of these settings can be added to the `elasticsearch.yml` configuration file.
The dynamic settings can also be updated across a cluster with the
@ -21,6 +22,7 @@ file.
==== General {transforms} settings
`node.transform`::
deprecated:[7.9.0,"Use <<modules-node,node.roles>> instead."]
Set to `true` to identify the node as a _transform node_. If `node.data`
is `false` for the node, the default value is `false`. Otherwise, the default
value is `true`.

12
docs/reference/transform/setup.asciidoc
View File

@ -15,14 +15,10 @@ To use the {transforms}, you must have the
[[transform-setup-nodes]]
==== {transform-cap} nodes
To use {transforms}, there must be at least one node in your cluster with
`node.transform` set to `true`. By default, all nodes are {transform} nodes
unless you explicitly change these settings or set `node.data` to `false`.
If you want to control which nodes run {transforms}, set `node.transform` to
`false` on some nodes.
For more information, see <<transform-settings>> and <<modules-node>>.
To use {transforms}, there must be at least one {transform} node in your cluster.
If you want to control which nodes run {transforms}, add or remove `transform`
from the `node.roles` setting on some nodes. For more information, see
<<modules-node>> and <<transform-settings>>.
[discrete]
[[transform-privileges]]