You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by km...@apache.org on 2018/05/02 17:43:40 UTC

[geode] branch develop updated: GEODE-4218 Document deprecating load-cluster-configuration-from-dir (#1899)

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 baedf79  GEODE-4218 Document deprecating load-cluster-configuration-from-dir (#1899)
baedf79 is described below

commit baedf7941c56fccb66aba231ff3c1a5e2ec86330
Author: Karen Miller <ka...@users.noreply.github.com>
AuthorDate: Wed May 2 10:43:36 2018 -0700

    GEODE-4218 Document deprecating load-cluster-configuration-from-dir (#1899)
    
    * GEODE-4218 Document deprecating load-cluster-configuration-from-dir
    for gfsh start locator. Use gfsh import cluster-configuration
    instead.
    
    * GEODE-4218 Revisions on cluster config per review
---
 .../source/subnavs/geode-subnav.erb                |  3 --
 .../configuring/chapter_overview.html.md.erb       |  4 ---
 .../gfsh_load_from_shared_dir.html.md.erb          | 40 ----------------------
 .../cluster_config/gfsh_persist.html.md.erb        |  7 ++--
 .../gfsh/command-pages/start.html.md.erb           |  2 +-
 5 files changed, 6 insertions(+), 50 deletions(-)

diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index 0ee2065..86c39ae 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -76,9 +76,6 @@ limitations under the License.
                         <a href="/docs/guide/<%=vars.product_version_nodot%>/configuring/cluster_config/gfsh_config_troubleshooting.html">Cluster Configuration Files and Troubleshooting</a>
                     </li>
                     <li>
-                        <a href="/docs/guide/<%=vars.product_version_nodot%>/configuring/cluster_config/gfsh_load_from_shared_dir.html">Loading Existing Configuration Files into Cluster Configuration</a>
-                    </li>
-                    <li>
                         <a href="/docs/guide/<%=vars.product_version_nodot%>/configuring/cluster_config/gfsh_remote.html">Using gfsh to Manage a Remote Cluster Over HTTP or HTTPS</a>
                     </li>
                     <li class="has_submenu">
diff --git a/geode-docs/configuring/chapter_overview.html.md.erb b/geode-docs/configuring/chapter_overview.html.md.erb
index 48f951f..9ab0271 100644
--- a/geode-docs/configuring/chapter_overview.html.md.erb
+++ b/geode-docs/configuring/chapter_overview.html.md.erb
@@ -50,10 +50,6 @@ You can also use `gfsh` to start and stop locators, servers, and <%=vars.product
 
     When you use the cluster configuration service in <%=vars.product_name%>, you can examine the generated configuration files in the `cluster_config` directory on the locator. `gfsh` saves configuration files at the cluster-level and at the individual group-level.
 
--   **[Loading Existing Configuration Files into Cluster Configuration](cluster_config/gfsh_load_from_shared_dir.html)**
-
-    To load an existing cache.xml or gemfire.properties configuration file into a new cluster, use the `--load-cluster-configuration-from-dir` parameter when starting up the locator.
-
 -   **[Using gfsh to Manage a Remote Cluster Over HTTP or HTTPS](cluster_config/gfsh_remote.html)**
 
     You can connect `gfsh` via HTTP or HTTPS to a remote cluster and manage the cluster using `gfsh` commands.
diff --git a/geode-docs/configuring/cluster_config/gfsh_load_from_shared_dir.html.md.erb b/geode-docs/configuring/cluster_config/gfsh_load_from_shared_dir.html.md.erb
deleted file mode 100644
index 3b5a9eb..0000000
--- a/geode-docs/configuring/cluster_config/gfsh_load_from_shared_dir.html.md.erb
+++ /dev/null
@@ -1,40 +0,0 @@
----
-title:  Loading Existing Configuration Files into Cluster Configuration
----
-
-<!--
-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.
--->
-
-To load an existing cache.xml or gemfire.properties configuration file into a new cluster, use the `--load-cluster-configuration-from-dir` parameter when starting up the locator.
-
-You can use this technique to migrate a single server's configuration into the cluster configuration service. To load an existing cache.xml file or cluster configuration into a cluster, perform the following steps:
-
-1.  Make sure the locator is not currently running.
-2.  Within the locator's working directory, create a `cluster_config/cluster` directory if the directory does not already exist.
-3.  Copy the desired configuration files (cache.xml or gemfire.properties, or both) into the `cluster_config/cluster` directory.
-4.  Rename the configuration files as follows:
-    -   Rename `cache.xml` to `cluster.xml`
-    -   Rename `gemfire.properties` to `cluster.properties`
-
-5.  Start the locator in `gfsh` as follows:
-
-    ``` pre
-    gfsh>start locator --name=<locator_name> --enable-cluster-configuration=true --load-cluster-configuration-from-dir=true
-    ```
-
-    After successful startup, the locator should report that the "Cluster configuration service is up and running." Any servers that join this cluster and have `--use-cluster-configuration` set to true will pick up these configuration files.
-
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 8411fff..b3a4284 100644
--- a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb
+++ b/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb
@@ -42,9 +42,12 @@ The standalone locators distribute configuration to all locators in a cluster. E
 **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.
 
-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.
+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.
 
-You can also load existing configuration files into the cluster configuration service by starting up a standalone locator with the parameter `--load-cluster-configuration-from-dir` set to true. See [Loading Existing Configuration Files into Cluster Configuration](gfsh_load_from_shared_dir.html).
+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
 
diff --git a/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb
index c656e8e..3520231 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb
@@ -382,7 +382,7 @@ See <a href="../../../configuring/cluster_config/gfsh_persist.html">Overview of
 </tr>
 <tr class="even">
 <td><span class="keyword parmname">\-\-load-cluster-configuration-from-dir</span></td>
-<td>Loads the cluster configuration from the <span class="ph filepath">shared-config</span> directory. (When set to false, the configuration is loaded from the disk store of the internal, persistent region used by the locator to persist the configuration.)</td>
+<td><b>Deprecated. Use <code>gfsh import cluster-configuration</code> for this functionality.</b> Loads the cluster configuration from the <span class="ph filepath">shared-config</span> directory. (When set to false, the configuration is loaded from the disk store of the internal, persistent region used by the locator to persist the configuration.)</td>
 <td>false</td>
 </tr>
 <tr class="odd">

-- 
To stop receiving notification emails like this one, please contact
kmiller@apache.org.