This is an automated email from the ASF dual-hosted git repository.
kmiller pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new 019345e GEODE-5071 Update docs of gfsh limitations and recommendations (#1978)
019345e is described below
commit 019345ea30c6276635096fd1ce10aab12925c803
Author: Karen Miller <ka...@users.noreply.github.com>
AuthorDate: Tue May 22 16:45:05 2018 -0700
GEODE-5071 Update docs of gfsh limitations and recommendations (#1978)
* GEODE-5071 Update docs of gfsh limitations and recommendations
* GEODE-5071 Revise wording per review
---
.../gfsh_config_troubleshooting.html.md.erb | 11 +++++----
.../cluster_config/gfsh_persist.html.md.erb | 27 +++++++++-------------
2 files changed, 18 insertions(+), 20 deletions(-)
diff --git a/geode-docs/configuring/cluster_config/gfsh_config_troubleshooting.html.md.erb b/geode-docs/configuring/cluster_config/gfsh_config_troubleshooting.html.md.erb
index ecc7e14..5201aa5 100644
--- a/geode-docs/configuring/cluster_config/gfsh_config_troubleshooting.html.md.erb
+++ b/geode-docs/configuring/cluster_config/gfsh_config_troubleshooting.html.md.erb
@@ -43,10 +43,6 @@ When you specify the `--groups` parameter in a `gfsh` command, (for example, `st
You can export a zip file that contains all artifacts of a cluster configuration. The zip file contains all of the files in the `cluster_config` (or otherwise specified) subdirectory of a locator. You can import this configuration to a new cluster. See [Exporting and Importing Cluster Configurations](export-import.html#concept_wft_dkq_34).
-## Individual Configuration Files and Cluster Configuration Files
-
-<%=vars.product_name%> applies the cluster-wide configuration files first and then group-level configurations next. If a member has its own configuration files defined (cache.xml and gemfire.properties files), those configurations are applied last. Whenever possible, use the member group-level configuration files in the cluster configuration service to apply non-cluster-wide configurations on individual members.
-
## Troubleshooting Tips
- When you start a locator using `gfsh`, you should see the following message:
@@ -59,6 +55,13 @@ You can export a zip file that contains all artifacts of a cluster configuration
- If the command returns RUNNING, the cluster configuration is running normally.
- If the command returns WAITING, run the `status locator` command. The output of this command returns the cause of the WAITING status.
+- When using a `cache.xml` file for configuration,
+there is a specific order to the application of the configuration
+in these files.
+<%=vars.product_name%> applies the cluster-wide configuration files first.
+Group-level configurations follow.
+Last will be the configuration in a member's own configuration files
+(`cache.xml` and `gemfire.properties` files).
- If a server start fails with the following exception: `ClusterConfigurationNotAvailableException`, the cluster configuration service may not be in the RUNNING state. Because the server requests the cluster configuration from the locator, which is not available, the `start server` command fails.
- You can determine what configurations a server received from a locator by examining the server's log file. See [Logging](../../managing/logging/logging.html#concept_30DB86B12B454E168B80BB5A71268865).
- If a `start server` command specifies a cache.xml file that conflicts with the existing cluster configuration, the server startup may fail.
diff --git a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb b/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb
index b3a4284..b41a07d 100644
--- a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb
+++ b/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb
@@ -23,7 +23,12 @@ The <%=vars.product_name_long%> cluster configuration service persists cluster c
## 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 distributed system configuration. 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 cach [...]
+We highly recommend that you use the `gfsh` command line
+and the cluster configuration service as the primary mechanism
+to manage your distributed system 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:
@@ -73,25 +78,21 @@ The following `gfsh` commands cause the configuration to be written to all locat
- `create async-event-queue`
- `deploy jar`
- `undeploy jar`
-
-**\*** 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.
-
-The following gateway-related commands use the cluster configuration service, and their configuration is saved by locators:
-
- `create gateway-sender`
- `create gateway-receiver`
+**\*** 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
-There are some configurations that you cannot create using `gfsh`, and that you must configure using cache.xml or the API:
+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`
- `custom-load-probe`
- - `cache-listener`
- - `cache-loader`
- - `cache-writer`
- `compressor`
- `serializer`
- `instantiator`
@@ -100,9 +101,7 @@ There are some configurations that you cannot create using `gfsh`, and that you
**Note:**
The `configure pdx` command always specifies the `org.apache.geode.pdx.ReflectionBasedAutoSerializer` class. You cannot specify a custom PDX serializer in gfsh.
- - `custom-expiry`
- `initializer`
- - `declarable`
- `lru-heap-percentage`
- `lru-memory-size`
- `partition-resolver`
@@ -110,11 +109,7 @@ There are some configurations that you cannot create using `gfsh`, and that you
- `transaction-listener`
- `transaction-writer`
- Adding or removing a `TransactionListener`
-- Adding JNDI bindings
- Deleting an `AsyncEventQueue`
-
-In addition, there are some limitations on configuring gateways using `gfsh`. You must use cache.xml or the Java APIs to configure the following:
-
- Configuring a `GatewayConflictResolver`
- You cannot specify parameters and values for Java classes for the following:
- `gateway-listener`
--
To stop receiving notification emails like this one, please contact
kmiller@apache.org.