transform-settings.asciidoc 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  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. [discrete]
  16. [[general-transform-settings]]
  17. ==== General {transforms} settings
  18. `node.roles: [ transform ]`::
  19. Set to `node.roles` to contain `transform` to identify the node as a _transform
  20. node_. If you use the default settings for a node, it does not have the
  21. `transform` role.
  22. +
  23. If a node doesn't have this role, the node cannot run transforms. If you want to
  24. run transforms, there must be at least one transform node in your cluster.
  25. +
  26. If you use the `node.roles` setting, then all required roles must be explicitly
  27. set. Consult <<modules-node>> to learn more.
  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 non-fatal
  33. error. Once the number of retries is exhausted, the {transform} task is marked
  34. as `failed`. The default value is `10` with a valid minimum of `0` and maximum
  35. of `100`. If a {transform} is already running, it has to be restarted to use the
  36. changed setting.