Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 5829D200CEC for ; Mon, 21 Aug 2017 23:08:24 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 56906165AEF; Mon, 21 Aug 2017 21:08:24 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 13872165AD9 for ; Mon, 21 Aug 2017 23:08:21 +0200 (CEST) Received: (qmail 25389 invoked by uid 500); 21 Aug 2017 21:08:21 -0000 Mailing-List: contact commits-help@geode.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.apache.org Delivered-To: mailing list commits@geode.apache.org Received: (qmail 24840 invoked by uid 99); 21 Aug 2017 21:08:19 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 21 Aug 2017 21:08:19 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 7981CF5587; Mon, 21 Aug 2017 21:08:19 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: udo@apache.org To: commits@geode.apache.org Date: Mon, 21 Aug 2017 21:08:35 -0000 Message-Id: <7578731464d2451ba167625777e1012f@git.apache.org> In-Reply-To: <5e4687b14ec8449887951fdfcff3dde0@git.apache.org> References: <5e4687b14ec8449887951fdfcff3dde0@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [18/51] [abbrv] geode git commit: GEODE-3395 Variable-ize product version and name in user guide - Tools & Modules archived-at: Mon, 21 Aug 2017 21:08:24 -0000 http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb ---------------------------------------------------------------------- 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 14636d8..33dd44e 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 @@ -1,6 +1,4 @@ ---- -title: Basic Geode gfsh Commands ---- +<% set_title("Basic", product_name, "gfsh Commands")%> -The Apache Geode HTTP Session Management modules provide fast, scalable, and reliable session replication for HTTP servers without requiring application changes. +The <%=vars.product_name_long%> HTTP Session Management modules provide fast, scalable, and reliable session replication for HTTP servers without requiring application changes. -Apache Geode offers HTTP session management modules for tc Server, Tomcat, and AppServers. +<%=vars.product_name_long%> offers HTTP session management modules for tc Server, Tomcat, and AppServers. -These modules are included with the Apache Geode product distribution, and installation .zip files can be found in the `tools/Modules` directory of your product installation. +These modules are included with the <%=vars.product_name_long%> product distribution, and installation .zip files can be found in the `tools/Modules` directory of your product installation. - **[HTTP Session Management Quick Start](../../tools_modules/http_session_mgmt/quick_start.html)** In this section you download, install, and set up the HTTP Session Management modules. -- **[Advantages of Using Geode for Session Management](../../tools_modules/http_session_mgmt/http_why_use_gemfire.html)** +- **[Advantages of Using <%=vars.product_name%> for Session Management](../../tools_modules/http_session_mgmt/http_why_use_gemfire.html)** The HTTP Session Management Module enables you to customize how you manage your session data. @@ -39,7 +39,7 @@ These modules are included with the Apache Geode product distribution, and insta - **[General Information on HTTP Session Management](../../tools_modules/http_session_mgmt/tc_additional_info.html)** - This section provides information on sticky load balancers, session expiration, additional Geode property changes, serialization and more. + This section provides information on sticky load balancers, session expiration, additional <%=vars.product_name%> property changes, serialization and more. - **[Session State Log Files](../../tools_modules/http_session_mgmt/session_state_log_files.html)** http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/common_gemfire_topologies.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/common_gemfire_topologies.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/common_gemfire_topologies.html.md.erb index f0bf050..e0bf3a9 100644 --- a/geode-docs/tools_modules/http_session_mgmt/common_gemfire_topologies.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/common_gemfire_topologies.html.md.erb @@ -33,4 +33,4 @@ In a peer-to-peer configuration, each instance within an application server cont

