http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/weblogic_changing_gf_default_cfg.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/weblogic_changing_gf_default_cfg.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/weblogic_changing_gf_default_cfg.html.md.erb index 50e41be..03ab078 100644 --- a/geode-docs/tools_modules/http_session_mgmt/weblogic_changing_gf_default_cfg.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/weblogic_changing_gf_default_cfg.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Changing the Default Geode Configuration in the AppServers Module ---- +<% set_title("Changing the Default", product_name, "Configuration in the AppServers Module") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,14 +17,14 @@ See the License for the specific language governing permissions and limitations under the License. --> -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. Here are the default settings: -- Geode peer-to-peer members are discovered using locators. +- <%=vars.product_name%> peer-to-peer members are discovered using locators. - 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). @@ -36,9 +34,9 @@ However, you may want to change this default configuration. For example, you mig **Note:** You cannot override region attributes on the cache server when using the HTTP Session Management Module. You must place all region attribute definitions in the region attributes template that you customize in your application server. See [Overriding Region Attributes](weblogic_common_configuration_changes.html#weblogic_common_cfg_changes__section_38D803A7E8474188898963F456188543) for more information. -## <a id="weblogic_changing_gf_default_cfg__section_changing_sys_props" class="no-quick-link"></a>Changing Geode Distributed System Properties +## <a id="weblogic_changing_gf_default_cfg__section_changing_sys_props" class="no-quick-link"></a>Changing <%=vars.product_name%> Distributed System Properties -To edit Geode system properties, you must add properties to Geode Session Filter definition in the application's web.xml file. As mentioned previously, this can be done by using the **-p** option to the `modify_war` script. All Geode system properties should be prefixed with the string **gemfire.property**. For example: +To edit <%=vars.product_name%> system properties, you must add properties to <%=vars.product_name%> Session Filter definition in the application's web.xml file. As mentioned previously, this can be done by using the **-p** option to the `modify_war` script. All <%=vars.product_name%> system properties should be prefixed with the string **gemfire.property**. For example: - **-p gemfire.property.locators=hostname\[10334\]** - **-p gemfire.property.cache-xml-file=/u01/weblogic/conf/cache.xml**. @@ -64,19 +62,19 @@ To edit Geode system properties, you must add properties to Geode Session Filter </filter> ``` -This example specifies that the file name for Geode's cache XML configuration is `cache-peer.xml`. +This example specifies that the file name for <%=vars.product_name%>'s cache XML configuration is `cache-peer.xml`. -The list of configurable `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 more common parameters that can be configured. +The list of configurable `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 more common parameters 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 config) | (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 config) | (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 | -In addition to the standard Geode system properties, the following cache-specific properties can also be configured. +In addition to the standard <%=vars.product_name%> system properties, the following cache-specific properties can also be configured. | Parameter | Description | Default | |------------------------|--------------------------------------------------------------------------------------------------|--------------| @@ -84,14 +82,14 @@ 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. 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. For more information about managing the heap, refer to [Managing Heap and Off-heap Memory](../../managing/heap_use/heap_management.html#resource_manager). **Note:** -It is important to note that the Geode Distributed System is a singleton within the entire application server JVM. As such it is important to ensure that different web applications, within the same container, set (or expect) the same cache configuration. When the application server starts, the first web application to start that uses Geode Session Caching will determine the overall configuration of the distributed system since it will trigger the creation of the distributed system. +It is important to note that the <%=vars.product_name%> Distributed System is a singleton within the entire application server JVM. As such it is important to ensure that different web applications, within the same container, set (or expect) the same cache configuration. When the application server starts, the first web application to start that uses <%=vars.product_name%> Session Caching will determine the overall configuration of the distributed system since it will trigger the creation of the distributed system. ## <a id="weblogic_changing_gf_default_cfg__section_changing_cache_config_props" class="no-quick-link"></a>Changing Cache Configuration Properties -To edit Geode cache properties (such as the name and the characteristics of the cache region), you must configure these using a filter initialization parameter prefix of **gemfire.cache** with the `modify_war` script. For example: +To edit <%=vars.product_name%> cache properties (such as the name and the characteristics of the cache region), you must configure these using a filter initialization parameter prefix of **gemfire.cache** with the `modify_war` script. For example: **-p gemfire.cache.region\_name=custom\_sessions** @@ -115,11 +113,11 @@ To edit Geode cache properties (such as the name and the characteristics of the The following parameters are the cache configuration parameters that can be added to the filter definition as initialization parameters. <dt>**enable\_debug\_listener**</dt> -<dd>Whether to enable a debug listener in the session region; if this parameter is set to true, info-level messages are logged to the Geode log when sessions are created, updated, invalidated or expired.</dd> +<dd>Whether to enable a debug listener in the session region; if this parameter is set to true, info-level messages are logged to the <%=vars.product_name%> log when sessions are created, updated, invalidated or expired.</dd> 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 @@ -172,8 +170,8 @@ RegionFactory.create(regionName); Default: delta\_queued -Delta replication can be configured to occur immediately when HttpSession.setAttribute() is called (delta\_immediate) or when the HTTP request has completed processing (delta\_queued). If the latter mode is configured, all attribute updates for a particular request are 'batched' and multiple updates to the same attribute are collapsed. Depending on the number of attributes updates within a given request, delta\_queued may provide a significant performance gain. For complete session attribute integrity across the cache, delta\_immediate is recommended. Note that this option is specific to this module and there is no equivalent Geode API to enable it. +Delta replication can be configured to occur immediately when HttpSession.setAttribute() is called (delta\_immediate) or when the HTTP request has completed processing (delta\_queued). If the latter mode is configured, all attribute updates for a particular request are 'batched' and multiple updates to the same attribute are collapsed. Depending on the number of attributes updates within a given request, delta\_queued may provide a significant performance gain. For complete session attribute integrity across the cache, delta\_immediate is recommended. Note that this option is specific to this module and there is no equivalent <%=vars.product_name%> API to enable it. -- **[Common Geode Configuration Changes for AppServers](weblogic_common_configuration_changes.html)** +- **[Common <%=vars.product_name%> Configuration Changes for AppServers](weblogic_common_configuration_changes.html)**
http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/weblogic_common_configuration_changes.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/weblogic_common_configuration_changes.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/weblogic_common_configuration_changes.html.md.erb index 7669fdd..f44f5b3 100644 --- a/geode-docs/tools_modules/http_session_mgmt/weblogic_common_configuration_changes.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/weblogic_common_configuration_changes.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Common Geode Configuration Changes for AppServers ---- +<% set_title("Common", product_name, "Configuration Changes for AppServers") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erb b/geode-docs/tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erb index e2d9f37..1f12d54 100644 --- a/geode-docs/tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erb +++ b/geode-docs/tools_modules/http_session_mgmt/weblogic_setting_up_the_module.html.md.erb @@ -31,7 +31,7 @@ $ modify_war -h To modify your war or ear file manually, make the following updates: -- **web.xml** needs a filter and listener added as follows. If you have your own filters, the Geode Module filter **must** be the first one. +- **web.xml** needs a filter and listener added as follows. If you have your own filters, the <%=vars.product_name%> Module filter **must** be the first one. ``` pre <filter> @@ -63,7 +63,7 @@ To modify your war or ear file manually, make the following updates: - geode-modules-session jar - slf4j-api jar - slf4j-jdk14 jar -- Add the following jar files from the `$GEODE/lib` directory to the `WEB-INF/lib` directory of the war, where `$GEODE` is set to the Geode product installation: +- Add the following jar files from the `$GEODE/lib` directory to the `WEB-INF/lib` directory of the war, where `$GEODE` is set to the <%=vars.product_name%> product installation: - antlr jar - fastutil jar - geode-core jar @@ -105,7 +105,7 @@ If you are deploying an ear file: <img src="../../images_svg/http_module_p2p_with_locator.svg" id="weblogic_setting_up_the_module__image_86E949E0F1AD4E9EB67605EFA4E97E13" class="image" /> -To run Geode in a peer-to-peer configuration, use the `modify_war` script with options +To run <%=vars.product_name%> in a peer-to-peer configuration, use the `modify_war` script with options `-t peer-to-peer`, `-p gemfire.property.locators=localhost[10334]`, and `-p gemfire.propery.cache-xml-file=<moduleDir>/conf/cache-peer.xml` to result in the following `web.xml` content: @@ -130,9 +130,9 @@ to result in the following `web.xml` content: <img src="../../images_svg/http_module_cs_with_locator.svg" id="weblogic_setting_up_the_module__image_BDF2273487EA4FEB9895D02A6F6FD445" class="image" /> -To run Geode in a client/server configuration, you make the application server operate as a Geode client. Use the `-t client-server` option to the `modify_war` script. This adds the following filter to application server's `web.xml` file: +To run <%=vars.product_name%> in a client/server configuration, you make the application server operate as a <%=vars.product_name%> client. Use the `-t client-server` option to the `modify_war` script. This adds the following filter to application server's `web.xml` file: -To run Geode in a client/server configuration, you make the application server operate as a Geode client. Use the `modify_war` script with options +To run <%=vars.product_name%> in a client/server configuration, you make the application server operate as a <%=vars.product_name%> client. Use the `modify_war` script with options `-t client-server` and `-p gemfire.property.cache-xml-file=<module dir>/conf/cache-client.xml` to result in the following `web.xml` content: @@ -174,15 +174,15 @@ $ gfsh start server \ <moduleDir>/lib/geode-modules-session-internal-1.0.0.jar ``` -Once the application server is started, the Geode client will automatically launch within the application server process. +Once the application server is started, the <%=vars.product_name%> client will automatically launch within the application server process. -## <a id="weblogic_setting_up_the_module__section_3E186713737E4D5383E23B41CDFED59B" class="no-quick-link"></a>Verifying that Geode Started +## <a id="weblogic_setting_up_the_module__section_3E186713737E4D5383E23B41CDFED59B" class="no-quick-link"></a>Verifying that <%=vars.product_name%> Started -You can verify that Geode has successfully started by inspecting the application server log file. For example: +You can verify that <%=vars.product_name%> has successfully started by inspecting the application server log file. For example: ``` pre info 2016/04/18 10:04:18.685 PDT <localhost-startStop-2> tid=0x1a] -Initializing Geode Modules +Initializing <%=vars.product_name%> Modules Java version: 1.0.0 user1 041816 2016-11-18 08:46:17 -0700 javac 1.8.0_92 Native version: native code unavailable @@ -191,7 +191,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.<date>.log`. +Information is also logged within the <%=vars.product_name%> log file, which by default is named `gemfire_modules.<date>.log`. ## <a id="weblogic_setting_up_the_module__section_E0E0E5A1C9484D4AA13878273F16A920" class="no-quick-link"></a>Configuring Non-Sticky Session Replication http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/lucene_integration.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/lucene_integration.html.md.erb b/geode-docs/tools_modules/lucene_integration.html.md.erb index 625d659..9bf65c4 100644 --- a/geode-docs/tools_modules/lucene_integration.html.md.erb +++ b/geode-docs/tools_modules/lucene_integration.html.md.erb @@ -23,8 +23,8 @@ We assume that the reader is familiar with Apache Lucene's indexing and search f The Apache Lucene integration: -- enables users to create Lucene indexes on data stored in Geode -- provides high availability of indexes using Geode's HA capabilities to store the indexes in memory +- enables users to create Lucene indexes on data stored in <%=vars.product_name%> +- provides high availability of indexes using <%=vars.product_name%>'s HA capabilities to store the indexes in memory - optionally stores indexes on disk - updates the indexes asynchronously to minimize impacting write latency - provides scalability by partitioning index data http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb b/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb index 1d791e0..1b5cef0 100644 --- a/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb +++ b/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb @@ -23,7 +23,7 @@ Pulse requires all users to authenticate themselves before they can use the Puls If you run Pulse in embedded mode, the Pulse application runs on the JMX Manager node and no JMX authentication is required. You do not need to specify valid JMX credentials to start an embedded Pulse application. -If you host Pulse on a Web Application server (non-embedded mode) and you configure JMX authentication on the Geode manager node, then the Pulse Web application must authenticate itself with the manager node when it starts. Specify the credentials of a valid JMX user account in the `pulse.properties` file, as described in [Hosting Pulse on a Web Application Server](pulse-hosted.html). +If you host Pulse on a Web Application server (non-embedded mode) and you configure JMX authentication on the <%=vars.product_name%> manager node, then the Pulse Web application must authenticate itself with the manager node when it starts. Specify the credentials of a valid JMX user account in the `pulse.properties` file, as described in [Hosting Pulse on a Web Application Server](pulse-hosted.html). **Note:** The credentials that you specify must have both read and write privileges in the JMX Manager node. See [Configuring a JMX Manager](../../managing/management/jmx_manager_operations.html#topic_263072624B8D4CDBAD18B82E07AA44B6). @@ -34,7 +34,7 @@ You can configure Pulse to use HTTPS in either embedded or non-embedded mode. In non-embedded mode where you are running Pulse on a standalone Web application server, you must use the Web server's SSL configuration to make the HTTP requests secure. -In embedded mode, Geode uses an embedded Jetty server to host the +In embedded mode, <%=vars.product_name%> uses an embedded Jetty server to host the Pulse Web application. To make the embedded server use HTTPS, you must enable the `http` SSL component in `gemfire.properties` or `gfsecurity-properties`. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb b/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb index 955e554..a613296 100644 --- a/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb +++ b/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb @@ -19,15 +19,15 @@ See the License for the specific language governing permissions and limitations under the License. --> -Use Pulse in embedded mode to monitor a Geode deployment directly from a Geode JMX Manager. By +Use Pulse in embedded mode to monitor a <%=vars.product_name%> deployment directly from a <%=vars.product_name%> JMX Manager. By default, the embedded Pulse application connects to the local JMX Manager that hosts the Pulse -application. Optionally, configure Pulse to connect to a Geode system of your choice. +application. Optionally, configure Pulse to connect to a <%=vars.product_name%> system of your choice. To run Pulse in embedded mode: -1. Configure a Geode member to run as a JMX Manager node, specifying the HTTP port on which you +1. Configure a <%=vars.product_name%> member to run as a JMX Manager node, specifying the HTTP port on which you will access the Pulse Web application (port 7070 by default). For example, the following command -starts a Geode locator as a JMX Manager node, using the default HTTP port 7070 for the Pulse +starts a <%=vars.product_name%> locator as a JMX Manager node, using the default HTTP port 7070 for the Pulse application: ``` pre @@ -36,7 +36,7 @@ application: ``` **Note:** - Geode locators become JMX Manager nodes by default. To start a non-locator member as a JMX + <%=vars.product_name%> locators become JMX Manager nodes by default. To start a non-locator member as a JMX Manager node, include the `--J=-Dgemfire.jmx-manager=true` option. To specify a non-default port number for the HTTP service that hosts the Pulse application, include the `--J=-Dgemfire.http-service-port=port_number` option when starting the JMX Manager node. @@ -48,7 +48,7 @@ application: started a manager process earlier, use the `connect` command in `gfsh` to connect to that process. -2. Access the embedded Pulse application from a Web browser. If you are connected to the Geode +2. Access the embedded Pulse application from a Web browser. If you are connected to the <%=vars.product_name%> cluster using gfsh, use the `start pulse` command to load the correct URL in your browser: ``` pre http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb b/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb index 4ce25e9..09cd79d 100644 --- a/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb +++ b/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb @@ -23,11 +23,11 @@ Host Pulse on a dedicated Web application server to make the Pulse application a To host Pulse on a Web application server: -1. Set the `http-service-port` property to zero (`-Dgemfire.http-service-port=0`) when you start your Geode JMX Manager nodes. Setting this property to zero disables the embedded Web server for hosting the Pulse application. +1. Set the `http-service-port` property to zero (`-Dgemfire.http-service-port=0`) when you start your <%=vars.product_name%> JMX Manager nodes. Setting this property to zero disables the embedded Web server for hosting the Pulse application. -2. Deploy the Pulse Web application to your application server. Geode installs the +2. Deploy the Pulse Web application to your application server. <%=vars.product_name%> installs the `geode-pulse-n.n.n.war` file (where `n.n.n` is a version number) in the `tools/Pulse` subdirectory -of your Geode installation directory. Depending on your application server, you may need to copy the +of your <%=vars.product_name%> installation directory. Depending on your application server, you may need to copy the `pulse.war` file to a deployment directory or use a configuration tool to deploy the file. 3. Stop the Web application server and locate the Pulse configuration in the `WEB-INF/classes` subdirectory. @@ -48,17 +48,17 @@ of your Geode installation directory. Depending on your application server, you <tbody> <tr class="odd"> <td><code class="ph codeph">pulse.useLocator</code></td> - <td>Specify "true" to configure Pulse to connect to a Geode Locator member, or "false" to connect directly to a JMX Manager. - <p>When Pulse connects to a Geode locator, the locator provides the address and port of an available JMX Manager to use for monitoring the distributed system. In most production deployments, you should connect Pulse to a locator instance; this allows Pulse to provide monitoring services using any available JMX Manager.</p> + <td>Specify "true" to configure Pulse to connect to a <%=vars.product_name%> Locator member, or "false" to connect directly to a JMX Manager. + <p>When Pulse connects to a <%=vars.product_name%> locator, the locator provides the address and port of an available JMX Manager to use for monitoring the distributed system. In most production deployments, you should connect Pulse to a locator instance; this allows Pulse to provide monitoring services using any available JMX Manager.</p> <p>If you specify "false," Pulse connects directly to a specific JMX Manager. If this manager is not available, the Pulse connection fails, even if another JMX Manager is available in the distributed system.</p></td> </tr> <tr class="even"> <td><code class="ph codeph">pulse.host</code></td> - <td>Specify the DNS name or IP address of the Geode locator or JMX Manager machine to which Pulse should connect. You specify either a locator or JMX Manager address depending on how you configured the <code class="ph codeph">pulse.useLocator</code> property.</td> + <td>Specify the DNS name or IP address of the <%=vars.product_name%> locator or JMX Manager machine to which Pulse should connect. You specify either a locator or JMX Manager address depending on how you configured the <code class="ph codeph">pulse.useLocator</code> property.</td> </tr> <tr class="odd"> <td><code class="ph codeph">pulse.port</code></td> - <td>Specify the port number of the Geode locator or the HTTP port number of the JMX Manager to which Pulse should connect. You specify either a locator or JMX Manager port depending on how you configured the <code class="ph codeph">pulse.useLocator</code> property. + <td>Specify the port number of the <%=vars.product_name%> locator or the HTTP port number of the JMX Manager to which Pulse should connect. You specify either a locator or JMX Manager port depending on how you configured the <code class="ph codeph">pulse.useLocator</code> property. <p>If you configured <code class="ph codeph">pulse.useLocator=false</code>, then <code class="ph codeph">pulse.port</code> must correspond to the <code class="ph codeph">http-service-port</code> setting of the JMX Manager.</p></td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb b/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb index ec723d2..c954c4a 100644 --- a/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb +++ b/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Geode Pulse ---- +<% set_title(product_name, "Pulse") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,11 +17,11 @@ See the License for the specific language governing permissions and limitations under the License. --> -Geode Pulse is a Web Application that provides a graphical dashboard for monitoring vital, real-time health and performance of Geode clusters, members, and regions. +<%=vars.product_name%> Pulse is a Web Application that provides a graphical dashboard for monitoring vital, real-time health and performance of <%=vars.product_name%> clusters, members, and regions. -Use Pulse to examine total memory, CPU, and disk space used by members, uptime statistics, client connections, WAN connections, and critical notifications. Pulse communicates with a Geode JMX manager to provide a complete view of your Geode deployment. You can drill down from a high-level cluster view to examine individual members and even regions within a member, to filter the type of information and level of detail. +Use Pulse to examine total memory, CPU, and disk space used by members, uptime statistics, client connections, WAN connections, and critical notifications. Pulse communicates with a <%=vars.product_name%> JMX manager to provide a complete view of your <%=vars.product_name%> deployment. You can drill down from a high-level cluster view to examine individual members and even regions within a member, to filter the type of information and level of detail. -By default, Geode Pulse runs in an embedded container within a Geode JMX manager node. You can optionally deploy Pulse to a Web application server of your choice, so that the tool runs independently of your Geode clusters. Hosting Pulse on an application server also enables you to use SSL for accessing the application. +By default, <%=vars.product_name%> Pulse runs in an embedded container within a <%=vars.product_name%> JMX manager node. You can optionally deploy Pulse to a Web application server of your choice, so that the tool runs independently of your <%=vars.product_name%> clusters. Hosting Pulse on an application server also enables you to use SSL for accessing the application. - **[Pulse System Requirements](pulse-requirements.html)** @@ -32,7 +30,7 @@ By default, Geode Pulse runs in an embedded container within a Geode JMX manager - **[Running Pulse in Embedded Mode (Quick Start)](pulse-embedded.html)** - Use Pulse in embedded mode to monitor a Geode deployment directly from a Geode JMX Manager. By default, the embedded Pulse application connects to the local JMX Manager that hosts the Pulse application. Optionally, configure Pulse to connect to a Geode system of your choice. + Use Pulse in embedded mode to monitor a <%=vars.product_name%> deployment directly from a <%=vars.product_name%> JMX Manager. By default, the embedded Pulse application connects to the local JMX Manager that hosts the Pulse application. Optionally, configure Pulse to connect to a <%=vars.product_name%> system of your choice. - **[Hosting Pulse on a Web Application Server](pulse-hosted.html)** @@ -40,10 +38,10 @@ By default, Geode Pulse runs in an embedded container within a Geode JMX manager - **[Configuring Pulse Authentication](pulse-auth.html)** - Pulse requires all users to authenticate themselves before they can use the Pulse Web application. If you have configured JMX authentication on the Geode JMX Manager node, the Pulse Web application itself may also need to authenticate itself to the Geode JMX Manager node on startup. + Pulse requires all users to authenticate themselves before they can use the Pulse Web application. If you have configured JMX authentication on the <%=vars.product_name%> JMX Manager node, the Pulse Web application itself may also need to authenticate itself to the <%=vars.product_name%> JMX Manager node on startup. - **[Using Pulse Views](pulse-views.html)** - Pulse provides a variety of different views to help you monitor Geode clusters, members, and regions. + Pulse provides a variety of different views to help you monitor <%=vars.product_name%> clusters, members, and regions. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/pulse/pulse-views.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-views.html.md.erb b/geode-docs/tools_modules/pulse/pulse-views.html.md.erb index d3bb367..017a749 100644 --- a/geode-docs/tools_modules/pulse/pulse-views.html.md.erb +++ b/geode-docs/tools_modules/pulse/pulse-views.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -Pulse provides a variety of different views to help you monitor Geode clusters, members, and regions. +Pulse provides a variety of different views to help you monitor <%=vars.product_name%> clusters, members, and regions. The following sections provide an overview of the main Pulse views: @@ -31,25 +31,25 @@ The following sections provide an overview of the main Pulse views: # <a id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_9794B5754E474E10ABFBCD8B1DA240F8" class="no-quick-link"></a>Cluster View -The cluster view is a high-level overview of the Geode distributed system. It is displayed immediately after you log into Pulse. Information displays around the perimeter of the cluster view show statistics such as memory usage, JVM pauses, and throughput. You can use the cluster view to drill down into details for individual members and regions in the distributed system. +The cluster view is a high-level overview of the <%=vars.product_name%> distributed system. It is displayed immediately after you log into Pulse. Information displays around the perimeter of the cluster view show statistics such as memory usage, JVM pauses, and throughput. You can use the cluster view to drill down into details for individual members and regions in the distributed system. <img src="../../images/pulse_cluster_view.png" id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__image_CC7B54903DF24030850E55965CDB6EC4" class="image imageleft" width="624" /> Use these basic controls while in Cluster view: -1. Click Members or Data to display information about Geode members or data regions in the distributed system. -2. Click the display icons to display the Geode members using icon view, block view, or table view. Note that icon view is available only when displaying Members. +1. Click Members or Data to display information about <%=vars.product_name%> members or data regions in the distributed system. +2. Click the display icons to display the <%=vars.product_name%> members using icon view, block view, or table view. Note that icon view is available only when displaying Members. - For example, the following shows Geode Members displayed in table view: + For example, the following shows <%=vars.product_name%> Members displayed in table view: <img src="../../images/member_view_list.png" id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__image_npw_sq3_wn" class="image" /> - - While in block view or table view, click the name of a Geode member to display additional information in the [Member View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_3629814A3DF64D31A190495782DB0DBF). + - While in block view or table view, click the name of a <%=vars.product_name%> member to display additional information in the [Member View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_3629814A3DF64D31A190495782DB0DBF). - Click Topology, Server Groups, or Redundancy Zones to filter the view based on all members in the topology, configured server groups, or configured redundancy zones. - The following shows Geode Regions displayed in table view: + The following shows <%=vars.product_name%> Regions displayed in table view: <img src="../../images/pulse-region-detail.png" id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__image_glp_1jr_54" class="image" /> - - While in block view or table view, click the name of a Geode region to display additional information in the [Region View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_D151776BAC8B4704A71F37F8B5CE063D). + - While in block view or table view, click the name of a <%=vars.product_name%> region to display additional information in the [Region View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_D151776BAC8B4704A71F37F8B5CE063D). -3. While in icon view, click a host machine icon to display the Geode members on that machine. +3. While in icon view, click a host machine icon to display the <%=vars.product_name%> members on that machine. 4. In the Alerts pane, click the severity tabs to filter the message display by the level of severity. **Cluster View Screen Components** @@ -128,8 +128,8 @@ The following table describes the data pieces displayed on the Cluster View scre <td>Host Machine</td> <td>When you mouse over a machine icon in Topology View, a pop-up appears with the following machine statistics: <ul> -<li><em>CPU Usage</em>. Percentage of CPU being used by Geode processes on the machine.</li> -<li><em>Memory Usage</em>. Amount of memory (in MB) being used by Geode processes.</li> +<li><em>CPU Usage</em>. Percentage of CPU being used by <%=vars.product_name%> processes on the machine.</li> +<li><em>Memory Usage</em>. Amount of memory (in MB) being used by <%=vars.product_name%> processes.</li> <li><em>Load Avg</em>. Average number of threads on the host machine that are in the run queue or are waiting for disk I/O over the last minutes. Corresponds to the Linux System statistic loadAverage1. If the load average is not available, a negative value is shown.</li> <li><em>Sockets</em>. Number of sockets currently open on the machine.</li> </ul></td> @@ -138,14 +138,14 @@ The following table describes the data pieces displayed on the Cluster View scre <td>Member</td> <td>When you mouse over a member icon in Graphical View, a pop-up appears with the following member statistics: <ul> -<li><em>CPU Usage</em>. Percentage of CPU being used by the Geode member process.</li> +<li><em>CPU Usage</em>. Percentage of CPU being used by the <%=vars.product_name%> member process.</li> <li><em>Threads</em>. Number of threads running on the member.</li> <li><em>JVM Pauses</em>. Number of times the JVM used by the member process has paused due to garbage collection or excessive CPU usage.</li> <li><em>Regions</em>. Number of regions hosted on the member process.</li> <li><em>Clients</em>. Number of client currently connected to the member process.</li> <li><em>Gateway Sender</em>. Number of gateway senders configured on the member.</li> <li><em>Port</em>. Server port of the cache server member where clients can connect and perform cache operations.</li> -<li><em>GemFire Version</em>. The version of the Geode member.</li> +<li><em>GemFire Version</em>. The version of the <%=vars.product_name%> member.</li> </ul></td> </tr> <tr class="odd"> @@ -156,7 +156,7 @@ The following table describes the data pieces displayed on the Cluster View scre <li><em>Name</em>. Name of the member.</li> <li><em>Host</em>. Hostname or IP address where the member is running.</li> <li><em>Heap Usage</em>. Amount of JVM heap memory being used by the member process.</li> -<li><em>CPU Usage</em>. Percentage of CPU being used by the Geode member process.</li> +<li><em>CPU Usage</em>. Percentage of CPU being used by the <%=vars.product_name%> member process.</li> <li><em>Uptime</em>. How long the member has been up and running.</li> <li><em>Clients</em>. Number of clients currently connected to the member. It will have a value only if the member acts as a CacheServer.</li> </ul></td> @@ -198,7 +198,7 @@ The following table describes the data pieces displayed on the Cluster View scre # <a id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_3629814A3DF64D31A190495782DB0DBF" class="no-quick-link"></a>Member View -When you select an individual Geode member in Cluster View, Pulse displays the regions available on that member, as well as member-specific information such as the configured listen ports. +When you select an individual <%=vars.product_name%> member in Cluster View, Pulse displays the regions available on that member, as well as member-specific information such as the configured listen ports. <img src="../../images/pulse_member_view.png" id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__image_EDBD3D333B2741DCAA5CB94719B507B7" class="image imageleft" width="624" /> @@ -330,7 +330,7 @@ The following table describes the data elements displayed on the Member View scr # <a id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_D151776BAC8B4704A71F37F8B5CE063D" class="no-quick-link"></a>Region View -The Pulse Region View provides a comprehensive overview of all regions in the Geode distributed system: +The Pulse Region View provides a comprehensive overview of all regions in the <%=vars.product_name%> distributed system: <img src="../../images/pulse_data_view.png" id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__image_A533852E38654E79BE5628E938E170EB" class="image imageleft" width="624" /> @@ -362,13 +362,13 @@ The following table describes the data elements displayed on the Region View scr <tbody> <tr class="odd"> <td><strong>Region Members</strong></td> -<td>Lists information about Geode members that host the region, either in block view or table view.</td> +<td>Lists information about <%=vars.product_name%> members that host the region, either in block view or table view.</td> </tr> <tr class="even"> <td>Region Member (Detail View)</td> <td>When you hover over a region member in block view, a pop-up appears with the following data fields: <ul> -<li><em>Member Name</em>. The name of the Geode member hosting the region.</li> +<li><em>Member Name</em>. The name of the <%=vars.product_name%> member hosting the region.</li> <li><em>EntryCount</em>. Number of entries for the region on that member.</li> <li><em>EntrySize</em>. The aggregate entry size (in bytes) of all entries on that member. For replicated regions this field will only provide a value if the eviction algorithm has been set to EvictionAlgorithm#LRU_ MEMORY. All partition regions will have this value. However, the value includes redundant entries and will also count the size of all the secondary entries on the node.</li> <li><em>Accessor</em>. Indicates whether the member is an accessor member.</li> @@ -409,7 +409,7 @@ The following table describes the data elements displayed on the Region View scr # <a id="topic_F0ECE9E8179541CCA3D6C5F4FBA84404__sec_pulsedatabrowser" class="no-quick-link"></a>Data Browser -The Pulse Data Browser enables you to query region data. Note that there are two key attributes available on DistributedSystemMXBean (see [List of Geode JMX MBeans](../../managing/management/list_of_mbeans.html#topic_4BCF867697C3456D96066BAD7F39FC8B)) that you can use to configure limits for the result sets displayed in Data Browser: +The Pulse Data Browser enables you to query region data. Note that there are two key attributes available on DistributedSystemMXBean (see [List of <%=vars.product_name%> JMX MBeans](../../managing/management/list_of_mbeans.html#topic_4BCF867697C3456D96066BAD7F39FC8B)) that you can use to configure limits for the result sets displayed in Data Browser: - `QueryResultSetLimit` limits the number of rows that Data Browser queries return. 1000 rows are displayed by default. - `QueryCollectionsDepth` limits the number of elements of a collection that Data Browser queries return. This attribute applies to query results contain collections such as Map, List, and so forth. The default value is 100 elements. @@ -423,7 +423,7 @@ The following shows an example Data Browser view: Use these basic controls while in Data Browser view: 1. Search for the name of a specific region. -2. Select one or more regions to display the Geode members that host those regions. The hosting Geode members appear in the Region Members section. +2. Select one or more regions to display the <%=vars.product_name%> members that host those regions. The hosting <%=vars.product_name%> members appear in the Region Members section. 3. Select one or more members from the Region Members section to restrict query results to those members. 4. Type in the text of a query to execute. See [Querying](../../developing/querying_basics/chapter_overview.html). 5. Display a list of previously-executed queries. Double-click on a query from the history list to copy it to the Query Editor, or delete the query from your history. http://git-wip-us.apache.org/repos/asf/geode/blob/bb988caa/geode-docs/tools_modules/redis_adapter.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/redis_adapter.html.md.erb b/geode-docs/tools_modules/redis_adapter.html.md.erb index 697fc4e..82f9ed5 100644 --- a/geode-docs/tools_modules/redis_adapter.html.md.erb +++ b/geode-docs/tools_modules/redis_adapter.html.md.erb @@ -19,13 +19,13 @@ See the License for the specific language governing permissions and limitations under the License. --> -The Geode Redis adapter allows Geode to function as a drop-in replacement for a Redis data store, letting Redis applications take advantage of Geodeâs scaling capabilities without changing their client code. Redis clients connect to a Geode server in the same way they connect to a Redis server, using an IP address and a port number. +The <%=vars.product_name%> Redis adapter allows <%=vars.product_name%> to function as a drop-in replacement for a Redis data store, letting Redis applications take advantage of <%=vars.product_name%>âs scaling capabilities without changing their client code. Redis clients connect to a <%=vars.product_name%> server in the same way they connect to a Redis server, using an IP address and a port number. - **[Using the Redis Adapter](#using-the-redis-adapter)** - **[How the Redis Adapter Works](#how-the-redis-adapter-works)** -- **[Advantages of Geode over a Redis Server](#advantages-of-geode-over-redis)** +- **[Advantages of <%=vars.product_name%> over a Redis Server](#advantages-of-geode-over-redis)** ## <a id="using-the-redis-adapter" class="no-quick-link"></a>Using the Redis Adapter @@ -33,17 +33,17 @@ To use the Redis Adapter, you will need three pieces of information: 1. The port number through which clients will communicate 2. The IP address of the host where the server is to reside -3. A choice of which attributes you will use for a Geode partitioned region +3. A choice of which attributes you will use for a <%=vars.product_name%> partitioned region The IP address and port number should be the same ones coded in the Redis clients. -In order to take advantage of Geodeâs scaling capabilities, you should specify the Geode region as one of the types that use the PARTITION data policy. PARTITION is the default. Other possibilities include PARTITION\_REDUNDANT and PARTITION\_PERSISTENT. (See [âRegion Shortcuts Quick Referenceâ](../reference/topics/region_shortcuts_table.html) for a complete list.) +In order to take advantage of <%=vars.product_name%>âs scaling capabilities, you should specify the <%=vars.product_name%> region as one of the types that use the PARTITION data policy. PARTITION is the default. Other possibilities include PARTITION\_REDUNDANT and PARTITION\_PERSISTENT. (See [âRegion Shortcuts Quick Referenceâ](../reference/topics/region_shortcuts_table.html) for a complete list.) -To implement a Geode instance using the Redis Adapter: +To implement a <%=vars.product_name%> instance using the Redis Adapter: -1. Install Geode on the system where the server is to reside. -2. Use gfsh to start a Geode server, specifying the three configuration options described above: - - Use `--redis-port` to specify the port. This parameter is required -- the Geode server will listen on this port for Redis commands. +1. Install <%=vars.product_name%> on the system where the server is to reside. +2. Use gfsh to start a <%=vars.product_name%> server, specifying the three configuration options described above: + - Use `--redis-port` to specify the port. This parameter is required -- the <%=vars.product_name%> server will listen on this port for Redis commands. - Use `--redis-bind-address` to specify the IP address of the server host. This parameter is optional. If not specified, the default is determined from the /etc/hosts file. - Use `--J=-Dgemfireredis.regiontype` to specify the region type. This parameter is optional. If not specified, regiontype is set to PARTITION. @@ -58,7 +58,7 @@ Redis clients can then connect to the server at localhost:11211. ## <a id="how-the-redis-adapter-works" class="no-quick-link"></a>How the Redis Adapter Works -The Geode Redis Adapter supports all Redis data structures, including +The <%=vars.product_name%> Redis Adapter supports all Redis data structures, including - String - List @@ -67,22 +67,22 @@ The Geode Redis Adapter supports all Redis data structures, including - SortedSet - HyperLogLog -In Geode these data structures are implemented using partitioned regions. In most cases, Geode allocates one partitioned region for each data structure. For example, each Sorted Set is allocated its own partitioned region, in which the key is the user data and the value is the user-provided score, and entries are indexed by score. The two exceptions to this design are data types String and HyperLogLog. All Strings are allocated to a single partitioned region. Similarly, all HyperLogLogs are allocated to a single region. Regions use Geodeâs OQL and indexes. +In <%=vars.product_name%> these data structures are implemented using partitioned regions. In most cases, <%=vars.product_name%> allocates one partitioned region for each data structure. For example, each Sorted Set is allocated its own partitioned region, in which the key is the user data and the value is the user-provided score, and entries are indexed by score. The two exceptions to this design are data types String and HyperLogLog. All Strings are allocated to a single partitioned region. Similarly, all HyperLogLogs are allocated to a single region. Regions use <%=vars.product_name%>âs OQL and indexes. -The Geode Redis Adapter supports all Redis commands for each of the Redis data structures. (See the Javadocs for the GemFireRedisServer class for a detailed list.) The Geode serverâs responses to Redis commands are identical to those of a Redis server with the following exceptions, resulting from Geodeâs more extensive partitioning model: +The <%=vars.product_name%> Redis Adapter supports all Redis commands for each of the Redis data structures. (See the Javadocs for the GemFireRedisServer class for a detailed list.) The <%=vars.product_name%> serverâs responses to Redis commands are identical to those of a Redis server with the following exceptions, resulting from <%=vars.product_name%>âs more extensive partitioning model: - Any command that removes keys and returns a count of removed entries will return a count of how many entries have been removed from the local vm, rather than a total count of items removed across all members. However, all entries will be removed. - Any command that returns a count of newly set members has an unspecified return value. The command will work just as the Redis protocol states, but the count will not necessarily reflect the number set compared to the number overridden. -- Transactions work just as they would on a Redis instance; they are local transactions. Transactions cannot be executed on data that is not local to the executing server, that is on a partitioned region in a different server instance, or that is on a persistent region that does not have transactions enabled. Also, you cannot watch or unwatch keys, as all keys within a Geode transaction are watched by default. +- Transactions work just as they would on a Redis instance; they are local transactions. Transactions cannot be executed on data that is not local to the executing server, that is on a partitioned region in a different server instance, or that is on a persistent region that does not have transactions enabled. Also, you cannot watch or unwatch keys, as all keys within a <%=vars.product_name%> transaction are watched by default. -## <a id="advantages-of-geode-over-redis" class="no-quick-link"></a>Advantages of Geode over a Redis Server +## <a id="advantages-of-geode-over-redis" class="no-quick-link"></a>Advantages of <%=vars.product_name%> over a Redis Server -Geodeâs primary advantage is its **scalability**. While the Redis server is single threaded, Geode supports high concurrency. Many Redis clients can execute commands on the Geode server simultaneously. +<%=vars.product_name%>âs primary advantage is its **scalability**. While the Redis server is single threaded, <%=vars.product_name%> supports high concurrency. Many Redis clients can execute commands on the <%=vars.product_name%> server simultaneously. -Geode supports **stored procedures**, which can execute on the server and report results to the requesting client. +<%=vars.product_name%> supports **stored procedures**, which can execute on the server and report results to the requesting client. -Geode architecture and management features help detect and resolve **network partitioning** problems without explicit management on the part of the Redis client. +<%=vars.product_name%> architecture and management features help detect and resolve **network partitioning** problems without explicit management on the part of the Redis client. -Geode **WAN replication** allows the data store to expand horizontally, across physically distant sites, while maintaining data consistency. +<%=vars.product_name%> **WAN replication** allows the data store to expand horizontally, across physically distant sites, while maintaining data consistency.
