Skip to content

Commit 3d306b9

Browse files
nebhalenebhale
committed
Auto reconfiguration framework documentation
Previously, the two auto reconfiguration frameworks were not documented separately. This change updates to documentation to reflect the new dual implementations. [#49696097]
1 parent 0ec0cf7 commit 3d306b9

3 files changed

Lines changed: 33 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ The buildpack supports configuration and extension through the use of Git reposi
2727
* [Play](docs/container-play.md)
2828
* [Tomcat](docs/container-tomcat.md) ([Configuration](docs/container-tomcat.md#configuration))
2929
* Standard Frameworks
30-
* [Auto Reconfiguration](docs/framework-auto-reconfiguration.md) ([Configuration](docs/framework-auto-reconfiguration.md#configuration))
30+
* [Play Auto Reconfiguration](docs/framework-play-auto-reconfiguration.md) ([Configuration](docs/framework-play-auto-reconfiguration.md#configuration))
31+
* [Spring Auto Reconfiguration](docs/framework-spring-auto-reconfiguration.md) ([Configuration](docs/framework-spring-auto-reconfiguration.md#configuration))
3132
* [`JAVA_OPTS`](docs/framework-java_opts.md) ([Configuration](docs/framework-java_opts.md#configuration))
3233
* Standard JREs
3334
* [OpenJDK](docs/jre-openjdk.md) ([Configuration](docs/jre-openjdk.md#configuration))

‎docs/framework-play-auto-reconfiguration.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Play Auto Reconfiguration Framework
2+
The Play Auto Reconfiguration Framework causes an application to be automatically reconfigured to work with configured cloud services.
3+
4+
<table>
5+
<tr>
6+
<td><strong>Detection Criterion</strong></td><td>An application is a Play application</td>
7+
</tr>
8+
<tr>
9+
<td><strong>Tags</strong></td><td><tt>play-auto-reconfiguration-&lt;version&gt;</tt></td>
10+
</tr>
11+
</table>
12+
Tags are printed to standard output by the buildpack detect script
13+
14+
## Configuration
15+
The container can be configured by modifying the [`config/playautoreconfiguration.yml`][playautoreconfiguration_yml] file. The container uses the [`Repository` utility support][util_repositories] and so it supports the [version syntax][version_syntax] defined there.
16+
17+
[playautoreconfiguration_yml]: ../config/playautoreconfiguration.yml
18+
[util_repositories]: util-repositories.md
19+
[version_syntax]: util-repositories.md#version-syntax-and-ordering
20+
21+
| Name | Description
22+
| ---- | -----------
23+
| `repository_root` | The URL of the Auto Reconfiguration repository index ([details][util_repositories]).
24+
| `version` | The version of Auto Reconfiguration to use. Candidate versions can be found in [this listing][auto_reconfiguration_index_yml].
25+
26+
[auto_reconfiguration_index_yml]: http://download.pivotal.io.s3.amazonaws.com/auto-reconfiguration/lucid/x86_64/index.yml

docs/framework-auto-reconfiguration.md renamed to docs/framework-spring-auto-reconfiguration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Auto Reconfiguration Framework
2-
The Auto Reconfiguration Framework causes an application to be automatically reconfigured to work with configured cloud services.
1+
# Spring Auto Reconfiguration Framework
2+
The Spring Auto Reconfiguration Framework causes an application to be automatically reconfigured to work with configured cloud services.
33

44
<table>
55
<tr>
66
<td><strong>Detection Criterion</strong></td><td>Existence of a <tt>spring-core*.jar</tt> file in the application directory</td>
77
</tr>
88
<tr>
9-
<td><strong>Tags</strong></td><td><tt>auto-reconfiguration-&lt;version&gt;</tt></td>
9+
<td><strong>Tags</strong></td><td><tt>spring-auto-reconfiguration-&lt;version&gt;</tt></td>
1010
</tr>
1111
</table>
1212
Tags are printed to standard output by the buildpack detect script
@@ -17,9 +17,9 @@ If a `/WEB-INF/web.xml` file exists, the framework will modify it in addition to
1717
2. Augmenting `contextInitializerClasses`. The function starts by enumerating the current `contextInitializerClasses`. If none exist, a default configuration is created with no value as the default. The `org.cloudfoundry.reconfiguration.spring.CloudApplicationContextInitializer` class is then added to the collection of classes.
1818

1919
## Configuration
20-
The container can be configured by modifying the [`config/autoreconfiguration.yml`][autoreconfiguration_yml] file. The container uses the [`Repository` utility support][util_repositories] and so it supports the [version syntax][version_syntax] defined there.
20+
The container can be configured by modifying the [`config/springautoreconfiguration.yml`][springgautoreconfiguration_yml] file. The container uses the [`Repository` utility support][util_repositories] and so it supports the [version syntax][version_syntax] defined there.
2121

22-
[autoreconfiguration_yml]: ../config/autoreconfiguration.yml
22+
[springautoreconfiguration_yml]: ../config/springautoreconfiguration.yml
2323
[util_repositories]: util-repositories.md
2424
[version_syntax]: util-repositories.md#version-syntax-and-ordering
2525

0 commit comments

Comments
 (0)