Skip to content

Commit 486f8aa

Browse files
author
Christopher Frost
committed
Document tier_name and list all config in alphabetical order
The tier_name the application should apear under in the AppDynamics dashboard was not documented. This commit fixes that and also ensures all config options are listed in alphabetical order in the AppDynamics documentation as well as other documentation. [#72500698]
1 parent 326ade4 commit 486f8aa

7 files changed

Lines changed: 15 additions & 14 deletions

docs/container-tomcat.md

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

2222
| Name | Description
2323
| ---- | -----------
24-
| `tomcat.repository_root` | The URL of the Tomcat repository index ([details][repositories]).
25-
| `tomcat.version` | The version of Tomcat to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/tomcat/index.yml).
2624
| `lifecycle_support.repository_root` | The URL of the Tomcat Lifecycle Support repository index ([details][repositories]).
2725
| `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).
2826
| `logging_support.repository_root` | The URL of the Tomcat Logging Support repository index ([details][repositories]).
2927
| `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).
30-
| `redis_store.repository_root` | The URL of the Redis Store repository index ([details][repositories]).
31-
| `redis_store.version` | The version of Redis Store to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/redis-store/index.yml).
28+
| `redis_store.connection_pool_size` | The Redis connection pool size. Note that this is per-instance, not per-application.
3229
| `redis_store.database` | The Redis database to connect to.
30+
| `redis_store.repository_root` | The URL of the Redis Store repository index ([details][repositories]).
3331
| `redis_store.timeout` | The Redis connection timeout (in milliseconds).
34-
| `redis_store.connection_pool_size` | The Redis connection pool size. Note that this is per-instance, not per-application.
32+
| `redis_store.version` | The version of Redis Store to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/redis-store/index.yml).
33+
| `tomcat.repository_root` | The URL of the Tomcat repository index ([details][repositories]).
34+
| `tomcat.version` | The version of Tomcat to use. Candidate versions can be found in [this listing](http://download.pivotal.io.s3.amazonaws.com/tomcat/index.yml).
3535

3636
### Additional Resources
3737
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`.

docs/framework-app_dynamics_agent.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ The framework can be configured by modifying the [`config/app_dynamics_agent.yml
3131
| Name | Description
3232
| ---- | -----------
3333
| `repository_root` | The URL of the AppDynamics repository index ([details][repositories]).
34+
| `tier_name` | The tier_name for this application in the AppDynamics dashboard.
3435
| `version` | The version of AppDynamics to use. Candidate versions can be found in [this listing][].
3536

3637
### Additional Resources

docs/framework-play_framework_auto_reconfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ The framework can be configured by modifying the [`config/play_framework_auto_re
2121

2222
| Name | Description
2323
| ---- | -----------
24+
| `enabled` | Whether to attempt auto-reconfiguration
2425
| `repository_root` | The URL of the Auto-reconfiguration repository index ([details][repositories]).
2526
| `version` | The version of Auto-reconfiguration to use. Candidate versions can be found in [this listing][].
26-
| `enabled` | Whether to attempt auto-reconfiguration
2727

2828
[Configuration and Extension]: ../README.md#configuration-and-extension
2929
[`config/play_framework_auto_reconfiguration.yml`]: ../config/config/play_framework_auto_reconfiguration.yml

docs/framework-play_framework_jpa_plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The framework can be configured by modifying the [`config/play_framework_jpa_plu
2525

2626
| Name | Description
2727
| ---- | -----------
28+
| `enabled` | Whether to attempt reconfiguration
2829
| `repository_root` | The URL of the Play Framework JPA Plugin repository index ([details][repositories]).
2930
| `version` | The version of the Play Framework JPA Plugin to use. Candidate versions can be found in [this listing][].
30-
| `enabled` | Whether to attempt reconfiguration
3131

3232
[Configuration and Extension]: ../README.md#configuration-and-extension
3333
[`config/play_framework_jpa_plugin.yml`]: ../config/play_framework_jpa_plugin.yml

docs/framework-spring_auto_reconfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ The framework can be configured by modifying the [`config/spring_auto_reconfigur
2222

2323
| Name | Description
2424
| ---- | -----------
25+
| `enabled` | Whether to attempt auto-reconfiguration
2526
| `repository_root` | The URL of the Auto-reconfiguration repository index ([details][repositories]).
2627
| `version` | The version of Auto-reconfiguration to use. Candidate versions can be found in [this listing][].
27-
| `enabled` | Whether to attempt auto-reconfiguration
2828

2929
[Configuration and Extension]: ../README.md#configuration-and-extension
3030
[`config/spring_auto_reconfiguration.yml`]: ../config/spring_auto_reconfiguration.yml

docs/jre-open_jdk_jre.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ The JRE can be configured by modifying the [`config/open_jdk_jre.yml`][] file in
2020

2121
| Name | Description
2222
| ---- | -----------
23-
| `repository_root` | The URL of the OpenJDK repository index ([details][repositories]).
24-
| `version` | The version of Java runtime to use. Candidate versions can be found in the listings for [centos6][], [lucid][], [mountainlion][], and [precise][]. Note: version 1.8.0 and higher require the `memory_sizes` and `memory_heuristics` mappings to specify `metaspace` rather than `permgen`.
2523
| `memory_sizes` | Optional memory sizes, described below under "Memory Sizes".
2624
| `memory_heuristics` | Default memory size weightings, described below under "Memory Weightings.
25+
| `repository_root` | The URL of the OpenJDK repository index ([details][repositories]).
26+
| `version` | The version of Java runtime to use. Candidate versions can be found in the listings for [centos6][], [lucid][], [mountainlion][], and [precise][]. Note: version 1.8.0 and higher require the `memory_sizes` and `memory_heuristics` mappings to specify `metaspace` rather than `permgen`.
2727

2828
### Additional Resources
2929
The JRE can also be configured by overlaying a set of resources on the default distribution. To do this, add files to the `resources/open_jdk_jre` directory in the buildpack fork. For example, to add the JCE Unlimited Strength `local_policy.jar` add your file to `resources/open_jdk_jre/lib/security/local_policy.jar`.
@@ -40,9 +40,9 @@ The following optional properties may be specified in the `memory_sizes` mapping
4040
| ---- | -----------
4141
| `heap` | The maximum heap size to use. It may be a single value such as `64m` or a range of acceptable values such as `128m..256m`. It is used to calculate the value of the Java command line options `-Xmx` and `-Xms`.
4242
| `metaspace` | The maximum Metaspace size to use. It is applicable to versions of OpenJDK from 1.8 onwards. It may be a single value such as `64m` or a range of acceptable values such as `128m..256m`. It is used to calculate the value of the Java command line options `-XX:MaxMetaspaceSize=` and `-XX:MetaspaceSize=`.
43+
| `native` | The amount of memory to reserve for native memory allocation. It should normally be omitted or specified as a range with no upper bound such as `100m..`. It does not correspond to a switch on the Java command line.
4344
| `permgen` | The maximum PermGen size to use. It is applicable to versions of OpenJDK earlier than 1.8. It may be a single value such as `64m` or a range of acceptable values such as `128m..256m`. It is used to calculate the value of the Java command line options `-XX:MaxPermSize=` and `-XX:PermSize=`.
4445
| `stack` | The stack size to use. It may be a single value such as `2m` or a range of acceptable values such as `2m..4m`. It is used to calculate the value of the Java command line option `-Xss`.
45-
| `native` | The amount of memory to reserve for native memory allocation. It should normally be omitted or specified as a range with no upper bound such as `100m..`. It does not correspond to a switch on the Java command line.
4646

4747
Memory sizes together with _memory weightings_ (described in the next section) are used to calculate the amount of memory for each memory type. The calculation is described later.
4848

docs/jre-oracle_jre.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ The JRE can be configured by modifying the [`config/oracle_jre.yml`][] file in t
2929

3030
| Name | Description
3131
| ---- | -----------
32-
| `repository_root` | The URL of the Oracle repository index ([details][repositories]).
33-
| `version` | The version of Java runtime to use. Candidate versions can be found in the the repository that you have created to house the JREs. Note: version 1.8.0 and higher require the `memory_sizes` and `memory_heuristics` mappings to specify `metaspace` rather than `permgen`.
3432
| `memory_sizes` | Optional memory sizes, described below under "Memory Sizes".
3533
| `memory_heuristics` | Default memory size weightings, described below under "Memory Weightings.
34+
| `repository_root` | The URL of the Oracle repository index ([details][repositories]).
35+
| `version` | The version of Java runtime to use. Candidate versions can be found in the the repository that you have created to house the JREs. Note: version 1.8.0 and higher require the `memory_sizes` and `memory_heuristics` mappings to specify `metaspace` rather than `permgen`.
3636

3737
### Additional Resources
3838
The JRE can also be configured by overlaying a set of resources on the default distribution. To do this, add files to the `resources/oracle_jre` directory in the buildpack fork. For example, to add the JCE Unlimited Strength `local_policy.jar` add your file to `resources/oracle_jre/lib/security/local_policy.jar`.
@@ -49,9 +49,9 @@ The following optional properties may be specified in the `memory_sizes` mapping
4949
| ---- | -----------
5050
| `heap` | The maximum heap size to use. It may be a single value such as `64m` or a range of acceptable values such as `128m..256m`. It is used to calculate the value of the Java command line options `-Xmx` and `-Xms`.
5151
| `metaspace` | The maximum Metaspace size to use. It is applicable to versions of Oracle from 1.8 onwards. It may be a single value such as `64m` or a range of acceptable values such as `128m..256m`. It is used to calculate the value of the Java command line options `-XX:MaxMetaspaceSize=` and `-XX:MetaspaceSize=`.
52+
| `native` | The amount of memory to reserve for native memory allocation. It should normally be omitted or specified as a range with no upper bound such as `100m..`. It does not correspond to a switch on the Java command line.
5253
| `permgen` | The maximum PermGen size to use. It is applicable to versions of Oracle earlier than 1.8. It may be a single value such as `64m` or a range of acceptable values such as `128m..256m`. It is used to calculate the value of the Java command line options `-XX:MaxPermSize=` and `-XX:PermSize=`.
5354
| `stack` | The stack size to use. It may be a single value such as `2m` or a range of acceptable values such as `2m..4m`. It is used to calculate the value of the Java command line option `-Xss`.
54-
| `native` | The amount of memory to reserve for native memory allocation. It should normally be omitted or specified as a range with no upper bound such as `100m..`. It does not correspond to a switch on the Java command line.
5555

5656
Memory sizes together with _memory weightings_ (described in the next section) are used to calculate the amount of memory for each memory type. The calculation is described later.
5757

0 commit comments

Comments
 (0)