transform-settings.asciidoc 1.6 KB

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