You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by nn...@apache.org on 2021/07/09 16:35:01 UTC
[geode] branch support/1.14 updated: GEODE-9410: User Guide -
resolve inconsistencies in gfsh import cluster-configuration command
description (#6669)
This is an automated email from the ASF dual-hosted git repository.
nnag pushed a commit to branch support/1.14
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/support/1.14 by this push:
new 9948cfe GEODE-9410: User Guide - resolve inconsistencies in gfsh import cluster-configuration command description (#6669)
9948cfe is described below
commit 9948cfe2bdd973fc73dd8d3d9da347f5628427dd
Author: Dave Barnes <db...@apache.org>
AuthorDate: Thu Jul 1 13:08:48 2021 -0700
GEODE-9410: User Guide - resolve inconsistencies in gfsh import cluster-configuration command description (#6669)
(cherry picked from commit 9c55efe4619b207c83646193b37f5cbe9f1c5877)
---
.../configuring/cluster_config/export-import.html.md.erb | 9 +++++----
geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb | 10 ++++------
.../tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb | 2 +-
3 files changed, 10 insertions(+), 11 deletions(-)
diff --git a/geode-docs/configuring/cluster_config/export-import.html.md.erb b/geode-docs/configuring/cluster_config/export-import.html.md.erb
index 54c1384..c286b08 100644
--- a/geode-docs/configuring/cluster_config/export-import.html.md.erb
+++ b/geode-docs/configuring/cluster_config/export-import.html.md.erb
@@ -21,12 +21,12 @@ limitations under the License.
The cluster configuration service exports and imports configurations created using `gfsh` for an entire <%=vars.product_name_long%> cluster.
-The cluster configuration service saves the cluster configuration as you create regions, disk-stores and other objects using `gfsh` commands. You can export this configuration as well as any jar files that contain application files to a zip file and then import this configuration to create a new cluster.
+The cluster configuration service saves the cluster configuration as you create regions, disk-stores and other objects using `gfsh` commands. You can export this configuration as well as any jar files that contain application files to a ZIP archive and then import this configuration to create a new cluster.
## Exporting a Cluster Configuration
Issue the `gfsh` `export cluster-configuration` command to save the configuration data for your
-cluster in a zip file. This zip file contains subdirectories for cluster-level configurations and a
+cluster in a ZIP archive. This ZIP file contains subdirectories for cluster-level configurations and a
directory for each group specified in the cluster. The contents of these directories are described
in [Cluster Configuration Files and Troubleshooting](gfsh_config_troubleshooting.html#concept_ylt_2cb_y4).
@@ -44,7 +44,8 @@ See [export cluster-configuration](../../tools_modules/gfsh/command-pages/export
## Importing a Cluster Configuration
Use the `gfsh` `import cluster-configuration` command to configure a new cluster based on a configuration exported from another system.
-You can import a cluster configuration only into a new cluster, that is, when:
+You can import a cluster configuration only into a new cluster, or into a running cluster that has not yet been configured and contains no defined regions.
+That is, when:
- There are no running cache servers
@@ -63,5 +64,5 @@ To import a cluster configuration, start one or more locators and then run the `
import cluster-configuration --zip-file-name=/home/username/configs/myClusterConfig.zip
```
-See [import cluster-configuration](../../tools_modules/gfsh/command-pages/import.html#topic_vnv_grz_ck).
+See [import cluster-configuration](../../tools_modules/gfsh/command-pages/import.html#import-cluster-config).
diff --git a/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
index f90c6c3..005b0c6 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/import.html.md.erb
@@ -18,20 +18,18 @@ 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.
-->
-<a id="topic_u55_wkd_2l"></a>
-
You can import an exported cluster configuration to create a new cluster or import data into a region.
-- **[import cluster-configuration](#topic_vnv_grz_ck)**
+- **[import cluster-configuration](#import-cluster-config)**
Import a cluster configuration.
-- **[import data](#topic_jw2_2ld_2l)**
+- **[import data](#import-data)**
Import user data from a file to a region.
-## <a id="topic_vnv_grz_ck" class="no-quick-link"></a>import cluster-configuration
+## <a id="import-cluster-config" class="no-quick-link"></a>import cluster-configuration
Imports a previously exported cluster configuration from a ZIP file or an XML file. This command is useful when spinning up a new cluster.
@@ -74,7 +72,7 @@ gfsh>import cluster-configuration --zip-file-name=/home/username/myClusterConfig
Cluster configuration successfully imported
```
-## <a id="topic_jw2_2ld_2l" class="no-quick-link"></a>import data
+## <a id="import-data" class="no-quick-link"></a>import data
Import user data from a file or files to a region.
diff --git a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
index d48a632..46c99cf 100644
--- a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
@@ -87,7 +87,7 @@ limitations under the License.
<td>online</td>
</tr>
<tr>
-<td><a href="command-pages/import.html#topic_vnv_grz_ck">import cluster-configuration</a></td>
+<td><a href="command-pages/import.html#import-cluster-config">import cluster-configuration</a></td>
<td>Import an exported configuration.</td>
<td>online</td>
</tr>