Installing Session State Caching Powered by GemFire


Before you begin your Session State Caching Powered by GemFire deployment, your system needs to meet the following minimum requirements:

  • Pivotal Cloud Foundry® (PCF) Ops Manager for vSphere, or
    Pivotal Cloud Foundry® Ops Manager for vCloud Air or vCloud Director, or
    Pivotal Cloud Foundry® Ops Manager for AWS

  • Pivotal Cloud Foundry® Elastic Runtime

  • Network access and credentials for the Pivotal Cloud Foundry® Ops Manager Web Console

  • Capacity in the vSphere cluster for service instances you want to deploy. Each instance the Session State Caching service deploys a minimum of two GemFire locator and three GemFire cache server VMs, as well as several supporting VMs. The default instance has the following requirements:

Table 1. Default Resource Requirements for a Session State Caching Service Instance
Service Virtual Machines CPU\* RAM (MB)\* Ephemeral Disk (MB)\* Persistent Disk (MB)\*
SSC GemFire Locator 2 1 2048 2048 512
SSC GemFire Server 3 1 4096 6144 8192
SSC GemFire Broker 1 2 4096 4096 4096
Broker Registrar 1 1 2048 2048 0
Broker Deregistrar 1 1 2048 2048 0
Cluster Smoke Test 1 1 512 2048 0
Service Offering Smoke Test 1 1 512 2048 0
Compilation 2 1 1024 4096 0
**Totals** **12** **9** **16384** **24576** **12800**

*Required for each VM


The Session State Caching Powered by GemFire for Pivotal Cloud Foundry® service does not support multiple availability zones. You must configure the service to place singleton jobs and to balance other jobs in the same availability zone.

Session State Caching > Settings > Assign Availability Zones


If you are using a self-signed SSL certificate, or a certificate signed by an internal (or not well-known) certificate authority (CA), you must add the certificate, or certificate chain, to the “Trusted Certificates” in Ops Manager.

Support for HTTPS Traffic Only

The service supports disabling HTTP for all the incoming traffic to HAProxy and UAA.

Service Configuration Defaults

The Session State Caching Powered by GemFire service is intended for use with production-level workloads. When you create a service instance, Pivotal Cloud Foundry® automatically implements the best practices an operator would normally employ when deploying GemFire. These configurations include:

  • Dynamic memory management. Dynamically set maximum and minimum memory utilization for each instance of the GemFire software process to the VM’s total memory (minus 128MB, which is reserved for the Operating System.)

  • Garbage collection. Enable memory garbage collection for each instance of the GemFire software process.

  • Logging configuration. Create and store logs at the config log level with appropriate limitations on sizing and automatic log rotation.

  • Statistics monitoring. Create and store statistics files at a sample rate of 1,000, which corresponds to a sampling rate of once per second.

  • Data overflow configuration. Overflow data to disk when crossing 70% memory utilization.

  • Memory overutilization protection. Prevent further writes to memory when crossing 80% memory utilization.

  • Client authentication. Require clients to authenticate when directly accessing cache servers.

Installation Steps

  1. Download the GemFire Service 1.0 software binary from The Pivotal Network.

  2. Use a Web browser to log in to the Pivotal Ops Manager application. The Pivotal Cloud Foundry® Ops Manager Installation Dashboard displays.

  3. Click Import a Product.

    The Add Products screen displays.

  4. Click Choose File and navigate to the file you downloaded.

    The file uploads to your Pivotal Cloud Foundry® deployment.

  5. Click Add.

    Pivotal Ops Manager adds a new tile for Session State Caching Powered by GemFire to the Installation Dashboard.

    Session State Caching Service Tile

Creating a Session State Caching Powered by GemFire Service Plan

Configure one or more Session State Caching instances to set the maximum capacity for Session State Caching services in your Cloud Foundry environment.

Note: If you have already configured the service, reducing the the number of resources and reconfiguring the service causes all allocated instances to be destroyed. See the Release Notes for more information about known problems and limitations.

Follow these steps to configure the GemFire service:

  1. Select the Session State Caching Powered by GemFire tile to display the configuration page.

  2. (Optional) Select the Assign Networks tab to specify the vSphere Network where Ops Manager deploys the SSC GemFire Service Broker and related virtual machines. See Configuring Network Isolation Options in Ops Manager in the Pivotal Cloud Foundry® documentation for more information.

  3. (Optional) Select Assign Availability Zones to specify the Availability Zone into which Ops Manager should deploy the SSC GemFire Service Broker and virtual machines. See Configuring Ops Manager Director for VMware vSphere for more information.

    Note: The current version of the service only supports deployment to one Availability Zone. For this release, we do not recommend modifying the default configuration setting.

  4. (Optional) Select the Configure Service Plan tab to configure information that is displayed about this instance in the Elastic Runtime CLI and Web Console. The Service Plan Name, Description, and Feature Bullets can be used as needed to describe the service.

  5. (Optional) Select the Resource Config tab to change the configuration of GemFire members in the deployed service instance:

    Session State Caching Service Resource Config

    1. Enter the total number of SSC GemFire Locator and SSC GemFire Server VM instances that you want to deploy.

      For example, if you need to support a maximum of two (2) developer applications, two (2) staging applications, and one (1) production application, you would need to configure at least five (5) instances of Session State Caching to support all applications running simultaneously. Because each Session State Caching instance creates a GemFire cluster of two GemFire locators and three GemFire servers, you would need to configure a total of 10 SSC GemFire Locators and 15 SSC GemFire Servers in this environment.

      Note: You must maintain a ratio of two locator VMs to three cache server VMs. Each set of two locators and three servers forms a separate GemFire cluster. Setting the values to any other ratio will cause the deployment will fail.

    2. Enter the number of CPUs, amount of RAM, Ephemeral Disk Space, and Persistent Disk space to allocate for each server VM based on your capacity requirements, or accept the default. For production deployments, we recommend increasing the number of CPUs to at least 2.

  6. Click Save.

  7. Click the Installation Dashboard link.

    The Installation Dashboard screen displays.

  8. Click Apply Changes.

    Pivotal Cloud Foundry® Ops Manager deploys a single virtual machine to run the SSC GemFire Service Broker, and one or more additional VMs to run the GemFire locators and servers. A progress meter displays the progress of the installation. You can also access information about the deployments from the Pivotal Cloud Foundry® Ops Manager console.

    After the Session State Caching instances are deployed, the SSC GemFire Service Broker automatically registers the service and its service plan in the Elastic Runtime Marketplace. Pivotal Cloud Foundry® users can then create and bind to instances of the configured service plans. See Using the Pivotal GemFire Service on Pivotal Cloud Foundry®.

Create a pull request or raise an issue on the source for this page in GitHub