setup.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  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 {transform} node in your cluster.
  16. If you want to control which nodes run {transforms}, add or remove `transform`
  17. from the `node.roles` setting on some nodes. For more information, see
  18. <<modules-node>> and <<transform-settings>>.
  19. [discrete]
  20. [[transform-privileges]]
  21. == Security privileges
  22. The {es} {security-features} provide <<built-in-roles,built-in roles>>
  23. and <<security-privileges,privileges>> that make it easier to control
  24. which users can manage or view {transforms}.
  25. To _view_ the configuration and status of {transforms}, you must have:
  26. * `transform_user` built-in role or `monitor_transform`
  27. cluster privileges
  28. To _manage_ {transforms}, you must have:
  29. * `transform_admin` built-in role or `manage_transform`
  30. cluster privileges
  31. * `read` and `view_index_metadata` index privileges on source indices
  32. * `read`, `create_index`, and `index` index privileges on destination indices
  33. For more information, see <<security-privileges>> and <<built-in-roles>>.