<commit_before>---
title:  Overview of the Cluster Configuration Service
---

<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

The <%=vars.product_name_long%> cluster configuration service persists cluster configurations created by `gfsh` commands to the locators in a cluster and distributes the configurations to members of the cluster.

## Why Use the Cluster Configuration Service

We highly recommend that you use the `gfsh` command line 
and the cluster configuration service as the primary mechanism
to manage your cluster configuration.
Specify configuration within a `cache.xml` file for only those
items that cannot be specified or altered using `gfsh`.
Using a common cluster configuration reduces the amount of time you spend configuring individual members and enforces consistent configurations when bringing up new members in your cluster. You no longer need to reconfigure each new member that you add to the cluster. You no longer need to worry about validating your `cache.xml` file. It also becomes easier to propagate configuration changes across your cluster and deploy your configuration changes to different environments.

You can use the cluster configuration service to:

-   Save the configuration for an entire <%=vars.product_name_long%> cluster.
-   Restart members using a previously-saved configuration.
-   Export a configuration from a development environment and migrate that configuration to create a testing or production system.
-   Start additional servers without having to configure each server separately.
-   Configure some servers to host certain regions and other servers to host different regions, and configure all servers to host a set of common regions.

## Using the Cluster Configuration Service

To use the cluster configuration service in <%=vars.product_name%>, you must use dedicated, standalone locators in your deployment. You cannot use the cluster configuration service with co-located locators (locators running in another process such as a server) or in multicast environments.

The standalone locators distribute configuration to all locators in a cluster. Every locator in the cluster with `--enable-cluster-configuration` set to true keeps a record of all cluster-level and group-level configuration settings.

**Note:**
The default behavior for `gfsh` is to create and save cluster configurations. You can disable the cluster configuration service by using the `--enable-cluster-configuration=false` option when starting locators.

