transform-settings.asciidoc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  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. [discrete]
  11. [[general-transform-settings]]
  12. ==== General {transforms} settings
  13. `node.roles: [ transform ]`::
  14. (<<static-cluster-setting,Static>>) Set `node.roles` to contain `transform` to
  15. identify the node as a _transform node_. If you want to run {transforms}, there
  16. must be at least one {transform} node in your cluster.
  17. +
  18. If you set `node.roles`, you must explicitly specify all the required roles for
  19. the node. To learn more, refer to <<modules-node>>.
  20. +
  21. IMPORTANT: It is strongly recommended that dedicated {transform} nodes also have
  22. the `remote_cluster_client` role; otherwise, {ccs} fails when used in
  23. {transforms}. See <<remote-node>>.
  24. `xpack.transform.enabled`::
  25. deprecated:[7.8.0,Basic License features should always be enabled]
  26. (<<static-cluster-setting,Static>>) This deprecated setting no longer has any
  27. effect.
  28. `xpack.transform.num_transform_failure_retries`::
  29. (<<cluster-update-settings,Dynamic>>) The number of times that a {transform}
  30. retries when it experiences a non-fatal error. Once the number of retries is
  31. exhausted, the {transform} task is marked as `failed`. The default value is `10`
  32. with a valid minimum of `0` and maximum of `100`. If a {transform} is already
  33. running, it has to be restarted to use the changed setting.
  34. The `num_failure_retries` setting can also be specified on an individual {transform} level.
  35. Specifying this setting for each {transform} individually is recommended.