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/08/31 22:33:44 UTC
[geode] branch develop updated: GEODE-5204 Document new options for
gfsh import and export (#2413)
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 acd3f3d GEODE-5204 Document new options for gfsh import and export (#2413)
acd3f3d is described below
commit acd3f3def41c48dd58305872578f73322d3d3e99
Author: Karen Miller <ka...@users.noreply.github.com>
AuthorDate: Fri Aug 31 15:33:39 2018 -0700
GEODE-5204 Document new options for gfsh import and export (#2413)
* GEODE-5204 Document new options for gfsh import and export
- new options are --action, --group, and --xml-file
* Update export.html.md.erb
* GEODE-5204 Document new gfsh import/export options
- add that APPLY is the default action
---
.../tools_modules/gfsh/command-pages/export.html.md.erb | 15 +++++++++++----
.../tools_modules/gfsh/command-pages/import.html.md.erb | 11 ++++++++---
2 files changed, 19 insertions(+), 7 deletions(-)
diff --git a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
index ae00334..65c8423 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb
@@ -25,7 +25,7 @@ Export configurations, data, logs and stack-traces.
- **[export cluster-configuration](#topic_mdv_jgz_ck)**
- Export a cluster configuration zip file that contains the `cache.xml` files, `gemfire.properties` files, and application jar files needed to configure and operate a cluster.
+ Export a cluster configuration ZIP file that contains the `cache.xml` files, `gemfire.properties` files, and application JAR files needed to configure and operate a cluster.
- **[export config](#topic_C7C69306F93743459E65D46537F4A1EE)**
@@ -49,7 +49,10 @@ Export configurations, data, logs and stack-traces.
## <a id="topic_mdv_jgz_ck" class="no-quick-link"></a>export cluster-configuration
-Exports a cluster configuration zip file that contains the `cache.xml` files, `gemfire.properties` files, and application jar files needed to configure and operate a cluster.
+Exports a single XML file or a ZIP file with cluster configuration that contains the `cache.xml` files, `gemfire.properties` files, and application JAR files needed to configure and operate a cluster.
+
+When neither a file name nor a ZIP file name is specified,
+the cluster configuration is written to standard output.
**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command.
@@ -58,14 +61,17 @@ See [Overview of the Cluster Configuration Service](../../../configuring/cluster
**Syntax:**
``` pre
-export cluster-configuration --zip-file-name=value
+export cluster-configuration [--group(=value)?] [--xml-file=value]
+ [--zip-file-name=value]
```
**Export Cluster-Configuration Parameters:**
| Name | Description | Default Value |
|-------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------|
-| <span class="keyword parmname">\\-\\-zip-file-name</span> | *Required.* Filename of the zip file to contain the exported cluster configuration. May also include an absolute or relative path. | |
+| <span class="keyword parmname">‑‑group</span> | Export the configuration for the specified server group. When no group is specified, use the default `cluster` group. | |
+| <span class="keyword parmname">‑‑xml-file</span> | Filename to contain the exported cluster configuration. May also include an absolute or relative path. Only specify one of `--xml-file` or `--zip-file-name`. | |
+| <span class="keyword parmname">‑‑zip-file-name</span> | Filename of the ZIP file to contain the exported cluster configuration. May also include an absolute or relative path. Only specify one of `--xml-file` or `--zip-file-name`.| |
**Example Commands:**
@@ -73,6 +79,7 @@ export cluster-configuration --zip-file-name=value
gfsh>export cluster-configuration --zip-file-name=/group/shared-configs/devClusterConfig.zip
gfsh>export cluster-configuration --zip-file-name=my-configs/myClusterConfig.zip
gfsh>export cluster-configuration --zip-file-name=myClusterConfig.zip
+gfsh>export cluster-configuration --xml-file=Cluster3Config.xml
```
**Sample Output:**
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 45e3bda..f90c6c3 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
@@ -33,7 +33,7 @@ You can import an exported cluster configuration to create a new cluster or impo
## <a id="topic_vnv_grz_ck" class="no-quick-link"></a>import cluster-configuration
-Imports a previously exported cluster configuration from a zip file. This command is useful when spinning up a new cluster.
+Imports a previously exported cluster configuration from a ZIP file or an XML file. This command is useful when spinning up a new cluster.
- In a given cluster, only one locator needs to perform the import.
That locator shares the imported configuration with all other connected locators in the cluster.
@@ -47,19 +47,24 @@ To import a cluster configuration, start one or more locators and then run the `
**Syntax:**
``` pre
-import cluster-configuration --zip-file-name=value
+import cluster-configuration [--action=value] [--group(=value)?]
+ [--xml-file=value] [--zip-file-name=value]
```
**Import Cluster-Configuration Parameters:**
| Name | Description |
|-------------------------------------------------------|-------------------------------------------------------------------------------------------------|
-| <span class="keyword parmname">\\-\\-zip-file-name</span> | *Required.* Name of the zip file containing the cluster configuration artifacts to be imported. |
+| <span class="keyword parmname">‑‑action</span> | When the value is `APPLY` (the default), the configuration is applied to the running servers that have no configuration. If any servers already have configuration, the command fails. When the value is `STAGE`, the configuration is overwritten and will be used during future server creation; the configuration of currently running servers is not changed. | |
+| <span class="keyword parmname">‑‑group</span> | Do the import for the specified server group. When no group is specified, the `cluster` is implied. | |
+| <span class="keyword parmname">‑‑xml-file</span> | Filename from which to import the cluster configuration. May also include an absolute or relative path. Only specify one of `--xml-file` or `--zip-file-name`. | |
+| <span class="keyword parmname">\\-\\-zip-file-name</span> | Name of the ZIP file containing the cluster configuration artifacts to be imported. Only specify one of `--xml-file` or `--zip-file-name`. | |
**Example Commands:**
``` pre
gfsh>import cluster-configuration --zip-file-name=/home/username/myClusterConfig.zip
+gfsh>import cluster-configuration --xml-file=configs/Cluster3Config.xml
```
**Sample Output:**