setup.asciidoc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. [role="xpack"]
  2. [[transform-setup]]
  3. === Set up {transforms}
  4. ++++
  5. <titleabbrev>Setup</titleabbrev>
  6. ++++
  7. To use the {transforms}, you must have the
  8. {subscriptions}[appropriate license] and at least one
  9. <<transform-setup-nodes,{transform} node>> in your {es} cluster. If {stack}
  10. {security-features} are enabled, you must also ensure your users have the
  11. <<transform-privileges,necessary privileges>>.
  12. [discrete]
  13. [[transform-setup-nodes]]
  14. ==== {transform-cap} nodes
  15. To use {transforms}, there must be at least one node in your cluster with
  16. `node.transform` set to `true`. By default, all nodes are {transform} nodes
  17. unless you explicitly change these settings or set `node.data` to `false`.
  18. If you want to control which nodes run {transforms}, set `node.transform` to
  19. `false` on some nodes.
  20. For more information, see <<transform-settings>> and <<modules-node>>.
  21. [discrete]
  22. [[transform-privileges]]
  23. ==== Security privileges
  24. The {es} {security-features} provide <<built-in-roles,built-in roles>>
  25. and <<security-privileges,privileges>> that make it easier to control
  26. which users can manage or view {transforms}.
  27. To _view_ the configuration and status of {transforms}, you must have:
  28. * `transform_user` built-in role or `monitor_transform`
  29. cluster privileges
  30. To _manage_ {transforms}, you must have:
  31. * `transform_admin` built-in role or `manage_transform`
  32. cluster privileges
  33. * `read` and `view_index_metadata` index privileges on source indices
  34. * `read`, `create_index`, and `index` index privileges on destination indices
  35. For more information, see <<security-privileges>> and <<built-in-roles>>.