Cluster Management Service
Note: This feature is experimental and is subject to change in future releases of Apache Geode.
The cluster management service enables you to change the configuration of the cluster (for example, create/destroy regions, indexes, or gateway receivers/senders), and have these changes replicated on all the applicable servers and persisted in the cluster configuration service.
With the cluster management service, you can:
Create regions/indexes on the fly.
Persist the configuration and apply it to the cluster, so when a new node joins, it has the configuration, and when the server restarts, it has the configuration.
Obtain a consistent view of the current configuration
Apply a change to all elements of the cluster in the same way
Be able to change the configuration in one place
Obtain this configuration without being on the cluster
Invoke the configuration service from the server or from a client
The cluster management service is documented in the Geode Wiki: Cluster Management Service. The Wiki write-up offers separate choices for the cluster management service implementation on each Geode version that supports it.
The cluster management service REST API adheres to standard REST semantics, so users can use POST, PATCH, DELETE, and GET to create, update, delete, and read, respectively.
This version of Geode uses the 1.12.0 Management REST API. As mentioned, the feature is experimental and still undergoing revision.
For a definitive description of the cluster management service for your version of Geode, you can use the Swagger™ framework. To use the Swagger UI to browse the cluster management service API:
gfsh, start a locator using the default settings.
- Open a browser and enter the following URL:
This produces a browsable description of the cluster management service API:
The cluster management service is available to Java clients via a Java API. To enable the cluster management service Java API, include
geode-management.jar in your client classpath.
See the Cluster Management Service Java Client topic on the Geode Wiki for more details.