Skip to content

Commit 1ae6782

Browse files
author
Christopher Frost
committed
Document the GemFire session replication support
This commit adds documentation about the new support for GemFire based session replication. [#87648402]
1 parent 4a9570a commit 1ae6782

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

docs/container-tomcat.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,25 @@ The container can be configured by modifying the [`config/tomcat.yml`][] file in
2121

2222
| Name | Description
2323
| ---- | -----------
24+
| `access_logging_support.repository_root` | The URL of the Tomcat Access Logging Support repository index ([details][repositories]).
25+
| `access_logging_support.version` | The version of Tomcat Access Logging Support to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/tomcat-access-logging-support/index.yml).
26+
| `access_logging_support.access_logging` | Set to `enabled` to turn on the access logging support. Default is `disabled`.
27+
| `gemfire_store.gemfire.repository_root` | The URL of the GemFire repository index ([details][repositories]).
28+
| `gemfire_store.gemfire.version` | The version of GemFire to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/gem-fire/index.yml).
29+
| `gemfire_store.gemfire_logging.repository_root` | The URL of the GemFire Logging repository index ([details][repositories]).
30+
| `gemfire_store.gemfire_logging.version` | The version of GemFire Logging to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/slf4j-jdk14/index.yml).
31+
| `gemfire_store.gemfire_logging_api.repository_root` | The URL of the GemFire Logging API repository index ([details][repositories]).
32+
| `gemfire_store.gemfire_logging_api.version` | The version of GemFire Logging API to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/slf4j-api/index.yml).
33+
| `gemfire_store.gemfire_modules.repository_root` | The URL of the GemFire Modules repository index ([details][repositories]).
34+
| `gemfire_store.gemfire_modules.version` | The version of GemFire Modules to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/gem-fire-modules/index.yml).
35+
| `gemfire_store.gemfire_modules_tomcat7.repository_root` | The URL of the GemFire Modules Tomcat 7 repository index ([details][repositories]).
36+
| `gemfire_store.gemfire_modules_tomcat7.version` | The version of GemFire Modules Tomcat 7 to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/gem-fire-modules-tomcat7/index.yml).
37+
| `gemfire_store.gemfire_security.repository_root` | The URL of the GemFire Security repository index ([details][repositories]).
38+
| `gemfire_store.gemfire_security.version` | The version of GemFire Security to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/gem-fire-security/index.yml).
2439
| `lifecycle_support.repository_root` | The URL of the Tomcat Lifecycle Support repository index ([details][repositories]).
2540
| `lifecycle_support.version` | The version of Tomcat Lifecycle Support to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/tomcat-lifecycle-support/index.yml).
2641
| `logging_support.repository_root` | The URL of the Tomcat Logging Support repository index ([details][repositories]).
2742
| `logging_support.version` | The version of Tomcat Logging Support to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/tomcat-logging-support/index.yml).
28-
| `access_logging_support.repository_root` | The URL of the Tomcat Access Logging Support repository index ([details][repositories]).
29-
| `access_logging_support.version` | The version of Tomcat Access Logging Support to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/tomcat-access-logging-support/index.yml).
30-
| `access_logging_support.access_logging` | Set to `enabled` to turn on the access logging support. Default is `disabled`.
3143
| `redis_store.connection_pool_size` | The Redis connection pool size. Note that this is per-instance, not per-application.
3244
| `redis_store.database` | The Redis database to connect to.
3345
| `redis_store.repository_root` | The URL of the Redis Store repository index ([details][repositories]).
@@ -40,17 +52,20 @@ The container can be configured by modifying the [`config/tomcat.yml`][] file in
4052
The container can also be configured by overlaying a set of resources on the default distribution. To do this, add files to the `resources/tomcat` directory in the buildpack fork. For example, to override the default `logging.properties` add your custom file to `resources/tomcat/conf/logging.properties`.
4153

4254
## Session Replication
43-
By default, the Tomcat instance is configured to store all Sessions and their data in memory. Under certain cirmcumstances it my be appropriate to persist the Sessions and their data to a repository. When this is the case (small amounts of data that should survive the failure of any individual instance), the buildpack can automatically configure Tomcat to do so.
55+
By default, the Tomcat instance is configured to store all Sessions and their data in memory. Under certain cirmcumstances it my be appropriate to persist the Sessions and their data to a repository. When this is the case (small amounts of data that should survive the failure of any individual instance), the buildpack can automatically configure Tomcat to do so by binding an appropriate service.
4456

4557
### Redis
4658
To enable Redis-based session replication, simply bind a Redis service containing a name, label, or tag that has `session-replication` as a substring.
4759

60+
### GemFire
61+
To enable GemFire-based session replication, simply bind a [GemFire service][] containing a name, label, or tag that has `session_replication` as a substring. GemFire services intended to be used for session replication will automatically have a tag of 'session_replication'.
4862

4963
## Supporting Functionality
5064
Additional supporting functionality can be found in the [`java-buildpack-support`][] Git repository.
5165

5266
[Configuration and Extension]: ../README.md#configuration-and-extension
5367
[`config/tomcat.yml`]: ../config/tomcat.yml
68+
[GemFire Service]: https://network.pivotal.io/products/p-gemfire
5469
[`java-buildpack-support`]: https://github.com/cloudfoundry/java-buildpack-support
5570
[repositories]: extending-repositories.md
5671
[Spring profiles]:http://blog.springsource.com/2011/02/14/spring-3-1-m1-introducing-profile/

0 commit comments

Comments
 (0)