Skip to content

Add User-Defined Cluster Metadata #33220

@AthenaEryma

Description

@AthenaEryma

It would be useful to have user-defined, cluster-wide metadata can be set and accessed by users, particularly users who run multiple clusters. Example use cases include:

  1. An organization with multiple clusters, each under a different administrator, could set "administrator": "joe@example.com" to quickly identify the owner of each cluster.
  2. An organization with different clusters for Testing and Production could set "environment": "test" in the Testing cluster and verify in a test runner that this property is correctly set before running tests against that cluster.

We will address this by allowing users to use the Cluster Settings API to set arbitrary key/value pairs with a specific key prefix. For example, if the key prefix is cluster.metadata, the example keys above would be cluster.metadata.administrator and cluster.metadata.environment.

These settings have no semantic meaning to them from Elasticsearch itself, and only serve to store information users wish to associate with their cluster.

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions