honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-25 06:16:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Document static dynamic transform settings (#61384)

Browse Source
This commit is contained in:
Lisa Cawley 2020-08-21 13:02:29 -07:00 committed by lcawl
parent cbb5f18f81
commit 7c48a0fc8c
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -12,33 +12,32 @@ 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
<<cluster-update-settings,cluster update settings API>>.
TIP: Dynamic settings take precedence over settings in the `elasticsearch.yml`
file.
<<cluster-update-settings,cluster update settings API>>. Dynamic settings take
precedence over settings in the `elasticsearch.yml` file.
[discrete]
[[general-transform-settings]]
==== General {transforms} settings
`node.roles: [ transform ]`::
Set to `node.roles` to contain `transform` to identify the node as a _transform
node_. If you use the default settings for a node, it does not have the
`transform` role.
(<<static-cluster-setting,Static>>) Set `node.roles` to contain `transform` to
identify the node as a _transform node_. If you use the default settings for a
node, it does not have the `transform` role.
+
If a node doesn't have this role, the node cannot run transforms. If you want to
run transforms, there must be at least one transform node in your cluster.
+
If you use the `node.roles` setting, then all required roles must be explicitly
set. Consult <<modules-node>> to learn more.
If you use the `node.roles` setting, all required roles must be explicitly set.
Consult <<modules-node>> to learn more.
`xpack.transform.enabled`::
deprecated:[7.8.0,Basic License features should always be enabled] +
This deprecated setting no longer has any effect.
deprecated:[7.8.0,Basic License features should always be enabled]
(<<static-cluster-setting,Static>>) This deprecated setting no longer has any
effect.
`xpack.transform.num_transform_failure_retries` (<<cluster-update-settings,Dynamic>>)::
The number of times that a {transform} retries when it experiences a non-fatal
error. Once the number of retries is exhausted, the {transform} task is marked
as `failed`. The default value is `10` with a valid minimum of `0` and maximum
of `100`. If a {transform} is already running, it has to be restarted to use the
changed setting.
`xpack.transform.num_transform_failure_retries`::
(<<cluster-update-settings,Dynamic>>) The number of times that a {transform}
retries when it experiences a non-fatal error. Once the number of retries is
exhausted, the {transform} task is marked as `failed`. The default value is `10`
with a valid minimum of `0` and maximum of `100`. If a {transform} is already
running, it has to be restarted to use the changed setting.