transform-settings.asciidoc 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. [role="xpack"]
  2. [[transform-settings]]
  3. === {transforms-cap} settings in Elasticsearch
  4. [subs="attributes"]
  5. ++++
  6. <titleabbrev>{transforms-cap} settings</titleabbrev>
  7. ++++
  8. You do not need to configure any settings to use {transforms}. It is enabled by
  9. default.
  10. All of these settings can be added to the `elasticsearch.yml` configuration file.
  11. The dynamic settings can also be updated across a cluster with the
  12. <<cluster-update-settings,cluster update settings API>>.
  13. TIP: Dynamic settings take precedence over settings in the `elasticsearch.yml`
  14. file.
  15. [float]
  16. [[general-transform-settings]]
  17. ==== General {transforms} settings
  18. `node.transform`::
  19. deprecated:[7.9.0,"Use <<modules-node,node.roles>> instead."]
  20. Set to `true` to identify the node as a _transform node_. If `node.data`
  21. is `false` for the node, the default value is `false`. Otherwise, the default
  22. value is `true`.
  23. +
  24. If set to `false` in `elasticsearch.yml`, the node cannot run transforms. If
  25. you want to run transforms, there must be at least one transform node in your
  26. cluster. +
  27. +
  28. IMPORTANT: On dedicated coordinating nodes or dedicated master nodes, disable
  29. the node.transform role.
  30. `xpack.transform.enabled`::
  31. deprecated:[7.8.0,Basic License features should always be enabled] +
  32. This deprecated setting no longer has any effect.
  33. `xpack.transform.num_transform_failure_retries` (<<cluster-update-settings,Dynamic>>)::
  34. The number of times that a {transform} retries when it experiences a
  35. non-fatal error. Once the number of retries is exhausted, the {transform}
  36. task will be marked as `failed`. The default value is `10` with a valid minimum of `0`
  37. and maximum of `100`.
  38. If a {transform} is already running, it will have to be restarted
  39. to use the changed setting.