-In a client/server configuration, the Tomcat or tc Server instance operates as a Geode client, which must communicate with one or more Geode servers to acquire session data. The client maintains its own local cache and will communicate with the server to satisfy cache misses. A client/server configuration is useful when you want to separate the application server instance from the cached session data. In this configuration, you can reduce the memory consumption of the application server since session data is stored in separate Geode server processes. +In a client/server configuration, the Tomcat or tc Server instance operates as a <%=vars.product_name%> client, which must communicate with one or more <%=vars.product_name%> servers to acquire session data. The client maintains its own local cache and will communicate with the server to satisfy cache misses. A client/server configuration is useful when you want to separate the application server instance from the cached session data. In this configuration, you can reduce the memory consumption of the application server since session data is stored in separate <%=vars.product_name%> server processes. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/http_why_use_gemfire.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/http_why_use_gemfire.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/http_why_use_gemfire.html.md.erb index f47d625..01cd563 100644 --- a/geode-docs/tools_modules/http_session_mgmt/http_why_use_gemfire.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/http_why_use_gemfire.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Advantages of Using Geode for Session Management ---- +<% set_title("Advantages of Using", product_name, "for Session Management") %> -This section describes each prompt when entering into interactive configuration mode of the Geode HTTP Session Management Module for tc Server. +This section describes each prompt when entering into interactive configuration mode of the <%=vars.product_name%> HTTP Session Management Module for tc Server. ``` pre Please enter a value for 'geode-cs.maximum.vm.heap.size.mb'. Default '512': @@ -30,30 +30,30 @@ This section describes each prompt when entering into interactive configuration The above properties allow you to fine-tune your JVM heap and garbage collector. For more information, refer to [Managing Heap and Off-heap Memory](../../managing/heap_use/heap_management.html#resource_manager). ``` pre - Please specify whether to enable a Geode listener that logs session create, + Please specify whether to enable a <%=vars.product_name%> listener that logs session create, update, destroy and expiration events. Default 'false': ``` -The above property determines whether a debug cache listener is added to the session region. When true, info-level messages are logged to the Geode log when sessions are created, updated, invalidated, or expired. +The above property determines whether a debug cache listener is added to the session region. When true, info-level messages are logged to the <%=vars.product_name%> log when sessions are created, updated, invalidated, or expired. ``` pre With the geode-p2p template: - Please specify whether to maintain a local Geode cache. Default 'false': + Please specify whether to maintain a local <%=vars.product_name%> cache. Default 'false': With the geode-cs template: - Please specify whether to maintain a local Geode cache. Default 'true': + Please specify whether to maintain a local <%=vars.product_name%> cache. Default 'true': ``` The above property determines whether a local cache is enabled; if this parameter is set to true, the app server load balancer should be configured for sticky session mode. ``` pre With the geode-p2p template: - Please enter the id of the attributes of the Geode region used to cache + Please enter the id of the attributes of the <%=vars.product_name%> region used to cache sessions. Default 'REPLICATE': With the geode-cs template: - Please enter the id of the attributes of the Geode region used to cache + Please enter the id of the attributes of the <%=vars.product_name%> region used to cache sessions. Default 'PARTITION_REDUNDANT': ``` @@ -61,11 +61,11 @@ With the geode-cs template: The above property determines the ID of the attributes for the cache region; possible values include PARTITION, PARTITION\_REDUNDANT, PARTITION\_PERSISTENT, REPLICATE, REPLICATE\_PERSISTENT, and any other region shortcut that can be found in [Region Shortcuts and Custom Named Region Attributes](../../basic_config/data_regions/region_shortcuts.html). When using a partitioned region attribute, it is recommended that you use PARTITION\_REDUNDANT (rather than PARTITION) to ensure that the failure of a server does not result in lost session data. ``` pre - Please enter the name of the Geode region used to cache sessions. + Please enter the name of the <%=vars.product_name%> region used to cache sessions. Default 'gemfire_modules_sessions': ``` -The above property determines the Geode region name. +The above property determines the <%=vars.product_name%> region name. ``` pre Please enter the port that Tomcat Shutdown should listen on. Default '-1': @@ -84,11 +84,11 @@ tc Server requires information about connector ports. `bio.http.port` is the htt ``` pre With the geode-p2p template: - Please enter the name of the Geode cache configuration file. + Please enter the name of the <%=vars.product_name%> cache configuration file. Default 'cache-peer.xml': With the geode-cs template: - Please enter the name of the Geode cache configuration file. + Please enter the name of the <%=vars.product_name%> cache configuration file. Default 'cache-client.xml': ``` @@ -104,36 +104,36 @@ You can change the name of the cache configuration file with the above property. The above properties allow you to control the critical and eviction watermarks for the heap. By default, the critical watermark is disabled (set to 0.0) and the eviction watermark is set to 80%. ``` pre -Please enter the list of locators used by Geode members to discover each other. +Please enter the list of locators used by <%=vars.product_name%> members to discover each other. The format is a comma-separated list of host[port]. Default ' ': ``` The above property specifies the list of locators. ``` pre - Please enter the name of the file used to log Geode messages. + Please enter the name of the file used to log <%=vars.product_name%> messages. Default 'gemfire_modules.log': ``` -The above property determines the file name for the Geode log file. +The above property determines the file name for the <%=vars.product_name%> log file. ``` pre Applicable to the geode-p2p template ONLY: - Please specify whether to rebalance the Geode cache at startup. + Please specify whether to rebalance the <%=vars.product_name%> cache at startup. Default 'false': ``` -This property allows you to rebalance a partitioned Geode cache when a new Geode peer starts up. +This property allows you to rebalance a partitioned <%=vars.product_name%> cache when a new <%=vars.product_name%> peer starts up. ``` pre - Please enter the name of the file used to store Geode statistics. + Please enter the name of the file used to store <%=vars.product_name%> statistics. Default 'gemfire_modules.gfs': ``` -The above property determines the filename for the Geode statistics file. +The above property determines the filename for the <%=vars.product_name%> statistics file. ``` pre - Please specify whether Geode statistic sampling should be enabled. + Please specify whether <%=vars.product_name%> statistic sampling should be enabled. Default 'false': ``` http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/quick_start.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/quick_start.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/quick_start.html.md.erb index fcbb138..4d63da0 100644 --- a/geode-docs/tools_modules/http_session_mgmt/quick_start.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/quick_start.html.md.erb @@ -49,7 +49,7 @@ In this section you download, install, and set up the HTTP Session Management mo These steps provide a basic starting point for using the tc Server module. For more configuration options, see [HTTP Session Management Module for Pivotal tc Server](session_mgmt_tcserver.html). As a prerequisite, module set up requires a JAVA\_HOME environment variable set to the java installation. 1. Navigate to the root directory of tc Server. -2. Create a Geode instance using one of the provided templates and start the instance after starting up a locator. For example: +2. Create a <%=vars.product_name%> instance using one of the provided templates and start the instance after starting up a locator. For example: ``` pre $ gfsh start locator --name=locator1 @@ -57,7 +57,7 @@ These steps provide a basic starting point for using the tc Server module. For m $ ./tcruntime-ctl.sh my_instance_name start ``` - This will create and run a Geode instance using the peer-to-peer topology and default configuration values. Another Geode instance on another system can be created and started in the same way. + This will create and run a <%=vars.product_name%> instance using the peer-to-peer topology and default configuration values. Another <%=vars.product_name%> instance on another system can be created and started in the same way. If you need to pin your tc Server instance to a specific tc Server runtime version, use the `--version` option when creating the instance. @@ -92,13 +92,13 @@ These steps provide a basic starting point for using the AppServers module with **Note:** -- The `modify_war` script relies upon a GEODE environment variable. Set the GEODE environment variable to the Geode product directory; this is the parent directory of `bin`. +- The `modify_war` script relies upon a GEODE environment variable. Set the GEODE environment variable to the <%=vars.product_name%> product directory; this is the parent directory of `bin`. - The `modify_war` script, described below, relies on files within the distribution tree and should not be run outside of a complete distribution. - The `modify_war` script is a `bash` script and does not run on Windows. To set up the AppServers module, perform the following steps: -1. Run the `modify_war` script against an existing `.war` or `.ear` file to integrate the necessary components. The example below will create a configuration suitable for a peer-to-peer Geode system, placing the necessary libraries into `WEB-INF/lib` for wars and `lib` for ears and modifying any `web.xml` files: +1. Run the `modify_war` script against an existing `.war` or `.ear` file to integrate the necessary components. The example below will create a configuration suitable for a peer-to-peer <%=vars.product_name%> system, placing the necessary libraries into `WEB-INF/lib` for wars and `lib` for ears and modifying any `web.xml` files: ``` pre $ bin/modify_war -w my-app.war -p gemfire.property.locators=localhost[10334] \ http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tcserver.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tcserver.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tcserver.html.md.erb index 833a918..8af8a03 100644 --- a/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tcserver.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tcserver.html.md.erb @@ -31,8 +31,8 @@ If you would prefer to manually change the `server.xml` and `context.xml` files To set up the HTTP Module for tc Server, start a tc Server instance with the appropriate tc Server template based on your preferred topology. -- **[Changing the Default Geode Configuration in the tc Server Module](../../tools_modules/http_session_mgmt/tc_changing_gf_default_cfg.html)** +- **[Changing the Default <%=vars.product_name%> Configuration in the tc Server Module](../../tools_modules/http_session_mgmt/tc_changing_gf_default_cfg.html)** - By default, the tc Server HTTP module will run Geode automatically with pre-configured settings. You can change these Geode settings. + By default, the tc Server HTTP module will run <%=vars.product_name%> automatically with pre-configured settings. You can change these <%=vars.product_name%> settings. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tomcat.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tomcat.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tomcat.html.md.erb index aef1c3a..e8c9d5a 100644 --- a/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tomcat.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/session_mgmt_tomcat.html.md.erb @@ -29,10 +29,10 @@ For instructions specific to SpringSource tc Server templates, refer to [HTTP Se - **[Setting Up the HTTP Module for Tomcat](../../tools_modules/http_session_mgmt/tomcat_setting_up_the_module.html)** - To use the Geode HTTP module with Tomcat application servers, you will need to modify Tomcat's `server.xml` and `context.xml` files. + To use the <%=vars.product_name%> HTTP module with Tomcat application servers, you will need to modify Tomcat's `server.xml` and `context.xml` files. -- **[Changing the Default Geode Configuration in the Tomcat Module](../../tools_modules/http_session_mgmt/tomcat_changing_gf_default_cfg.html)** +- **[Changing the Default <%=vars.product_name%> Configuration in the Tomcat Module](../../tools_modules/http_session_mgmt/tomcat_changing_gf_default_cfg.html)** - By default, the Tomcat module will run Geode automatically with pre-configured settings. You can change these Geode settings. + By default, the Tomcat module will run <%=vars.product_name%> automatically with pre-configured settings. You can change these <%=vars.product_name%> settings. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/session_mgmt_weblogic.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/session_mgmt_weblogic.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/session_mgmt_weblogic.html.md.erb index 075c9fa..fc1be0c 100644 --- a/geode-docs/tools_modules/http_session_mgmt/session_mgmt_weblogic.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/session_mgmt_weblogic.html.md.erb @@ -21,14 +21,14 @@ limitations under the License. You implement session caching with the HTTP Session Management Module for AppServers with a special filter, defined in the `web.xml`, which is configured to intercept and wrap all requests. -You can use this HTTP module with a variety of application servers. Wrapping each request allows the interception of `getSession()` calls to be handled by Geode instead of the native container. This approach is a generic solution, which is supported by any container that implements the Servlet 2.4 specification. +You can use this HTTP module with a variety of application servers. Wrapping each request allows the interception of `getSession()` calls to be handled by <%=vars.product_name%> instead of the native container. This approach is a generic solution, which is supported by any container that implements the Servlet 2.4 specification. - **[Setting Up the HTTP Module for AppServers](../../tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html)** To use the module, you need to modify your application's `web.xml` files. Configuration is slightly different depending on the topology you are setting up. -- **[Changing the Default Geode Configuration in the AppServers Module](../../tools_modules/http_session_mgmt/weblogic_changing_gf_default_cfg.html)** +- **[Changing the Default <%=vars.product_name%> Configuration in the AppServers Module](../../tools_modules/http_session_mgmt/weblogic_changing_gf_default_cfg.html)** - By default, the AppServers module will run Geode automatically with preconfigured settings. You can change these Geode settings. + By default, the AppServers module will run <%=vars.product_name%> automatically with preconfigured settings. You can change these <%=vars.product_name%> settings. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/session_state_log_files.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/session_state_log_files.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/session_state_log_files.html.md.erb index 4a84e99..44679cb 100644 --- a/geode-docs/tools_modules/http_session_mgmt/session_state_log_files.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/session_state_log_files.html.md.erb @@ -22,12 +22,12 @@ limitations under the License. Several log files are written by the various parts of the session management code. - `catalina.log`. Log file written by the tc server -- `cacheserver.log`. Log file written by the Geode server process. -- `gemfire_modules.log`. Log file written by the Geode cache client. +- `cacheserver.log`. Log file written by the <%=vars.product_name%> server process. +- `gemfire_modules.log`. Log file written by the <%=vars.product_name%> cache client. ## Adding FINE Debug Logging to catalina.log -To add Geode-specific FINE logging to the `catalina.log` file, add the following lines to your `/conf/logging.properties` file: +To add <%=vars.product_name%>-specific FINE logging to the `catalina.log` file, add the following lines to your `/conf/logging.properties` file: ``` pre org.apache.geode.modules.session.catalina.DeltaSessionManager.level = FINE @@ -50,9 +50,9 @@ Created session region: org.apache.geode.internal.cache.LocalRegion[path='/gemfi scope=LOCAL';dataPolicy=EMPTY; gatewayEnabled=false] ``` -## Add Session State Logging to the Geode Server Log +## Add Session State Logging to the <%=vars.product_name%> Server Log -To add session-state-specific logging to the Geode server log file, add the following property to the `catalina.properties` file for the tc Server instance: +To add session-state-specific logging to the <%=vars.product_name%> server log file, add the following property to the `catalina.properties` file for the tc Server instance: ``` pre geode-cs.enable.debug.listener=true @@ -73,9 +73,9 @@ sessionRegionName=gemfire_modules_sessions; operatingRegionName=unset] key=5782ED83A3D9F101BBF8D851CE4E798E ``` -## Adding Additional Debug Logging to the Geode Server Log +## Adding Additional Debug Logging to the <%=vars.product_name%> Server Log -To add fine-level logging to the Geode cache server, add the 'log-level' property to the server process. For example: +To add fine-level logging to the <%=vars.product_name%> cache server, add the 'log-level' property to the server process. For example: ``` pre gfsh> start server --name=server1 --cache-xml-file=../conf/cache-server.xml @@ -85,11 +85,11 @@ gfsh> start server --name=server1 --cache-xml-file=../conf/cache-server.xml This will add fine-level logging to the `server.log` file. **Note:** -This will help debug Geode server issues, but it adds a lot of logging to the file. +This will help debug <%=vars.product_name%> server issues, but it adds a lot of logging to the file. ## Add Debug Logging to gemfire\_modules.log -To add fine-level logging to the Geode Cache Client, add the 'log-level' property to the Listener element in the tc Server or Tomcat `server.xml` file. For example: +To add fine-level logging to the <%=vars.product_name%> Cache Client, add the 'log-level' property to the Listener element in the tc Server or Tomcat `server.xml` file. For example: ``` pre This will add fine-level logging to the file defined by the `${geode-cs.log.file}` property. The default log file name is `gemfire_modules.log`. **Note:** -This will help debug Geode client issues, but it adds a lot of logging to the file. +This will help debug <%=vars.product_name%> client issues, but it adds a lot of logging to the file. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/tc_additional_info.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/tc_additional_info.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/tc_additional_info.html.md.erb index 991fd94..c4adcd6 100644 --- a/geode-docs/tools_modules/http_session_mgmt/tc_additional_info.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/tc_additional_info.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -This section provides information on sticky load balancers, session expiration, additional Geode property changes, serialization and more. +This section provides information on sticky load balancers, session expiration, additional <%=vars.product_name%> property changes, serialization and more. ## Sticky Load Balancers @@ -30,20 +30,20 @@ as a possible [load balancing](http://static.springsource.com/projects/ers/4.0/g ## Session Expiration To set the session expiration value, you must change the `session-timeout` value specified in your application server's `WEB-INF/web.xml` file. -This value will override the Geode inactive interval, which is specified in Tomcat, for example, by `maxInactiveInterval` within `context.xml`. +This value will override the <%=vars.product_name%> inactive interval, which is specified in Tomcat, for example, by `maxInactiveInterval` within `context.xml`. -When a session expires, it gets removed from the application server and from all Geode servers when running in client-server mode. +When a session expires, it gets removed from the application server and from all <%=vars.product_name%> servers when running in client-server mode. -## Making Additional Geode Property Changes +## Making Additional <%=vars.product_name%> Property Changes -If you want to change additional Geode property values, refer to instructions on manually changing property values as specified in the Geode module documentation for Tomcat ([Changing the Default Geode Configuration in the Tomcat Module](tomcat_changing_gf_default_cfg.html#tomcat_changing_gf_default_cfg)) and Application Servers ([Changing the Default Geode Configuration in the AppServers Module](weblogic_changing_gf_default_cfg.html#weblogic_changing_gf_default_cfg)). +If you want to change additional <%=vars.product_name%> property values, refer to instructions on manually changing property values as specified in the <%=vars.product_name%> module documentation for Tomcat ([Changing the Default <%=vars.product_name%> Configuration in the Tomcat Module](tomcat_changing_gf_default_cfg.html#tomcat_changing_gf_default_cfg)) and Application Servers ([Changing the Default <%=vars.product_name%> Configuration in the AppServers Module](weblogic_changing_gf_default_cfg.html#weblogic_changing_gf_default_cfg)). ## Module Version Information -To acquire Geode module version information, look in the web server's log file for a message similar to: +To acquire <%=vars.product_name%> module version information, look in the web server's log file for a message similar to: ``` pre -INFO: Initializing Geode Modules +INFO: Initializing <%=vars.product_name%> Modules Java version: 1.0.0 user1 041216 2016-11-12 11:18:37 -0700 javac 1.8.0_92 Native version: native code unavailable http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/tc_changing_gf_default_cfg.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/tc_changing_gf_default_cfg.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/tc_changing_gf_default_cfg.html.md.erb index a49009f..2198d2b 100644 --- a/geode-docs/tools_modules/http_session_mgmt/tc_changing_gf_default_cfg.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/tc_changing_gf_default_cfg.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Changing the Default Geode Configuration in the tc Server Module ---- +<% set_title("Changing the Default", product_name, "Configuration in the tc Server Module")%> -By default, the tc Server HTTP module will run Geode automatically with pre-configured settings. You can change these Geode settings. +By default, the tc Server HTTP module will run <%=vars.product_name%> automatically with pre-configured settings. You can change these <%=vars.product_name%> settings. -Here are the default Geode settings: +Here are the default <%=vars.product_name%> settings: -- Geode peer-to-peer members use locators for discovery. +- <%=vars.product_name%> peer-to-peer members use locators for discovery. - The region name is set to `gemfire_modules_sessions`. - The cache region is replicated for peer-to-peer configurations and partitioned (with redundancy turned on) for client/server configurations. -- Geode clients have local caching turned on and when the local cache needs to evict data, it will evict least-recently-used (LRU) data first. +- <%=vars.product_name%> clients have local caching turned on and when the local cache needs to evict data, it will evict least-recently-used (LRU) data first. **Note:** On the application server side, the default inactive interval for session expiration is set to 30 minutes. To change this value, refer to [Session Expiration](tc_additional_info.html#tc_additional_info__section_C7C4365EA2D84636AE1586F187007EC4). @@ -65,7 +63,7 @@ For information on setting up your instance for the most common types of configu ## Using a Different Locator Port -For a Geode peer-to-peer member to communicate on a different port than the default (10334), answer the following question in the tc Server HTTP module's interactive mode: +For a <%=vars.product_name%> peer-to-peer member to communicate on a different port than the default (10334), answer the following question in the tc Server HTTP module's interactive mode: ``` pre Please enter the list of locators used by GemFire members to discover each other. @@ -93,6 +91,6 @@ Then on the cache server side, reference the modified region attributes template - **[Interactive Configuration Reference for the tc Server Module](../../tools_modules/http_session_mgmt/interactive_mode_ref.html)** - This section describes each prompt when entering into interactive configuration mode of the Geode HTTP Session Management Module for tc Server. + This section describes each prompt when entering into interactive configuration mode of the <%=vars.product_name%> HTTP Session Management Module for tc Server. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/tc_installing_the_module.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/tc_installing_the_module.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/tc_installing_the_module.html.md.erb index a247e82..1090642 100644 --- a/geode-docs/tools_modules/http_session_mgmt/tc_installing_the_module.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/tc_installing_the_module.html.md.erb @@ -22,7 +22,7 @@ limitations under the License. This topic describes how to install the HTTP session management module with tc Server templates. 1. If you do not already have tc Server, download and install the product from the [Pivotal tc Server download page](https://network.pivotal.io/products/pivotal-tcserver). These instructions require **tc Server 2.9** or later. -2. The HTTP Session Management Module for tc Server is included in the Apache Geode installation package. After you install Apache Geode, you will find the module in the `tools/Modules` directory of the installation. +2. The HTTP Session Management Module for tc Server is included in the <%=vars.product_name_long%> installation package. After you install <%=vars.product_name_long%>, you will find the module in the `tools/Modules` directory of the installation. 3. Unzip the module into the Pivotal tc Server `$CATALINA_HOME/templates` directory so that it creates `geode-p2p` and `geode-cs` subdirectories within the tc Server `templates` directory. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erb index bf64219..c0f8f5d 100644 --- a/geode-docs/tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/tc_setting_up_the_module.html.md.erb @@ -98,17 +98,17 @@ In Windows: $ ./tcruntime-ctl.bat my_instance_name start ``` -Refer to the [tc Server](http://www.vmware.com/products/vfabric-tcserver) documentation for more information. Once started, Geode will automatically launch within the application server process. +Refer to the [tc Server](http://www.vmware.com/products/vfabric-tcserver) documentation for more information. Once started, <%=vars.product_name%> will automatically launch within the application server process. **Note:** -Geode session state management provides its own clustering functionality. If you are using Geode, you should NOT turn on Tomcat clustering as well. +<%=vars.product_name%> session state management provides its own clustering functionality. If you are using <%=vars.product_name%>, you should NOT turn on Tomcat clustering as well. To verify that the system is running, check the log file for a message similar to: ``` pre Mar 29, 2016 8:38:31 AM org.apache.geode.modules.session.bootstrap.AbstractCache lifecycleEvent -INFO: Initializing Geode Modules +INFO: Initializing <%=vars.product_name%> Modules Modules version: 1.0.0 Java version: 1.0.0 user1 032916 2016-11-29 07:49:26 -0700 javac 1.8.0_92 @@ -118,7 +118,7 @@ Source repository: develop Running on: /192.0.2.0, 8 cpu(s), x86_64 Mac OS X 10.11.4 ``` -Information is also logged within the Geode log file, which by default is named `gemfire_modules.log`. +Information is also logged within the <%=vars.product_name%> log file, which by default is named `gemfire_modules.log`. ## Configuring Non-Sticky Session Replication http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/tomcat_changing_gf_default_cfg.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/tomcat_changing_gf_default_cfg.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/tomcat_changing_gf_default_cfg.html.md.erb index a6a5b46..539a992 100644 --- a/geode-docs/tools_modules/http_session_mgmt/tomcat_changing_gf_default_cfg.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/tomcat_changing_gf_default_cfg.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Changing the Default Geode Configuration in the Tomcat Module ---- +<% set_title("Changing the Default", product_name, "Configuration in the Tomcat Module") %> -By default, the Tomcat module will run Geode automatically with pre-configured settings. You can change these Geode settings. +By default, the Tomcat module will run <%=vars.product_name%> automatically with pre-configured settings. You can change these <%=vars.product_name%> settings. Here are the default settings: - Locators are used for member discovery. - The region name is set to `gemfire_modules_sessions`. - The cache region is replicated for peer-to-peer configurations and partitioned (with redundancy turned on) for client/server configurations. -- Geode clients have local caching turned on and when the local cache needs to evict data, it will evict least-recently-used (LRU) data first. +- <%=vars.product_name%> clients have local caching turned on and when the local cache needs to evict data, it will evict least-recently-used (LRU) data first. **Note:** On the application server side, the default inactive interval for session expiration is set to 30 minutes. To change this value, refer to [Session Expiration](tc_additional_info.html#tc_additional_info__section_C7C4365EA2D84636AE1586F187007EC4). -## Changing Geode Distributed System Properties +## Changing <%=vars.product_name%> Distributed System Properties -Geode system properties must be set by adding properties to Tomcat's `server.xml` file. When setting properties, use the following syntax: +<%=vars.product_name%> system properties must be set by adding properties to Tomcat's `server.xml` file. When setting properties, use the following syntax: ``` pre ``` -The list of configurable Tomcat's `server.xml` system properties include any of the properties that can be specified in Geode's `gemfire.properties` file. The following list contains some of the properties that can be configured. +The list of configurable Tomcat's `server.xml` system properties include any of the properties that can be specified in <%=vars.product_name%>'s `gemfire.properties` file. The following list contains some of the properties that can be configured. | Parameter | Description | Default | |-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| | cache-xml-file | name of the cache configuration file | `cache-peer.xml` for peer-to-peer, `cache-client.xml` for client/server | -| locators (only for peer-to-peer topology) | (required) list of locators (host\[port\]) used by Geode members; if a single locator listens on its default port, then set this value to `"localhost[10334]"` | empty string | -| log-file | name of the Geode log file | `gemfire_modules.log` | -| statistic-archive-file | name of the Geode statistics file | `gemfire_modules.gfs` | -| statistic-sampling-enabled | whether Geode statistics sampling is enabled | false | +| locators (only for peer-to-peer topology) | (required) list of locators (host\[port\]) used by <%=vars.product_name%> members; if a single locator listens on its default port, then set this value to `"localhost[10334]"` | empty string | +| log-file | name of the <%=vars.product_name%> log file | `gemfire_modules.log` | +| statistic-archive-file | name of the <%=vars.product_name%> statistics file | `gemfire_modules.gfs` | +| statistic-sampling-enabled | whether <%=vars.product_name%> statistics sampling is enabled | false | For more information on these properties, along with the full list of properties, see the [Reference](../../reference/book_intro.html#reference). -In addition to the standard Geode system properties, the following cache-specific properties can also be configured with the `LifecycleListener`. +In addition to the standard <%=vars.product_name%> system properties, the following cache-specific properties can also be configured with the `LifecycleListener`. | Parameter | Description | Default | |------------------------|-------------------------------------------------------------------------------------------------|--------------| @@ -75,11 +73,11 @@ In addition to the standard Geode system properties, the following cache-specifi | evictionHeapPercentage | percentage of heap at which session eviction begins | 80.0 | | rebalance | whether a rebalance of the cache should be done when the application server instance is started | false | -Although these properties are not part of the standard Geode system properties, they apply to the entire JVM instance and are therefore also handled by the `LifecycleListener`. For more information about managing the heap, refer to [Managing Heap and Off-heap Memory](../../managing/heap_use/heap_management.html#resource_manager). +Although these properties are not part of the standard <%=vars.product_name%> system properties, they apply to the entire JVM instance and are therefore also handled by the `LifecycleListener`. For more information about managing the heap, refer to [Managing Heap and Off-heap Memory](../../managing/heap_use/heap_management.html#resource_manager). ## Changing Cache Configuration Properties -To edit Geode cache properties such as the name and the characteristics of the cache region, you add these properties to Tomcat's `context.xml` file. When adding properties, unless otherwise specified, use the following syntax: +To edit <%=vars.product_name%> cache properties such as the name and the characteristics of the cache region, you add these properties to Tomcat's `context.xml` file. When adding properties, unless otherwise specified, use the following syntax: ``` pre **CommitSessionValve** -

