operator-only-snapshot-and-restore.asciidoc 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. [role="xpack"]
  2. [[operator-only-snapshot-and-restore]]
  3. === Operator privileges for snapshot and restore
  4. NOTE: {cloud-only}
  5. Invoking <<operator-only-apis,operator-only APIs>> or updating
  6. <<operator-only-dynamic-cluster-settings,operator-only dynamic cluster settings>>
  7. typically results in changes in the cluster state. The cluster state can be
  8. included in a cluster <<snapshot-restore,snapshot>>. Snapshots are a great way
  9. to preserve the data of a cluster, which can later be restored to bootstrap a
  10. new cluster, perform migration, or disaster recovery, for example. In a
  11. traditional self-managed environment, the intention is for the restore process
  12. to copy the entire cluster state over when requested. However, in a more
  13. managed environment, such as {ess-trial}[{ess}], data that is associated with
  14. <<operator-only-functionality,operator-only functionality>> is explicitly
  15. managed by the infrastructure code.
  16. Restoring snapshot data associated with
  17. operator-only functionality could be problematic
  18. because:
  19. 1. A snapshot could contain incorrect values for operator-only functionalities.
  20. For example, the snapshot could have been taken in a different cluster where
  21. requirements are different or the operator privileges feature is not enabled.
  22. Restoring data associated with operator-only functionality breaks the guarantee
  23. of operator privileges.
  24. 2. Even when the infrastructure code can correct the values immediately after
  25. a restore, there will always be a short period of time when the cluster could be
  26. in an inconsistent state.
  27. 3. The infrastructure code prefers to configure operator-only functionality from
  28. a single place, that is to say, through API calls.
  29. Therefore,
  30. <<configure-operator-privileges,*when the operator privileges feature is enabled*>>,
  31. snapshot data that is associated with any operator-only functionality is *not*
  32. restored.
  33. NOTE: That information is still included when taking a snapshot so that all data
  34. is always preserved.