You can load existing configuration into
the cluster by using the
[`gfsh import cluster-configuration`](../../tools_modules/gfsh/command-pages/import.html#topic_vnv_grz_ck)
command after starting up a locator.

Subsequently, any servers that you start with `gfsh` that have `--use-cluster-configuration` set to `true` will pick up the cluster configuration from the locator as well as any appropriate group-level configurations (for member groups they belong to). To disable the cluster configuration service on a server, you must start the server with the `--use-cluster-configuration` parameter set to `false`. By default, the parameter is set to true.

## How the Cluster Configuration Service Works

When you use `gfsh` commands to create <%=vars.product_name_long%> regions, disk-stores, and other objects, the cluster configuration service saves the configurations on each locator in the cluster. If you specify a group when issuing these commands, a separate configuration is saved containing only configurations that apply to the group.

When you use `gfsh` to start new <%=vars.product_name_long%> servers, the locator distributes the persisted configurations to the new server. If you specify a group when starting the server, the server receives the group-level configuration in addition to the cluster-level configuration. Group-level configurations are applied after cluster-wide configurations; therefore you can use group-level to override cluster-level settings.

<img src="../../images_svg/cluster_config_overview.svg" id="concept_r22_hyw_bl__image_jjc_vhb_y4" class="image" />

## gfsh Commands that Create Cluster Configurations

The following `gfsh` commands cause the configuration to be written to all locators in the cluster (the locators write the configuration to disk):

-   `configure pdx`\*
-   `create region`
-   `alter region`
-   `alter runtime`
-   `destroy region`
-   `create index`
-   `destroy index`
-   `create disk-store`
-   `destroy disk-store`
-   `create async-event-queue`
-   `alter async-event-queue`
-   `destroy async-event-queue`
-   `deploy jar`
-   `undeploy jar`
-   `create gateway-sender`
-   `destroy gateway-sender`
-   `create gateway-receiver`
-   `destroy gateway-receiver`
-   `alter query-service`

**\*** Note that the `configure pdx` command must be executed *before* starting your data members. This command does not affect any currently running members in the system. Data members (with cluster configuration enabled) that are started after running this command will pick up the new PDX configuration.

## <a id="concept_r22_hyw_bl__section_bn3_23p_y4" class="no-quick-link"></a>gfsh Limitations

These are the configurations that you cannot create or alter using `gfsh`.
These configurations must be within a `cache.xml` file or be applied
by using the API:

-   Client cache configuration
-   You cannot directly modify the attributes of the following objects:
    -   `function`<commit_msg>GEODE-8237: Add note about 'alter region' & cluster conf service (#5231)<commit_after>---
title:  Overview of the Cluster Configuration Service
---

<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

The <%=vars.product_name_long%> cluster configuration service persists cluster configurations created by `gfsh` commands to the locators in a cluster and distributes the configurations to members of the cluster.

## Why Use the Cluster Configuration Service

We highly recommend that you use the `gfsh` command line 
and the cluster configuration service as the primary mechanism
to manage your cluster configuration.
Specify configuration within a `cache.xml` file for only those
items that cannot be specified or altered using `gfsh`.
Using a common cluster configuration reduces the amount of time you spend configuring individual members and enforces consistent configurations when bringing up new members in your cluster. You no longer need to reconfigure each new member that you add to the cluster. You no longer need to worry about validating your `cache.xml` file. It also becomes easier to propagate configuration changes across your cluster and deploy your configuration changes to different environments.

You can use the cluster configuration service to:

-   Save the configuration for an entire <%=vars.product_name_long%> cluster.
-   Restart members using a previously-saved configuration.
-   Export a configuration from a development environment and migrate that configuration to create a testing or production system.
-   Start additional servers without having to configure each server separately.
-   Configure some servers to host certain regions and other servers to host different regions, and configure all servers to host a set of common regions.

## Using the Cluster Configuration Service

To use the cluster configuration service in <%=vars.product_name%>, you must use dedicated, standalone locators in your deployment. You cannot use the cluster configuration service with co-located locators (locators running in another process such as a server) or in multicast environments.

The standalone locators distribute configuration to all locators in a cluster. Every locator in the cluster with `--enable-cluster-configuration` set to true keeps a record of all cluster-level and group-level configuration settings.

**Note:**
The default behavior for `gfsh` is to create and save cluster configurations. You can disable the cluster configuration service by using the `--enable-cluster-configuration=false` option when starting locators.

You can load existing configuration into
the cluster by using the
[`gfsh import cluster-configuration`](../../tools_modules/gfsh/command-pages/import.html#topic_vnv_grz_ck)
command after starting up a locator.

Subsequently, any servers that you start with `gfsh` that have `--use-cluster-configuration` set to `true` will pick up the cluster configuration from the locator as well as any appropriate group-level configurations (for member groups they belong to). To disable the cluster configuration service on a server, you must start the server with the `--use-cluster-configuration` parameter set to `false`. By default, the parameter is set to true.

## How the Cluster Configuration Service Works

When you use `gfsh` commands to create <%=vars.product_name_long%> regions, disk-stores, and other objects, the cluster configuration service saves the configurations on each locator in the cluster. If you specify a group when issuing these commands, a separate configuration is saved containing only configurations that apply to the group.

When you use `gfsh` to start new <%=vars.product_name_long%> servers, the locator distributes the persisted configurations to the new server. If you specify a group when starting the server, the server receives the group-level configuration in addition to the cluster-level configuration. Group-level configurations are applied after cluster-wide configurations; therefore you can use group-level to override cluster-level settings.

<img src="../../images_svg/cluster_config_overview.svg" id="concept_r22_hyw_bl__image_jjc_vhb_y4" class="image" />

## gfsh Commands that Create Cluster Configurations

The following `gfsh` commands cause the configuration to be written to all locators in the cluster (the locators write the configuration to disk):

-   `configure pdx`\*
-   `create region`
-   `alter region`\*\*
-   `alter runtime`
-   `destroy region`
-   `create index`
-   `destroy index`
-   `create disk-store`
-   `destroy disk-store`
-   `create async-event-queue`
-   `alter async-event-queue`
-   `destroy async-event-queue`
-   `deploy jar`
-   `undeploy jar`
-   `create gateway-sender`
-   `destroy gateway-sender`
-   `create gateway-receiver`
-   `destroy gateway-receiver`
-   `alter query-service`

**\*** Note that the `configure pdx` command must be executed *before* starting your data members. This command does not affect any currently running members in the system. Data members (with cluster configuration enabled) that are started after running this command will pick up the new PDX configuration.

**\*\*** If cluster configuration is enabled, the region this command is applied to must exist in the cluster configuration. If that is not the case, the command will fail saying the region does not exist.

## <a id="concept_r22_hyw_bl__section_bn3_23p_y4" class="no-quick-link"></a>gfsh Limitations

These are the configurations that you cannot create or alter using `gfsh`.
These configurations must be within a `cache.xml` file or be applied
by using the API:

-   Client cache configuration
-   You cannot directly modify the attributes of the following objects:
    -   `function`
{'fraction_non_alphanumeric': 0.05867427846495401, 'fraction_numerical': 0.0026958452267681573, 'mean_word_length': 4.656053811659193, 'pattern_counts': {'":': 0, '<': 21, '<?xml version=': 0, '>': 21, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 6}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1888809', 'n_tokens_mistral': 3044, 'n_tokens_neox': 2913, 'n_words': 1656}