Whether to wait until the end of the HTTP request to save all session attribute changes to the Geode cache; if the configuration line is present in the application's `context.xml` file, then only one put will be performed into the cache for the session per HTTP request. If the configuration line is not included, then the session is saved each time the `setAttribute` or `removeAttribute` method is invoked. As a consequence, multiple puts are performed into the cache during a single session. This configuration setting is recommended for any applications that modify the session frequently during a single HTTP request.

Whether to wait until the end of the HTTP request to save all session attribute changes to the <%=vars.product_name%> cache; if the configuration line is present in the application's `context.xml` file, then only one put will be performed into the cache for the session per HTTP request. If the configuration line is not included, then the session is saved each time the `setAttribute` or `removeAttribute` method is invoked. As a consequence, multiple puts are performed into the cache during a single session. This configuration setting is recommended for any applications that modify the session frequently during a single HTTP request.

Default: Set @@ -120,7 +118,7 @@ To disable this configuration, remove or comment out the following line from Tom Default: `false` -The Geode API equivalent to setting this parameter: +The <%=vars.product_name%> API equivalent to setting this parameter: ``` pre // Create factory @@ -134,7 +132,7 @@ factory.addCacheListener(new DebugCacheListener()); Default: `false` for peer-to-peer, `true` for client/server -The Geode API equivalent to setting this parameter: +The <%=vars.product_name%> API equivalent to setting this parameter: ``` pre // For peer-to-peer members: @@ -148,7 +146,7 @@ ClientCache.createClientRegionFactory(CACHING_PROXY_HEAP_LRU); Default: REPLICATE for peer-to-peer, PARTITION\_REDUNDANT for client/server -The Geode API equivalent to setting this parameter: +The <%=vars.product_name%> API equivalent to setting this parameter: ``` pre // Creates a region factory for the specified region shortcut @@ -160,7 +158,7 @@ Cache.createRegionFactory(regionAttributesId); Default: gemfire\_modules\_sessions -The Geode API equivalent to setting this parameter: +The <%=vars.product_name%> API equivalent to setting this parameter: ``` pre // Creates a region with the specified name http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/tomcat_installing_the_module.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/tomcat_installing_the_module.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/tomcat_installing_the_module.html.md.erb index de5d3ab..f3fc35c 100644 --- a/geode-docs/tools_modules/http_session_mgmt/tomcat_installing_the_module.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/tomcat_installing_the_module.html.md.erb @@ -22,7 +22,7 @@ limitations under the License. This topic describes how to install the HTTP session management module for Tomcat. 1. If you do not already have Tomcat installed, download the desired version from the [Apache Website](http://tomcat.apache.org/). -2. The HTTP Session Management Module for Tomcat is included in the Geode installation package. After you install Apache Geode, you will find the module in the `tools/Modules` directory of the installation. +2. The HTTP Session Management Module for Tomcat is included in the <%=vars.product_name%> installation package. After you install <%=vars.product_name_long%>, you will find the module in the `tools/Modules` directory of the installation. 3. Unzip the module into the `$CATALINA_HOME` directory or wherever you installed the application server. 4. Copy the following jar files to the `lib` directory of your Tomcat server (`$CATALINA_HOME/lib`): http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/tomcat_setting_up_the_module.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/tomcat_setting_up_the_module.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/tomcat_setting_up_the_module.html.md.erb index 73e104c..4707f3a 100644 --- a/geode-docs/tools_modules/http_session_mgmt/tomcat_setting_up_the_module.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/tomcat_setting_up_the_module.html.md.erb @@ -19,14 +19,14 @@ See the License for the specific language governing permissions and limitations under the License. --> -To use the Geode HTTP module with Tomcat application servers, you will need to modify Tomcat's `server.xml` and `context.xml` files. +To use the <%=vars.product_name%> HTTP module with Tomcat application servers, you will need to modify Tomcat's `server.xml` and `context.xml` files. Configuration is slightly different depending on the topology you are setting up. Refer to [Common Topologies for HTTP Session Management](common_gemfire_topologies.html#common_gemfire_topologies) for more information. ## Peer-to-Peer Setup

