data-frames-settings.asciidoc 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. [role="xpack"]
  2. [[data-frames-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-data-frames-settings]]
  16. ==== General {transforms} settings
  17. `xpack.transform.enabled`::
  18. Set to `true` (default) to enable {transforms} on the node. +
  19. +
  20. If set to `false` in `elasticsearch.yml`, the {transform} APIs are disabled on the node.
  21. Therefore the node cannot start or administrate {transform} or receive transport (internal)
  22. communication requests related to {transform} APIs.
  23. +
  24. IMPORTANT: If you want to use {transform} features in your cluster, you must have
  25. `xpack.transform.enabled` set to `true` on all master-eligible nodes. This is the
  26. default behavior.
  27. `xpack.transform.num_transform_failure_retries` (<<cluster-update-settings,Dynamic>>)::
  28. The number of times that a {transform} retries when it experiences a
  29. non-fatal error. Once the number of retries is exhausted, the {transform}
  30. task will be marked as `failed`. The default value is `10` with a valid minimum of `0`
  31. and maximum of `100`.
  32. If a {transform} is already running, it will have to be restarted
  33. to use the changed setting.