Skip to main content

Storing SAF Configurations in Cluster State

Cluster State allows access to configurations even under heavy system load.

Enabling the Setting​

To enable this feature, set the core.use_cluster_state setting to true within Cluster Settings.

Example:

PUT _cluster/settings
{
  "persistent": {
    "core.use_cluster_state": true
  }
}

Permissions​

User and module configurations operate under the classic permissions model. Configuration settings require cluster permissions.

Read
  • "Read" grants access to requests for a specific identifier.
  • "Read All" grants access to requests for all configurations.

By default, read operations are available to all users.

Permission Names​

Read​

cluster:admin/sm/clusterstate/settings/read

Read All​

cluster:admin/sm/clusterstate/settings/read_all

Create​

cluster:admin/sm/clusterstate/settings/create

Update​

cluster:admin/sm/clusterstate/settings/update

Delete​

cluster:admin/sm/clusterstate/settings/delete

Migration​

Migration allows transferring configurations between indices and Cluster State.

Overwriting

During migration, configurations with matching identifiers are overwritten.

The destination parameter determines the migration target and can have two values:

  • cluster_state (default) - from index to Cluster State
  • index - from Cluster State to index

If the parameter is set to index, you can additionally specify the name of the index to which the migration will be performed using the destination_index parameter (defaults to one of the system indices). Example:

POST _core/metadata/migrate/modules?destination=index&destination_index=test_modules
Permissions

To migrate to Cluster State, you must have the following cluster permission:

cluster:admin/sm/clusterstate/load

To migrate to an index, you must have write permission to that index.

Settings Migration​

POST _core/metadata/migrate/settings

User Migration​

POST _core/metadata/migrate/persons

Module Migration​

POST _core/metadata/migrate/modules