Repository: geode Updated Branches: refs/heads/develop 0daf9549a -> 92db0a6ac
GEODE-3395 Variable-ize product version and name in user guide - Cluster config Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/92db0a6a Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/92db0a6a Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/92db0a6a Branch: refs/heads/develop Commit: 92db0a6ac622c25924a7e615c6a9923593f716d4 Parents: 0daf954 Author: Dave Barnes <[email protected]> Authored: Thu Aug 24 11:25:49 2017 -0700 Committer: Dave Barnes <[email protected]> Committed: Thu Aug 24 11:25:49 2017 -0700 ---------------------------------------------------------------------- .../configuring/chapter_overview.html.md.erb | 56 ++++++++++---------- .../deploying_application_jars.html.md.erb | 10 ++-- .../cluster_config/export-import.html.md.erb | 4 +- .../gfsh_config_troubleshooting.html.md.erb | 12 ++--- .../cluster_config/gfsh_persist.html.md.erb | 10 ++-- .../cluster_config/gfsh_remote.html.md.erb | 4 +- .../persisting_configurations.html.md.erb | 42 +++++++-------- .../using_member_groups.html.md.erb | 4 +- .../running/change_file_spec.html.md.erb | 2 +- .../running/default_file_specs.html.md.erb | 2 +- .../deploy_config_files_intro.html.md.erb | 6 +-- .../running/deploying_config_files.html.md.erb | 12 ++--- .../deploying_config_jar_files.html.md.erb | 4 +- .../running/firewall_ports_config.html.md.erb | 4 +- .../running/firewalls_connections.html.md.erb | 6 +-- .../running/firewalls_ports.html.md.erb | 14 ++--- .../running/managing_output_files.html.md.erb | 4 +- .../running/running_the_cacheserver.html.md.erb | 24 ++++----- .../running/running_the_locator.html.md.erb | 12 ++--- .../starting_up_shutting_down.html.md.erb | 16 +++--- 20 files changed, 121 insertions(+), 127 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/chapter_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/chapter_overview.html.md.erb b/geode-docs/configuring/chapter_overview.html.md.erb index f4a48e8..48f951f 100644 --- a/geode-docs/configuring/chapter_overview.html.md.erb +++ b/geode-docs/configuring/chapter_overview.html.md.erb @@ -19,66 +19,66 @@ See the License for the specific language governing permissions and limitations under the License. --> -Use the `gfsh` command-line utility to configure your Apache Geode cluster (also called a "distributed system"). The cluster configuration service persists the cluster configurations and distributes the configurations to members of the cluster. There are also several additional ways to configure a cluster. +Use the `gfsh` command-line utility to configure your <%=vars.product_name_long%> cluster (also called a "distributed system"). The cluster configuration service persists the cluster configurations and distributes the configurations to members of the cluster. There are also several additional ways to configure a cluster. -Use `gfsh` to configure regions, disk stores, members, and other Geode objects. -You can also use `gfsh` to start and stop locators, servers, and Geode monitoring tools. As you execute these commands, the cluster configuration service persists the configuration. When new members join the cluster, the service distributes the configuration to the new members. +Use `gfsh` to configure regions, disk stores, members, and other <%=vars.product_name%> objects. +You can also use `gfsh` to start and stop locators, servers, and <%=vars.product_name%> monitoring tools. As you execute these commands, the cluster configuration service persists the configuration. When new members join the cluster, the service distributes the configuration to the new members. -`gfsh` is the recommended means of configuring and managing your Apache Geode cluster, however you can still configure many aspects of a cluster using the older methods of the cache.xml and gemfire.properties files. See [cache.xml](../reference/topics/chapter_overview_cache_xml.html#cache_xml) and the [Reference](../reference/book_intro.html#reference) for configuration parameters. You can also configure some aspects of a cluster using a Java API. See [Managing Apache Geode](../managing/book_intro.html#managing_gemfire_intro). +`gfsh` is the recommended means of configuring and managing your <%=vars.product_name_long%> cluster, however you can still configure many aspects of a cluster using the older methods of the cache.xml and gemfire.properties files. See [cache.xml](../reference/topics/chapter_overview_cache_xml.html#cache_xml) and the [Reference](../reference/book_intro.html#reference) for configuration parameters. You can also configure some aspects of a cluster using a Java API. See [Managing <%=vars.product_name_long%>](../managing/book_intro.html#managing_gemfire_intro). -- **[Overview of the Cluster Configuration Service](../configuring/cluster_config/gfsh_persist.html)** +- **[Overview of the Cluster Configuration Service](cluster_config/gfsh_persist.html)** - The Apache Geode 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. + 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. -- **[TutorialâCreating and Using a Cluster Configuration](../configuring/cluster_config/persisting_configurations.html)** +- **[TutorialâCreating and Using a Cluster Configuration](cluster_config/persisting_configurations.html)** - A short walk-through that uses a single computer to demonstrate how to use `gfsh` to create a cluster configuration for a Geode cluster. + A short walk-through that uses a single computer to demonstrate how to use `gfsh` to create a cluster configuration for a <%=vars.product_name%> cluster. -- **[Deploying Application JARs to Apache Geode Members](../configuring/cluster_config/deploying_application_jars.html)** +- **[Deploying Application JARs to <%=vars.product_name_long%> Members](cluster_config/deploying_application_jars.html)** - You can dynamically deploy your application JAR files to specific members or to all members in your distributed system. Geode automatically keeps track of JAR file versions; autoloads the deployed JAR files to the CLASSPATH; and auto-registers any functions that the JAR contains. + You can dynamically deploy your application JAR files to specific members or to all members in your distributed system. <%=vars.product_name%> automatically keeps track of JAR file versions; autoloads the deployed JAR files to the CLASSPATH; and auto-registers any functions that the JAR contains. -- **[Using Member Groups](../configuring/cluster_config/using_member_groups.html)** +- **[Using Member Groups](cluster_config/using_member_groups.html)** - Apache Geode allows you to organize your distributed system members into logical member groups. + <%=vars.product_name_long%> allows you to organize your distributed system members into logical member groups. -- **[Exporting and Importing Cluster Configurations](../configuring/cluster_config/export-import.html)** +- **[Exporting and Importing Cluster Configurations](cluster_config/export-import.html)** - The cluster configuration service exports and imports configurations created using `gfsh` for an entire Apache Geode cluster. + The cluster configuration service exports and imports configurations created using `gfsh` for an entire <%=vars.product_name_long%> cluster. -- **[Cluster Configuration Files and Troubleshooting](../configuring/cluster_config/gfsh_config_troubleshooting.html)** +- **[Cluster Configuration Files and Troubleshooting](cluster_config/gfsh_config_troubleshooting.html)** - When you use the cluster configuration service in Geode, 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. + 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](../configuring/cluster_config/gfsh_load_from_shared_dir.html)** +- **[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](../configuring/cluster_config/gfsh_remote.html)** +- **[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. -- **[Deploying Configuration Files without the Cluster Configuration Service](../configuring/running/deploying_config_files.html)** +- **[Deploying Configuration Files without the Cluster Configuration Service](running/deploying_config_files.html)** - You can deploy your Apache Geode configuration files in your system directory structure or in jar files. You determine how you want to deploy your configuration files and set them up accordingly. + You can deploy your <%=vars.product_name_long%> configuration files in your system directory structure or in jar files. You determine how you want to deploy your configuration files and set them up accordingly. -- **[Starting Up and Shutting Down Your System](../configuring/running/starting_up_shutting_down.html)** +- **[Starting Up and Shutting Down Your System](running/starting_up_shutting_down.html)** Determine the proper startup and shutdown procedures, and write your startup and shutdown scripts. -- **[Running Geode Locator Processes](../configuring/running/running_the_locator.html)** +- **[Running <%=vars.product_name%> Locator Processes](running/running_the_locator.html)** - The locator is a Geode process that tells new, connecting members where running members are located and provides load balancing for server use. + The locator is a <%=vars.product_name%> process that tells new, connecting members where running members are located and provides load balancing for server use. -- **[Running Geode Server Processes](../configuring/running/running_the_cacheserver.html)** +- **[Running <%=vars.product_name%> Server Processes](running/running_the_cacheserver.html)** - A Geode server is a process that runs as a long-lived, configurable member of a client/server system. + A <%=vars.product_name%> server is a process that runs as a long-lived, configurable member of a client/server system. -- **[Managing System Output Files](../configuring/running/managing_output_files.html)** +- **[Managing System Output Files](running/managing_output_files.html)** - Geode output files are optional and can become quite large. Work with your system administrator to determine where to place them to avoid interfering with other system activities. + <%=vars.product_name%> output files are optional and can become quite large. Work with your system administrator to determine where to place them to avoid interfering with other system activities. -- **[Firewall Considerations](../configuring/running/firewall_ports_config.html)** +- **[Firewall Considerations](running/firewall_ports_config.html)** You can configure and limit port usage for situations that involve firewalls, for example, between client-server or server-server connections. http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/cluster_config/deploying_application_jars.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/cluster_config/deploying_application_jars.html.md.erb b/geode-docs/configuring/cluster_config/deploying_application_jars.html.md.erb index e63fbac..185b1e1 100644 --- a/geode-docs/configuring/cluster_config/deploying_application_jars.html.md.erb +++ b/geode-docs/configuring/cluster_config/deploying_application_jars.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Deploying Application JARs to Apache Geode Members ---- +<% set_title("Deploying Application JARs to", product_name_long, "Members") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,9 +17,9 @@ See the License for the specific language governing permissions and limitations under the License. --> -You can dynamically deploy your application JAR files to specific members or to all members in your distributed system. Geode automatically keeps track of JAR file versions; autoloads the deployed JAR files to the CLASSPATH; and auto-registers any functions that the JAR contains. +You can dynamically deploy your application JAR files to specific members or to all members in your distributed system. <%=vars.product_name%> automatically keeps track of JAR file versions; autoloads the deployed JAR files to the CLASSPATH; and auto-registers any functions that the JAR contains. -To deploy and undeploy application JAR files in Apache Geode, use the `gfsh` `deploy` or `undeploy` command. You can deploy a single JAR or multiple JARs (by either specifying the JAR filenames or by specifying a directory that contains the JAR files), and you can also target the deployment to a member group or multiple member group. For example, after connecting to the distributed system where you want to deploy the JARs, you could type at the `gfsh` prompt: +To deploy and undeploy application JAR files in <%=vars.product_name_long%>, use the `gfsh` `deploy` or `undeploy` command. You can deploy a single JAR or multiple JARs (by either specifying the JAR filenames or by specifying a directory that contains the JAR files), and you can also target the deployment to a member group or multiple member group. For example, after connecting to the distributed system where you want to deploy the JARs, you could type at the `gfsh` prompt: ``` pre gfsh> deploy --jar=group1_functions.jar @@ -91,7 +89,7 @@ For more information on `gfsh` usage, see [gfsh](../../tools_modules/gfsh/chapte ## <a id="concept_4436C021FB934EC4A330D27BD026602C__section_D36E345C6E254D27B0F4B0C8711F5E6A" class="no-quick-link"></a>Deployment Location for JAR Files -The system location where JAR files are written on each member is determined by the `deploy-working-dir` Geode property configured for that member. For example, you could have the following configured in the `gemfire.properties` file for your member: +The system location where JAR files are written on each member is determined by the `deploy-working-dir` <%=vars.product_name%> property configured for that member. For example, you could have the following configured in the `gemfire.properties` file for your member: ``` pre #gemfire.properties http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/cluster_config/export-import.html.md.erb ---------------------------------------------------------------------- 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 32dab1e..8f3b1f8 100644 --- a/geode-docs/configuring/cluster_config/export-import.html.md.erb +++ b/geode-docs/configuring/cluster_config/export-import.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -The cluster configuration service exports and imports configurations created using `gfsh` for an entire Apache Geode cluster. +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 a 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. @@ -27,7 +27,7 @@ The cluster configuration service saves the cluster configuration as you create 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 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). -To export a cluster configuration, run the `gfsh` `export cluster-configuration` command while connected to a Geode cluster. For example: +To export a cluster configuration, run the `gfsh` `export cluster-configuration` command while connected to a <%=vars.product_name%> cluster. For example: ``` pre export cluster-configuration --zip-file-name=myClusterConfig.zip --dir=/home/username/configs http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/cluster_config/gfsh_config_troubleshooting.html.md.erb ---------------------------------------------------------------------- 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 99a4932..c02c222 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 @@ -19,15 +19,15 @@ See the License for the specific language governing permissions and limitations under the License. --> -When you use the cluster configuration service in Geode, 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. +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. The following directories and configuration files are available on the locator running the cluster configuration service: **Cluster-level configuration** For configurations that apply to all members of a cluster, the locator creates a `cluster` subdirectory within the `cluster_config` directory (or in the cluster configuration directory when starting up the locator with the `--cluster-config-dir=value` parameter) specified. All servers receive this configuration when they are started using `gfsh`. This directory contains: -- `cluster.xml` -- A Geode `cache.xml` file containing configuration common to all members -- `cluster.properties` -- a Geode ` gemfire.properties` file containing properties common to all members +- `cluster.xml` -- A <%=vars.product_name%> `cache.xml` file containing configuration common to all members +- `cluster.properties` -- a <%=vars.product_name%> ` gemfire.properties` file containing properties common to all members - Jar files that are intended for deployment to all members <!-- --> @@ -35,8 +35,8 @@ For configurations that apply to all members of a cluster, the locator creates a **Group-level configuration** When you specify the `--group` parameter in a `gfsh` command, (for example, `start server` or `create region`) the locator writes the configurations for each group in a subdirectory with the same name as the group. When you start a server that specifies one or more group names, the server receives both the cluster-level configurations and the configurations from all groups specified. This subdirectory contains: -- `<group-name>.xml` -- A Geode `cache.xml` file containing configurations common to all members of the group -- `<group-name>.properties` -- A Geode `gemfire.properties` file containing properties common to all members of the group +- `<group-name>.xml` -- A <%=vars.product_name%> `cache.xml` file containing configurations common to all members of the group +- `<group-name>.properties` -- A <%=vars.product_name%> `gemfire.properties` file containing properties common to all members of the group - Jar files that are intended for deployment to all members of the group <img src="../../images_svg/cluster-group-config.svg" id="concept_ylt_2cb_y4__image_bs1_mcb_y4" class="image" /> @@ -45,7 +45,7 @@ You can export a zip file that contains all artifacts of a cluster configuration ## Individual Configuration Files and Cluster Configuration Files -Geode 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. +<%=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 http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb ---------------------------------------------------------------------- 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 0169baf..a4fa973 100644 --- a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb +++ b/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -The Apache Geode 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. +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 @@ -27,7 +27,7 @@ We highly recommend that you use the `gfsh` command line and the cluster configu You can use the cluster configuration service to: -- Save the configuration for an entire Apache Geode cluster. +- 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. @@ -35,7 +35,7 @@ You can use the cluster configuration service to: ## Using the Cluster Configuration Service -To use the cluster configuration service in Geode, 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. +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. @@ -48,9 +48,9 @@ You can also load existing configuration files into the cluster configuration se ## How the Cluster Configuration Service Works -When you use `gfsh` commands to create Apache Geode regions, disk-stores, and other objects, the cluster configuration service saves the configurations on each locator in the cluster (also called a Geode distributed system). 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` 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 (also called a <%=vars.product_name%> distributed system). 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 Apache Geode 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. +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" /> http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb b/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb index 6adb6e7..51472a2 100644 --- a/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb +++ b/geode-docs/configuring/cluster_config/gfsh_remote.html.md.erb @@ -24,7 +24,7 @@ You can connect `gfsh` via HTTP or HTTPS to a remote cluster and manage the clus To connect `gfsh` using the HTTP protocol to a remote cluster: 1. Launch `gfsh`. See [Starting gfsh](../../tools_modules/gfsh/starting_gfsh.html#concept_DB959734350B488BBFF91A120890FE61). -2. When starting the remote cluster on the remote host, you can optionally specify `--http-bind-address` and `--http-service-port` as Geode properties when starting up your JMX manager (server or locator). These properties can be then used in the URL used when connecting from your local system to the HTTP service in the remote cluster. For example: +2. When starting the remote cluster on the remote host, you can optionally specify `--http-bind-address` and `--http-service-port` as <%=vars.product_name%> properties when starting up your JMX manager (server or locator). These properties can be then used in the URL used when connecting from your local system to the HTTP service in the remote cluster. For example: ``` pre gfsh>start server --name=server1 --J=-Dgemfire.jmx-manager=true \ @@ -39,7 +39,7 @@ To connect `gfsh` using the HTTP protocol to a remote cluster: ``` pre gfsh>connect --use-http=true --url="http://myremotecluster.example.com:8080/geode/v1"; - Successfully connected to: Geode Manager's HTTP service @ http://myremotecluster.example.com:8080/geode/v1 + Successfully connected to: <%=vars.product_name%> Manager's HTTP service @ http://myremotecluster.example.com:8080/geode/v1 ``` See [connect](../../tools_modules/gfsh/command-pages/connect.html). http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/cluster_config/persisting_configurations.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/cluster_config/persisting_configurations.html.md.erb b/geode-docs/configuring/cluster_config/persisting_configurations.html.md.erb index 4556192..c6fa0cc 100644 --- a/geode-docs/configuring/cluster_config/persisting_configurations.html.md.erb +++ b/geode-docs/configuring/cluster_config/persisting_configurations.html.md.erb @@ -19,11 +19,11 @@ See the License for the specific language governing permissions and limitations under the License. --> -A short walk-through that uses a single computer to demonstrate how to use `gfsh` to create a cluster configuration for a Geode cluster. +A short walk-through that uses a single computer to demonstrate how to use `gfsh` to create a cluster configuration for a <%=vars.product_name%> cluster. -The `gfsh` command-line tool allows you to configure and start a Geode cluster. The cluster configuration service uses Apache Geode locators to store the configuration at the group and cluster levels and serves these configurations to new members as they are started. The locators store the configurations in a hidden region that is available to all locators and also write the configuration data to disk as XML files. Configuration data is updated as `gfsh` commands are executed. +The `gfsh` command-line tool allows you to configure and start a <%=vars.product_name%> cluster. The cluster configuration service uses <%=vars.product_name_long%> locators to store the configuration at the group and cluster levels and serves these configurations to new members as they are started. The locators store the configurations in a hidden region that is available to all locators and also write the configuration data to disk as XML files. Configuration data is updated as `gfsh` commands are executed. -This section provides a walk-through example of configuring a simple Apache Geode cluster and then re-using that configuration in a new context. +This section provides a walk-through example of configuring a simple <%=vars.product_name_long%> cluster and then re-using that configuration in a new context. 1. Create a working directory (For example:`/home/username/my_geode`) and switch to the new directory. This directory will contain the configurations for your cluster. @@ -40,9 +40,9 @@ This section provides a walk-through example of configuring a simple Apache Geod / _____/ ______/ ______/ /____/ / / / __/ /___ /_____ / _____ / / /__/ / ____/ _____/ / / / / - /______/_/ /______/_/ /_/ 1.0.0 + /______/_/ /______/_/ /_/ <%=vars.product_version%> - Monitor and Manage Apache Geode + Monitor and Manage <%=vars.product_name_long%> gfsh> ``` @@ -51,13 +51,13 @@ This section provides a walk-through example of configuring a simple Apache Geod ``` pre gfsh>start locator --name=locator1 - Starting a Geode Locator in /Users/username/my_geode/locator1... + Starting a <%=vars.product_name%> Locator in /Users/username/my_geode/locator1... ............................. Locator in /Users/username/my_geode/locator1 on 192.0.2.0[10334] as locator1 is currently online. Process ID: 5203 Uptime: 15 seconds - Geode Version: 1.0.0 + <%=vars.product_name%> Version: <%=vars.product_version%> Java Version: 1.8.0_101 Log File: /Users/username/my_geode/locator1/locator1.log JVM Arguments: -Dgemfire.enable-cluster-configuration=true @@ -73,17 +73,17 @@ This section provides a walk-through example of configuring a simple Apache Geod Note that `gfsh` responds with a message indicating that the cluster configuration service is up and running. If you see a message indicating a problem, review the locator log file for possible errors. The path to the log file is displayed in the output from `gfsh`. -4. Start Apache Geode servers using the commands in the following example: +4. Start <%=vars.product_name_long%> servers using the commands in the following example: ``` pre gfsh>start server --name=server1 --group=group1 - Starting a Geode Server in /Users/username/my_geode/server1... + Starting a <%=vars.product_name%> Server in /Users/username/my_geode/server1... ..... Server in /Users/username/my_geode/server1 on 192.0.2.0[40404] as server1 is currently online. Process ID: 5627 Uptime: 2 seconds - Geode Version: 1.0.0 + <%=vars.product_name%> Version: <%=vars.product_version%> Java Version: 1.8.0_101 Log File: /Users/username/my_geode/server1/server1.log JVM Arguments: -Dgemfire.default.locators=192.0.2.0[10334] -Dgemfire.groups=group1 @@ -93,13 +93,13 @@ This section provides a walk-through example of configuring a simple Apache Geod Class-Path: /Users/username/Apache_Geode_1.0.0_Linux/lib/geode-dependencies.jar gfsh>start server --name=server2 --group=group1 --server-port=40405 - Starting a Geode Server in /Users/username/my_geode/server2... + Starting a <%=vars.product_name%> Server in /Users/username/my_geode/server2... ..... Server in /Users/username/my_geode/server2 on 192.0.2.0[40405] as server2 is currently online. Process ID: 5634 Uptime: 2 seconds - Geode Version: 1.0.0 + <%=vars.product_name%> Version: <%=vars.product_version%> Java Version: 1.8.0_101 Log File: /Users/username/my_geode/server2/server2.log JVM Arguments: -Dgemfire.default.locators=192.0.2.0[10334] -Dgemfire.groups=group1 @@ -109,13 +109,13 @@ This section provides a walk-through example of configuring a simple Apache Geod Class-Path: /Users/username/Apache_Geode_1.0.0_Linux/lib/geode-dependencies.jar gfsh>start server --name=server3 --server-port=40406 - Starting a Geode Server in /Users/username/my_geode/server3... + Starting a <%=vars.product_name%> Server in /Users/username/my_geode/server3... ..... Server in /Users/username/my_geode/server3 on 192.0.2.0[40406] as server3 is currently online. Process ID: 5637 Uptime: 2 seconds - Geode Version: 1.0.0 + <%=vars.product_name%> Version: <%=vars.product_version%> Java Version: 1.8.0_101 Log File: /Users/username/my_geode/server3/server3.log JVM Arguments: -Dgemfire.default.locators=192.0.2.0[10334] @@ -174,7 +174,7 @@ This section provides a walk-through example of configuring a simple Apache Geod gfsh>export cluster-configuration --zip-file-name=myClConfig.zip --dir=/Users/username ``` - Apache Geode writes the cluster configuration to the specified zip file. + <%=vars.product_name_long%> writes the cluster configuration to the specified zip file. ``` pre Downloading cluster configuration : /Users/username/myClConfig.zip @@ -213,13 +213,13 @@ This section provides a walk-through example of configuring a simple Apache Geod ``` pre gfsh>start locator --name=locator2 --port=10335 - Starting a Geode Locator in /Users/username/new_geode/locator2... + Starting a <%=vars.product_name%> Locator in /Users/username/new_geode/locator2... ............................. Locator in /Users/username/new_geode/locator2 on 192.0.2.0[10335] as locator2 is currently online. Process ID: 5749 Uptime: 15 seconds - Geode Version: 1.0.0 + <%=vars.product_name%> Version: <%=vars.product_version%> Java Version: 1.8.0_101 Log File: /Users/username/new_geode/locator2/locator2.log JVM Arguments: -Dgemfire.enable-cluster-configuration=true @@ -246,13 +246,13 @@ This section provides a walk-through example of configuring a simple Apache Geod ``` pre gfsh>start server --name=server4 --server-port=40414 - Starting a Geode Server in /Users/username/new_geode/server4... + Starting a <%=vars.product_name%> Server in /Users/username/new_geode/server4... ........ Server in /Users/username/new_geode/server4 on 192.0.2.0[40414] as server4 is currently online. Process ID: 5813 Uptime: 4 seconds - Geode Version: 1.0.0 + <%=vars.product_name%> Version: <%=vars.product_version%> Java Version: 1.8.0_101 Log File: /Users/username/new_geode/server4/server4.log JVM Arguments: -Dgemfire.default.locators=192.0.2.0[10335] @@ -266,13 +266,13 @@ This section provides a walk-through example of configuring a simple Apache Geod ``` pre gfsh>start server --name=server5 --group=group1 --server-port=40415 - Starting a Geode Server in /Users/username/new_geode/server5... + Starting a <%=vars.product_name%> Server in /Users/username/new_geode/server5... ..... Server in /Users/username/new_geode/server2 on 192.0.2.0[40415] as server5 is currently online. Process ID: 5954 Uptime: 2 seconds - Geode Version: 1.0.0 + <%=vars.product_name%> Version: <%=vars.product_version%> Java Version: 1.8.0_101 Log File: /Users/username/new_geode/server5/server5.log JVM Arguments: -Dgemfire.default.locators=192.0.2.0[10335] -Dgemfire.groups=group1 http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/cluster_config/using_member_groups.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/cluster_config/using_member_groups.html.md.erb b/geode-docs/configuring/cluster_config/using_member_groups.html.md.erb index 250ef9f..8bf7a4c 100644 --- a/geode-docs/configuring/cluster_config/using_member_groups.html.md.erb +++ b/geode-docs/configuring/cluster_config/using_member_groups.html.md.erb @@ -19,9 +19,9 @@ See the License for the specific language governing permissions and limitations under the License. --> -Apache Geode allows you to organize your distributed system members into logical member groups. +<%=vars.product_name_long%> allows you to organize your distributed system members into logical member groups. -The use of member groups in Apache Geode is optional. The benefit of using member groups is the ability to coordinate certain operations on members based on logical group membership. For example, by defining and using member groups you can: +The use of member groups in <%=vars.product_name_long%> is optional. The benefit of using member groups is the ability to coordinate certain operations on members based on logical group membership. For example, by defining and using member groups you can: - Alter a subset of configuration properties for a specific member or members. See [alter runtime](../../tools_modules/gfsh/command-pages/alter.html#topic_7E6B7E1B972D4F418CB45354D1089C2B) in `gfsh`. - Perform certain disk operations like disk-store compaction across a member group. See [Disk Store Commands](../../tools_modules/gfsh/quick_ref_commands_by_area.html#topic_1ACC91B493EE446E89EC7DBFBBAE00EA) for a list of commands. http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/change_file_spec.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/change_file_spec.html.md.erb b/geode-docs/configuring/running/change_file_spec.html.md.erb index cb195bb..9a0e3d4 100644 --- a/geode-docs/configuring/running/change_file_spec.html.md.erb +++ b/geode-docs/configuring/running/change_file_spec.html.md.erb @@ -22,7 +22,7 @@ limitations under the License. You can change all file specifications in the `gemfire.properties` file and at the command line. **Note:** -Geode applications can use the API to pass `java.lang.System properties` to the distributed system connection. This changes file specifications made at the command line and in the `gemfire.properties`. You can verify an applicationâs property settings in the configuration information logged at application startup. The configuration is listed when the `gemfire.properties` `log-level` is set to `config` or lower. +<%=vars.product_name%> applications can use the API to pass `java.lang.System properties` to the distributed system connection. This changes file specifications made at the command line and in the `gemfire.properties`. You can verify an applicationâs property settings in the configuration information logged at application startup. The configuration is listed when the `gemfire.properties` `log-level` is set to `config` or lower. This invocation of the application, `testApplication.TestApp1`, provides non-default specifications for both the `cache.xml` and `gemfire.properties`: http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/default_file_specs.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/default_file_specs.html.md.erb b/geode-docs/configuring/running/default_file_specs.html.md.erb index 041992f..de264bc 100644 --- a/geode-docs/configuring/running/default_file_specs.html.md.erb +++ b/geode-docs/configuring/running/default_file_specs.html.md.erb @@ -67,7 +67,7 @@ Examples of valid `gemfirePropertyFile` specifications: - `myGF.properties` - `test1/gfprops` -For the `test1/gfprops` specification, if you launch your Geode system member from `/testDir` in a Unix file system, Geode looks for the file in this order until it finds the file or exhausts all locations: +For the `test1/gfprops` specification, if you launch your <%=vars.product_name%> system member from `/testDir` in a Unix file system, <%=vars.product_name%> looks for the file in this order until it finds the file or exhausts all locations: 1. `/testDir/test1/gfprops` 2. `<yourHomeDir>/test1/gfprops` http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/deploy_config_files_intro.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/deploy_config_files_intro.html.md.erb b/geode-docs/configuring/running/deploy_config_files_intro.html.md.erb index f44d60e..e073ed8 100644 --- a/geode-docs/configuring/running/deploy_config_files_intro.html.md.erb +++ b/geode-docs/configuring/running/deploy_config_files_intro.html.md.erb @@ -25,12 +25,12 @@ These are the basic steps for deploying configuration files, with related detail 2. Place the files in your directories or jar files. 3. For any file with a non-default name or location, provide the file specification in the system properties file and/or in the member `CLASSPATH.` -## <a id="concept_337B365782E44951B73F33E1E17AB07B__section_53C98F9DB1584E3BABFA315CDF254A92" class="no-quick-link"></a>Geode Configuration Files +## <a id="concept_337B365782E44951B73F33E1E17AB07B__section_53C98F9DB1584E3BABFA315CDF254A92" class="no-quick-link"></a><%=vars.product_name%> Configuration Files - `gemfire.properties`. Contains the settings required by members of a distributed system. These settings include licensing, system member discovery, communication parameters, logging, and statistics. -See the [Geode Properties Reference](../../reference/topics/gemfire_properties.html). +See the [<%=vars.product_name%> Properties Reference](../../reference/topics/gemfire_properties.html). - **`gfsecurity.properties`**. An optional separate file that contains security-related (`security-*`) settings that are otherwise defined in `gemfire.properties`. Placing these member properties into a separate file allows you to restrict user access to those specific settings. -See the [Geode Properties Reference](../../reference/topics/gemfire_properties.html). +See the [<%=vars.product_name%> Properties Reference](../../reference/topics/gemfire_properties.html). - `cache.xml`. Declarative cache configuration file. This file contains XML declarations for cache, region, and region entry configuration. You also use it to configure disk stores, database login credentials, server and remote site location information, and socket information. See [cache.xml](../../reference/topics/chapter_overview_cache_xml.html#cache_xml). http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/deploying_config_files.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/deploying_config_files.html.md.erb b/geode-docs/configuring/running/deploying_config_files.html.md.erb index 63d9ac9..e19badf 100644 --- a/geode-docs/configuring/running/deploying_config_files.html.md.erb +++ b/geode-docs/configuring/running/deploying_config_files.html.md.erb @@ -19,26 +19,26 @@ See the License for the specific language governing permissions and limitations under the License. --> -You can deploy your Apache Geode configuration files in your system directory structure or in jar files. You determine how you want to deploy your configuration files and set them up accordingly. +You can deploy your <%=vars.product_name_long%> configuration files in your system directory structure or in jar files. You determine how you want to deploy your configuration files and set them up accordingly. **Note:** -If you use the cluster configuration service to create and manage your Apache Geode cluster configuration, the procedures described in this section are not needed because Geode automatically manages the distribution of the configuration files and jar files to members of the cluster. See [Overview of the Cluster Configuration Service](../cluster_config/gfsh_persist.html). +If you use the cluster configuration service to create and manage your <%=vars.product_name_long%> cluster configuration, the procedures described in this section are not needed because <%=vars.product_name%> automatically manages the distribution of the configuration files and jar files to members of the cluster. See [Overview of the Cluster Configuration Service](../cluster_config/gfsh_persist.html). You can use the procedures described in this section to distribute configurations that are member-specific, or for situations where you do not want to use the cluster configuration service. -- **[Main Steps to Deploying Configuration Files](../../configuring/running/deploy_config_files_intro.html)** +- **[Main Steps to Deploying Configuration Files](deploy_config_files_intro.html)** These are the basic steps for deploying configuration files, with related detail in sections that follow. -- **[Default File Specifications and Search Locations](../../configuring/running/default_file_specs.html)** +- **[Default File Specifications and Search Locations](default_file_specs.html)** Each file has a default name, a set of file search locations, and a system property you can use to override the defaults. -- **[Changing the File Specifications](../../configuring/running/change_file_spec.html)** +- **[Changing the File Specifications](change_file_spec.html)** You can change all file specifications in the `gemfire.properties` file and at the command line. -- **[Deploying Configuration Files in JAR Files](../../configuring/running/deploying_config_jar_files.html)** +- **[Deploying Configuration Files in JAR Files](deploying_config_jar_files.html)** This section provides a procedure and an example for deploying configuration files in JAR files. http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/deploying_config_jar_files.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/deploying_config_jar_files.html.md.erb b/geode-docs/configuring/running/deploying_config_jar_files.html.md.erb index 8c6cc20..23a9201 100644 --- a/geode-docs/configuring/running/deploying_config_jar_files.html.md.erb +++ b/geode-docs/configuring/running/deploying_config_jar_files.html.md.erb @@ -24,9 +24,9 @@ This section provides a procedure and an example for deploying configuration fil **Procedure** 1. Jar the files. -2. Set the Apache Geode system properties to point to the files as they reside in the jar file. +2. Set the <%=vars.product_name_long%> system properties to point to the files as they reside in the jar file. 3. Include the jar file in your `CLASSPATH.` -4. Verify the jar file copies are the only ones visible to the application at runtime. Geode searches the `CLASSPATH` after searching other locations, so the files cannot be available in the other search areas. +4. Verify the jar file copies are the only ones visible to the application at runtime. <%=vars.product_name%> searches the `CLASSPATH` after searching other locations, so the files cannot be available in the other search areas. 5. Start your application. The configuration file is loaded from the jar file. **Example of Deploying a Configuration JAR** http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/firewall_ports_config.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/firewall_ports_config.html.md.erb b/geode-docs/configuring/running/firewall_ports_config.html.md.erb index 4a5d4c7..76c6156 100644 --- a/geode-docs/configuring/running/firewall_ports_config.html.md.erb +++ b/geode-docs/configuring/running/firewall_ports_config.html.md.erb @@ -21,11 +21,11 @@ limitations under the License. You can configure and limit port usage for situations that involve firewalls, for example, between client-server or server-server connections. -- **[Firewalls and Connections](../../configuring/running/firewalls_connections.html)** +- **[Firewalls and Connections](firewalls_connections.html)** Be aware of possible connection problems that can result from running a firewall on your machine. -- **[Firewalls and Ports](../../configuring/running/firewalls_ports.html)** +- **[Firewalls and Ports](firewalls_ports.html)** Make sure your port settings are configured correctly for firewalls. http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/firewalls_connections.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/firewalls_connections.html.md.erb b/geode-docs/configuring/running/firewalls_connections.html.md.erb index 9f61bc0..8a94396 100644 --- a/geode-docs/configuring/running/firewalls_connections.html.md.erb +++ b/geode-docs/configuring/running/firewalls_connections.html.md.erb @@ -21,11 +21,11 @@ limitations under the License. Be aware of possible connection problems that can result from running a firewall on your machine. -Apache Geode is a network-centric distributed system, so if you have a firewall running on your machine it could cause connection problems. For example, your connections may fail if your firewall places restrictions on inbound or outbound permissions for Java-based sockets. You may need to modify your firewall configuration to permit traffic to Java applications running on your machine. The specific configuration depends on the firewall you are using. +<%=vars.product_name_long%> is a network-centric distributed system, so if you have a firewall running on your machine it could cause connection problems. For example, your connections may fail if your firewall places restrictions on inbound or outbound permissions for Java-based sockets. You may need to modify your firewall configuration to permit traffic to Java applications running on your machine. The specific configuration depends on the firewall you are using. -As one example, firewalls may close connections to Geode due to timeout settings. If a firewall senses no activity in a certain time period, it may close a connection and open a new connection when activity resumes, which can cause some confusion about which connections you have. +As one example, firewalls may close connections to <%=vars.product_name%> due to timeout settings. If a firewall senses no activity in a certain time period, it may close a connection and open a new connection when activity resumes, which can cause some confusion about which connections you have. -For more information on how Geode client and servers connect, see the following topics: +For more information on how <%=vars.product_name%> client and servers connect, see the following topics: - [How Client/Server Connections Work](../../topologies_and_comm/topology_concepts/how_the_pool_manages_connections.html#how_the_pool_manages_connections) - [Socket Communication](../../managing/monitor_tune/socket_communication.html) http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/firewalls_ports.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/firewalls_ports.html.md.erb b/geode-docs/configuring/running/firewalls_ports.html.md.erb index f9787ec..dd781c1 100644 --- a/geode-docs/configuring/running/firewalls_ports.html.md.erb +++ b/geode-docs/configuring/running/firewalls_ports.html.md.erb @@ -26,18 +26,18 @@ There are several different port settings that need to be considered when using - Port that the cache server listens on. This is configurable using the `cache-server` element in cache.xml, on the CacheServer class in Java APIs, and as a command line option to the `gfsh start server` command. - By default, if not otherwise specified, Geode clients and servers discover each other on a pre-defined port (**40404**) on the localhost. + By default, if not otherwise specified, <%=vars.product_name%> clients and servers discover each other on a pre-defined port (**40404**) on the localhost. -- Locator port. Geode clients can use the locator to automatically discover cache servers. The locator port is configurable as a command-line option to the `gfsh start locator` command. Locators are used in the peer-to-peer cache deployments to discover other processes. They can be used by clients to locate servers as an alternative to configuring clients with a collection of server addresses and ports. +- Locator port. <%=vars.product_name%> clients can use the locator to automatically discover cache servers. The locator port is configurable as a command-line option to the `gfsh start locator` command. Locators are used in the peer-to-peer cache deployments to discover other processes. They can be used by clients to locate servers as an alternative to configuring clients with a collection of server addresses and ports. - By default, if not otherwise specified, Geode locators use the default port **10334**. + By default, if not otherwise specified, <%=vars.product_name%> locators use the default port **10334**. - Since locators start up the distributed system, locators must also have their ephemeral port range and TCP port accessible to other members through the firewall. - For clients, you configure the client to connect to servers using the client's pool configuration. The client's pool configuration has two options: you can create a pool with either a list of server elements or a list of locator elements. For each element, you specify the host and port. The ports specified must be made accessible through your firewall. ## **Limiting Ephemeral Ports for Peer-to-Peer Membership** -By default, Geode assigns *ephemeral* ports, that is, temporary ports assigned from a designated range, which can encompass a large number of possible ports. When a firewall is present, the ephemeral port range usually must be limited to a much smaller number, for example six. If you are configuring P2P communications through a firewall, you must also set the TCP port for each process and ensure that UDP traffic is allowed through the firewall. +By default, <%=vars.product_name%> assigns *ephemeral* ports, that is, temporary ports assigned from a designated range, which can encompass a large number of possible ports. When a firewall is present, the ephemeral port range usually must be limited to a much smaller number, for example six. If you are configuring P2P communications through a firewall, you must also set the TCP port for each process and ensure that UDP traffic is allowed through the firewall. ## **Properties for Firewall and Port Configuration** @@ -183,9 +183,9 @@ This table contains properties potentially involved in firewall behavior, with a ## **Properties for Firewall and Port Configuration in Multi-Site (WAN) Configurations** -Each gateway receiver uses a port to listen for incoming communication from one or more gateway senders communication between Geode sites. The full range of port values for gateway receivers must be made accessible within the firewall from across the WAN. +Each gateway receiver uses a port to listen for incoming communication from one or more gateway senders communication between <%=vars.product_name%> sites. The full range of port values for gateway receivers must be made accessible within the firewall from across the WAN. -This table contains properties potentially involved in firewall behavior, with a brief description of each property. Click on a property name for a link to the [gemfire.properties and gfsecurity.properties (Geode Properties)](../../reference/topics/gemfire_properties.html#gemfire_properties) reference topic. +This table contains properties potentially involved in firewall behavior, with a brief description of each property. Click on a property name for a link to the [gemfire.properties and gfsecurity.properties (<%=vars.product_name%> Properties)](../../reference/topics/gemfire_properties.html#gemfire_properties) reference topic. <table> <colgroup> @@ -238,7 +238,7 @@ This table contains properties potentially involved in firewall behavior, with a <tr class="odd"> <td><p>Gateway Receiver</p></td> <td><p>[start-port](../../reference/topics/gfe_cache_xml.html#gateway-receiver) and [end-port](../../reference/topics/gfe_cache_xml.html#gateway-receiver) (cache.xml) or <code class="ph codeph">--start-port</code> and <code class="ph codeph">--end-port</code> parameters to the <code class="ph codeph">gfsh start gateway receiver</code> command</p></td> -<td><em>not set</em> Each gateway receiver uses a single port to accept connections from gateway senders in other systems. However, the configuration of a gateway receiver specifies a range of possible port values to use. Geode selects an available port from the specified range when the gateway receiver starts. Configure your firewall so that the full range of possible port values is accessible by gateway senders from across the WAN.</td> +<td><em>not set</em> Each gateway receiver uses a single port to accept connections from gateway senders in other systems. However, the configuration of a gateway receiver specifies a range of possible port values to use. <%=vars.product_name%> selects an available port from the specified range when the gateway receiver starts. Configure your firewall so that the full range of possible port values is accessible by gateway senders from across the WAN.</td> </tr> </tbody> </table> http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/managing_output_files.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/managing_output_files.html.md.erb b/geode-docs/configuring/running/managing_output_files.html.md.erb index b194f79..51d21a415 100644 --- a/geode-docs/configuring/running/managing_output_files.html.md.erb +++ b/geode-docs/configuring/running/managing_output_files.html.md.erb @@ -19,10 +19,10 @@ See the License for the specific language governing permissions and limitations under the License. --> -Geode output files are optional and can become quite large. Work with your system administrator to determine where to place them to avoid interfering with other system activities. +<%=vars.product_name%> output files are optional and can become quite large. Work with your system administrator to determine where to place them to avoid interfering with other system activities. <a id="managing_output_files__section_F0CEA4299D274801B9AB700C074F178F"></a> -Geode includes several types of optional output files as described below. +<%=vars.product_name%> includes several types of optional output files as described below. - **Log Files**. Comprehensive logging messages to help you confirm system configuration and to debug problems in configuration and code. Configure log file behavior in the `gemfire.properties` file. See [Logging](../../managing/logging/logging.html#concept_30DB86B12B454E168B80BB5A71268865). http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/running_the_cacheserver.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/running_the_cacheserver.html.md.erb b/geode-docs/configuring/running/running_the_cacheserver.html.md.erb index 578326a..37d864f 100644 --- a/geode-docs/configuring/running/running_the_cacheserver.html.md.erb +++ b/geode-docs/configuring/running/running_the_cacheserver.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Running Geode Server Processes ---- +<% set_title("Running", product_name, "Server Processes") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,29 +17,29 @@ See the License for the specific language governing permissions and limitations under the License. --> -A Geode server is a process that runs as a long-lived, configurable member of a client/server system. +A <%=vars.product_name%> server is a process that runs as a long-lived, configurable member of a client/server system. <a id="running_the_cacheserver__section_6C2B495518C04064A181E7917CA81FC1"></a> -The Geode server is used primarily for hosting long-lived data regions and for running standard Geode processes such as the server in a client/server configuration. You can start and stop servers using the following methods: +The <%=vars.product_name%> server is used primarily for hosting long-lived data regions and for running standard <%=vars.product_name%> processes such as the server in a client/server configuration. You can start and stop servers using the following methods: -- The `gfsh` tool allows you to manage Geode server processes from the command line. -- You can also start, stop and manage the Geode servers through the `org.apache.geode.distributed.ServerLauncher` API. The `ServerLauncher` API can only be used for Geode Servers that were started with `gfsh` or with the `ServerLauncher` class itself. See the JavaDocs for additional specifics on using the `ServerLauncher` API. +- The `gfsh` tool allows you to manage <%=vars.product_name%> server processes from the command line. +- You can also start, stop and manage the <%=vars.product_name%> servers through the `org.apache.geode.distributed.ServerLauncher` API. The `ServerLauncher` API can only be used for <%=vars.product_name%> Servers that were started with `gfsh` or with the `ServerLauncher` class itself. See the JavaDocs for additional specifics on using the `ServerLauncher` API. ## <a id="running_the_cacheserver__section_E15FB1B039CE4F6CB2E4B5618D7ECAA1" class="no-quick-link"></a>Default Server Configuration and Log Files The `gfsh` utility uses a working directory for its configuration files and log files. These are the defaults and configuration options: -- When you start a standalone server using `gfsh`, `gfsh` will automatically load the required JAR file `lib/geode-dependencies.jar` into the CLASSPATH of the JVM process. If you start a standalone server using the ServerLauncher API, you must specify this JAR file inside your command to launch the process. For more information on CLASSPATH settings in Geode, see [Setting Up the CLASSPATH](../../getting_started/setup_classpath.html). -- Servers are configured like any other Geode process, with `gemfire.properties` and shared cluster configuration files. It is not programmable except through application plug-ins. Typically, you provide the `gemfire.properties` file and the `gfsecurity.properties` file (if you are using a separate, restricted access security settings file). You can also specify a `cache.xml` file in the cache serverâs working directory. +- When you start a standalone server using `gfsh`, `gfsh` will automatically load the required JAR file `lib/geode-dependencies.jar` into the CLASSPATH of the JVM process. If you start a standalone server using the ServerLauncher API, you must specify this JAR file inside your command to launch the process. For more information on CLASSPATH settings in <%=vars.product_name%>, see [Setting Up the CLASSPATH](../../getting_started/setup_classpath.html). +- Servers are configured like any other <%=vars.product_name%> process, with `gemfire.properties` and shared cluster configuration files. It is not programmable except through application plug-ins. Typically, you provide the `gemfire.properties` file and the `gfsecurity.properties` file (if you are using a separate, restricted access security settings file). You can also specify a `cache.xml` file in the cache serverâs working directory. - By default, a new server started with `gfsh` receives its initial cache configuration from the cluster configuration service, assuming the locator is running the cluster configuration service. If you specify a group when starting the server, the server also receives configurations that apply to a group. The shared configuration consists of `cache.xml` files, `gemfire.properties` files, and deployed jar files. You can disable use of the cluster configuration service by specifying `--use-cluster-configuration=false` when starting the server using `gfsh`. See [Overview of the Cluster Configuration Service](../cluster_config/gfsh_persist.html#concept_r22_hyw_bl). -- If you are using the Spring Framework, you can specify a Spring ApplicationContext XML file when starting up your server in `gfsh` by using the `--spring-xml-location` command-line option. This option allows you to bootstrap your Geode server process with your Spring application's configuration. See [Spring documentation](http://docs.spring.io/spring/docs/3.2.x/spring-framework-reference/html/resources.html#resources-app-ctx) for more information on this file. +- If you are using the Spring Framework, you can specify a Spring ApplicationContext XML file when starting up your server in `gfsh` by using the `--spring-xml-location` command-line option. This option allows you to bootstrap your <%=vars.product_name%> server process with your Spring application's configuration. See [Spring documentation](http://docs.spring.io/spring/docs/3.2.x/spring-framework-reference/html/resources.html#resources-app-ctx) for more information on this file. - For logging output, log file output defaults to `server_name.log` in the cache server's working directory. If you restart a server with the same server name, the existing *server\_name*.log file is automatically renamed for you (for example, `server1-01-01.log` or `server1-02-01.log`). You can modify the level of logging details in this file by specifying a level in the `--log-level` argument when starting up the server. - By default, the server will start in a subdirectory (named after the server's specified `--name`) under the directory where `gfsh` is executed. This subdirectory is considered the current working directory. You can also specify a different working directory when starting the cache server in `gfsh`. - By default, a server process that has been shutdown and disconnected due to a network partition event or member unresponsiveness will restart itself and automatically try to reconnect to the existing distributed system. See [Handling Forced Cache Disconnection Using Autoreconnect](../../managing/member-reconnect.html#concept_22EE6DDE677F4E8CAF5786E17B4183A9) for more details. -- You can pass JVM parameters to the server's JVM by using the `--J=-Dproperty.name=value` upon server startup. These parameters can be Java properties or Geode configuration properties such as `gemfire.jmx-manager`. For example: +- You can pass JVM parameters to the server's JVM by using the `--J=-Dproperty.name=value` upon server startup. These parameters can be Java properties or <%=vars.product_name%> configuration properties such as `gemfire.jmx-manager`. For example: ``` pre gfsh>start server --name=server1 --J=-Dgemfire.jmx-manager=true \ @@ -52,7 +50,7 @@ The `gfsh` utility uses a working directory for its configuration files and log ## <a id="running_the_cacheserver__section_07001480D33745139C3707EDF8166D86" class="no-quick-link"></a>Start the Server -The startup syntax for Geode servers in `gfsh` is: +The startup syntax for <%=vars.product_name%> servers in `gfsh` is: ``` pre start server --name=value [--assign-buckets(=value)] [--bind-address=value] @@ -74,7 +72,7 @@ start server --name=value [--assign-buckets(=value)] [--bind-address=value] ``` **Note:** -When both `--max-heap` and `--initial-heap` are specified during server startup, additional GC parameters are specified internally by Geode's Resource Manager. If you do not want the additional default GC properties set by the Resource Manager, then use the `-Xms` & `-Xmx` JVM options. See [Controlling Heap Use with the Resource Manager](../../managing/heap_use/heap_management.html#configuring_resource_manager) for more information. +When both `--max-heap` and `--initial-heap` are specified during server startup, additional GC parameters are specified internally by <%=vars.product_name%>'s Resource Manager. If you do not want the additional default GC properties set by the Resource Manager, then use the `-Xms` & `-Xmx` JVM options. See [Controlling Heap Use with the Resource Manager](../../managing/heap_use/heap_management.html#configuring_resource_manager) for more information. The following `gfsh start server` start sequences specify a `cache.xml` file for cache configuration, and use different incoming client connection ports: http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/running_the_locator.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/running_the_locator.html.md.erb b/geode-docs/configuring/running/running_the_locator.html.md.erb index 853cb64..c26f9b5 100644 --- a/geode-docs/configuring/running/running_the_locator.html.md.erb +++ b/geode-docs/configuring/running/running_the_locator.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Running Geode Locator Processes ---- +<% set_title("Running", product_name, "Locator Processes") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,7 +17,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -The locator is a Geode process that tells new, connecting members where running members are located and provides load balancing for server use. +The locator is a <%=vars.product_name%> process that tells new, connecting members where running members are located and provides load balancing for server use. <a id="running_the_locator__section_E9C98E8756524552BEA9B0CA49A2069E"></a> You can run locators as peer locators, server locators, or both: @@ -29,13 +27,13 @@ You can run locators as peer locators, server locators, or both: By default, locators run as peer and server locators. -You can run the locator standalone or embedded within another Geode process. Running your locators standalone provides the highest reliability and availability of the locator service as a whole. +You can run the locator standalone or embedded within another <%=vars.product_name%> process. Running your locators standalone provides the highest reliability and availability of the locator service as a whole. ## <a id="running_the_locator__section_0733348268AF4D5F8851B999A6A36C53" class="no-quick-link"></a>Locator Configuration and Log Files Locator configuration and log files have the following properties: -- When you start a standalone locator using `gfsh`, `gfsh` will automatically load the required JAR file `lib/geode-dependencies.jar` into the CLASSPATH of the JVM process. If you start a standalone locator using the `LocatorLauncher` API, you must specify this JAR file inside the command used to launch the locator process. For more information on CLASSPATH settings in Geode, see [CLASSPATH Settings for Geode Processes](../../getting_started/setup_classpath.html). You can modify the CLASSPATH by specifying the `--classpath` parameter. +- When you start a standalone locator using `gfsh`, `gfsh` will automatically load the required JAR file `lib/geode-dependencies.jar` into the CLASSPATH of the JVM process. If you start a standalone locator using the `LocatorLauncher` API, you must specify this JAR file inside the command used to launch the locator process. For more information on CLASSPATH settings in <%=vars.product_name%>, see [CLASSPATH Settings for <%=vars.product_name%> Processes](../../getting_started/setup_classpath.html). You can modify the CLASSPATH by specifying the `--classpath` parameter. - Locators are members of the distributed system just like any other member. In terms of `mcast-port` and `locators` configuration, a locator should be configured in the same manner as a server. Therefore, if there are two other locators in the distributed system, each locator should reference the other locators (just like a server member would). For example: ``` pre @@ -81,7 +79,7 @@ Use the following guidelines to start the locator: - When starting up multiple locators, do not start them up in parallel (in other words, simultaneously). As a best practice, you should wait approximately 30 seconds for the first locator to complete startup before starting any other locators. To check the successful startup of a locator, check for locator log files. To view the uptime of a running locator, you can use the `gfsh status locator` command. - **Embedded (colocated) locator**. Manage a colocated locator at member startup or through the APIs: - - Use the `gemfire.properties` `start-locator` setting to start the locator automatically inside your Geode member. See the [Reference](../../reference/book_intro.html#reference). The locator stops automatically when the member exits. The property has the following syntax: + - Use the `gemfire.properties` `start-locator` setting to start the locator automatically inside your <%=vars.product_name%> member. See the [Reference](../../reference/book_intro.html#reference). The locator stops automatically when the member exits. The property has the following syntax: ``` pre #gemfire.properties http://git-wip-us.apache.org/repos/asf/geode/blob/92db0a6a/geode-docs/configuring/running/starting_up_shutting_down.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/running/starting_up_shutting_down.html.md.erb b/geode-docs/configuring/running/starting_up_shutting_down.html.md.erb index 2a06f0b..09c95de 100644 --- a/geode-docs/configuring/running/starting_up_shutting_down.html.md.erb +++ b/geode-docs/configuring/running/starting_up_shutting_down.html.md.erb @@ -21,18 +21,18 @@ limitations under the License. Determine the proper startup and shutdown procedures, and write your startup and shutdown scripts. -Well-designed procedures for starting and stopping your system can speed startup and protect your data. The processes you need to start and stop include server and locator processes and your other Geode applications, including clients. The procedures you use depend in part on your systemâs configuration and the dependencies between your system processes. +Well-designed procedures for starting and stopping your system can speed startup and protect your data. The processes you need to start and stop include server and locator processes and your other <%=vars.product_name%> applications, including clients. The procedures you use depend in part on your systemâs configuration and the dependencies between your system processes. Use the following guidelines to create startup and shutdown procedures and scripts. Some of these instructions use [`gfsh`](../../tools_modules/gfsh/chapter_overview.html). ## <a id="starting_up_shutting_down__section_3D111558326D4A38BE48C17D44BB66DB" class="no-quick-link"></a>Starting Up Your System -You should follow certain order guidelines when starting your Geode system. +You should follow certain order guidelines when starting your <%=vars.product_name%> system. Start server-distributed systems before you start their client applications. In each distributed system, follow these guidelines for member startup: -- Start locators first. See [Running Geode Locator Processes](running_the_locator.html) for examples of locator start up commands. -- Start cache servers before the rest of your processes unless the implementation requires that other processes be started ahead of them. See [Running Geode Server Processes](running_the_cacheserver.html) for examples of server start up commands. +- Start locators first. See [Running <%=vars.product_name%> Locator Processes](running_the_locator.html) for examples of locator start up commands. +- Start cache servers before the rest of your processes unless the implementation requires that other processes be started ahead of them. See [Running <%=vars.product_name%> Server Processes](running_the_cacheserver.html) for examples of server start up commands. - If your distributed system uses both persistent replicated and non-persistent replicated regions, you should start up all the persistent replicated members in parallel before starting the non-persistent regions. This way, persistent members will not delay their startup for other persistent members with later data. - For a system that includes persistent regions, see [Start Up and Shut Down with Disk Stores](../../managing/disk_storage/starting_system_with_disk_stores.html). - If you are running producer processes and consumer or event listener processes, start the consumers first. This ensures the consumers and listeners do not miss any notifications or updates. @@ -47,7 +47,7 @@ You can optionally override the default timeout period for shutting down individ ## <a id="starting_up_shutting_down__section_2F8ABBFCE641463C8A8721841407993D" class="no-quick-link"></a>Starting Up After Losing Data on Disk -This information pertains to catastrophic loss of Geode disk store files. If you lose disk store files, your next startup may hang, waiting for the lost disk stores to come back online. If your system hangs at startup, use the `gfsh` command `show missing-disk-store` to list missing disk stores and, if needed, revoke missing disk stores so your system startup can complete. You must use the Disk Store ID to revoke a disk store. These are the two commands: +This information pertains to catastrophic loss of <%=vars.product_name%> disk store files. If you lose disk store files, your next startup may hang, waiting for the lost disk stores to come back online. If your system hangs at startup, use the `gfsh` command `show missing-disk-store` to list missing disk stores and, if needed, revoke missing disk stores so your system startup can complete. You must use the Disk Store ID to revoke a disk store. These are the two commands: ``` pre gfsh>show missing-disk-stores @@ -64,7 +64,7 @@ This `gfsh` commands require that you are connected to the distributed system vi ## <a id="starting_up_shutting_down__section_mnx_4cp_cv" class="no-quick-link"></a>Shutting Down the System -Shut down your Geode system by using either the `gfsh` `shutdown` command or by shutting down individual members one at a time. +Shut down your <%=vars.product_name%> system by using either the `gfsh` `shutdown` command or by shutting down individual members one at a time. ## <a id="starting_up_shutting_down__section_0EB4DDABB6A348BA83B786EEE7C84CF1" class="no-quick-link"></a>Using the shutdown Command @@ -102,7 +102,7 @@ If you are not using persistent regions, you can shut down the distributed syste Shut down the distributed system members according to the type of member. For example, use the following mechanisms to shut down members: -- Use the appropriate mechanism to shut down any Geode-connected client applications that are running in the distributed system. +- Use the appropriate mechanism to shut down any <%=vars.product_name%>-connected client applications that are running in the distributed system. - Shut down any cache servers. To shut down a server, issue the following `gfsh` command: ``` pre @@ -140,7 +140,7 @@ or use `kill -INT`, which will allow an orderly shutdown of the process. ## <a id="starting_up_shutting_down__section_7CF680CF8A924C57A7052AE2F975DA81" class="no-quick-link"></a>Option for System Member Shutdown Behavior -The `DISCONNECT_WAIT` command line argument sets the maximum time for each individual step in the shutdown process. If any step takes longer than the specified amount, it is forced to end. Each operation is given this grace period, so the total length of time the cache member takes to shut down depends on the number of operations and the `DISCONNECT_WAIT` setting. During the shutdown process, Geode produces messages such as: +The `DISCONNECT_WAIT` command line argument sets the maximum time for each individual step in the shutdown process. If any step takes longer than the specified amount, it is forced to end. Each operation is given this grace period, so the total length of time the cache member takes to shut down depends on the number of operations and the `DISCONNECT_WAIT` setting. During the shutdown process, <%=vars.product_name%> produces messages such as: ``` pre Disconnect listener still running