-To run Geode in a peer-to-peer configuration, add the following line to Tomcat's `$CATALINA_HOME$/conf/server.xml` within the `` tag: +To run <%=vars.product_name%> in a peer-to-peer configuration, add the following line to Tomcat's `$CATALINA_HOME$/conf/server.xml` within the `` tag: ``` pre -To run Geode in a client/server configuration, the application server will operate as a Geode client. To do this, add the following line to `$CATALINA_HOME$/conf/server.xml` within the `` tag: +To run <%=vars.product_name%> in a client/server configuration, the application server will operate as a <%=vars.product_name%> client. To do this, add the following line to `$CATALINA_HOME$/conf/server.xml` within the `` tag: ``` pre ``` -The application server operates as a Geode client in this configuration. With a similar environment to this example that is for a client/server set up, +The application server operates as a <%=vars.product_name%> client in this configuration. With a similar environment to this example that is for a client/server set up, ``` pre TC_VER=tomcat-8.0.30.C.RELEASE @@ -112,14 +112,14 @@ $ gfsh start server --name=server1 --locators=localhost[10334] --server-port=0 \ ## Starting the Application Server -Once you've updated the configuration, you are now ready to start your tc Server or Tomcat instance. Refer to your application server documentation for starting the application server. Once started, Geode will automatically launch within the application server process. +Once you've updated the configuration, you are now ready to start your tc Server or Tomcat instance. Refer to your application server documentation for starting the application server. Once started, <%=vars.product_name%> will automatically launch within the application server process. **Note:** -Geode session state management provides its own clustering functionality. If you are using Geode, you should NOT turn on Tomcat clustering as well. +<%=vars.product_name%> session state management provides its own clustering functionality. If you are using <%=vars.product_name%>, you should NOT turn on Tomcat clustering as well. -## Verifying that Geode Started +## Verifying that <%=vars.product_name%> Started -You can verify that Geode has successfully started by inspecting the Tomcat log file. For example: +You can verify that <%=vars.product_name%> has successfully started by inspecting the Tomcat log file. For example: ``` pre Nov 8, 2010 12:12:12 PM @@ -130,4 +130,4 @@ INFO: Created GemFireCache[id = 2066231378; isClosing = false; copyOnRead = false; lockLease = 120; lockTimeout = 60] ``` -Information is also logged within the Geode log file, which by default is named `gemfire_modules.log`. +Information is also logged within the <%=vars.product_name%> log file, which by default is named `gemfire_modules.log`.