You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The total amount of memory available is specified when the application is pushed. See [Memory](docs/jre-openjdk.md#Memory) for information on how this determines the memory available to a Java application.
The buildpack supports configuration and extension through the use of Git repository forking. The easiest way to accomplish this is to use [GitHub's forking functionality][] to create a copy of this repository. Make the required configuration and extension changes in the copy of the repository. Then specify the URL of the new repository when pushing Cloud Foundry applications. If the modifications are generally applicable to the Cloud Foundry community, please submit a [pull request][] with the changes.
@@ -19,33 +25,38 @@ To learn how to configure various properties of the buildpack, follow the "Confi
19
25
20
26
## Additional Documentation
21
27
*[Design](docs/design.md)
22
-
*[Migrating from the Previous Java Buildpack](docs/migration.md)
* [Play Auto Reconfiguration](docs/framework-play-auto-reconfiguration.md) ([Configuration](docs/framework-play-auto-reconfiguration.md#configuration))
* [Spring Auto Reconfiguration](docs/framework-spring-auto-reconfiguration.md) ([Configuration](docs/framework-spring-auto-reconfiguration.md#configuration))
* [Spring Auto Reconfiguration](docs/framework-spring_auto_reconfiguration.md) ([Configuration](docs/framework-spring_auto_reconfiguration.md#configuration))
The Java Main Class Container allows an application that provides a class with a `main()` method to be run. The application is executed with a command of the form:
1
+
# Java Main Container
2
+
The Java Main Container allows an application that provides a class with a `main()` method to be run. The application is executed with a command of the form:
Command line arguments may optionally be configured.
7
9
@@ -10,25 +12,23 @@ Command line arguments may optionally be configured.
10
12
<td><strong>Detection Criteria</strong></td><td><tt>Main-Class</tt> attribute set in <tt>META-INF/MANIFEST.MF</tt> or <tt>java_main_class</tt> set in <a href="../config/main.yml"><tt>config/main.yml<tt></a></td>
Tags are printed to standard output by the buildpack detect script
17
20
18
21
## Spring Boot
19
22
20
-
If the main class is Spring Boot's `JarLauncher` or `WarLauncher`, the Java Main Class Container adds a `--server.port` argument to the command so that the
21
-
application uses the correct port.
22
-
23
+
If the main class is Spring Boot's `JarLauncher`, `PropertiesLauncher` or `WarLauncher`, the Java Main Container adds a `--server.port` argument to the command so that the application uses the correct port.
23
24
## Configuration
24
25
For general information on configuring the buildpack, refer to [Configuration and Extension][].
25
26
26
-
The container can be configured by modifying the [`config/main.yml`][] file.
27
+
The container can be configured by modifying the `config/java_main.yml` file.
27
28
28
29
| Name | Description
29
30
| ---- | -----------
30
31
| `arguments` | Optional command line arguments to be passed to the Java main class. The arguments are specified as a single YAML scalar in plain style or enclosed in single or double quotes.
31
32
| `java_main_class` | The Java class name to run. Values containing whitespace are rejected with an error, but all others values appear without modification on the Java command line. If not specified, the Java Manifest value of `Main-Class` is used.
32
33
33
34
[Configuration and Extension]: ../README.md#Configuration-and-Extension
The Play Framework Container allows Play Framework applications to be run.
3
+
4
+
<table>
5
+
<tr>
6
+
<td><strong>Detection Criteria</strong></td><td>The Play Framework start script and the Play Framework runtime JAR exist in the appropriate subdirectories of the application directory or one of its immediate subdirectories (but not in both)</td>
7
+
</tr>
8
+
<tr>
9
+
<td><strong>Tags</strong></td>
10
+
<td><tt>play-framework=<version></tt></td>
11
+
</tr>
12
+
</table>
13
+
Tags are printed to standard output by the buildpack detect script
14
+
15
+
## Configuration
16
+
The Play Framework Container cannot be configured.
Tags are printed to standard output by the buildpack detect script.
@@ -23,17 +24,17 @@ In order to specify [Spring profiles][], set the [`SPRING_PROFILES_ACTIVE`][] en
23
24
## Configuration
24
25
For general information on configuring the buildpack, refer to [Configuration and Extension][].
25
26
26
-
The container can be configured by modifying the [`config/springbootcli.yml`][] file. The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
27
+
The container can be configured by modifying the [`config/spring_boot_cli.yml`][] file. The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
27
28
28
29
| Name | Description
29
30
| ---- | -----------
30
31
| `repository_root` | The URL of the Spring Boot CLI repository index ([details][repositories]).
31
32
| `version` | The version of Spring Boot CLI to use. Candidate versions can be found in [this listing][].
32
33
33
34
[Configuration and Extension]: ../README.md#Configuration-and-Extension
Copy file name to clipboardExpand all lines: docs/container-tomcat.md
+7-6
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,13 @@
1
1
# Tomcat Container
2
-
The Tomcat Container allows a web application to be run. These applications are run as the root web application in a Tomcat container.
2
+
The Tomcat Container allows servlet 2 and 3 web applications to be run. These applications are run as the root web application in a Tomcat container.
3
3
4
4
<table>
5
5
<tr>
6
-
<td><strong>Detection Criterion</strong></td><td>Existence of a <tt>WEB-INF/</tt> folder in the application directory and <a href="container-java-main.md">Java Main Class</a> not detected</td>
6
+
<td><strong>Detection Criterion</strong></td><td>Existence of a <tt>WEB-INF/</tt> folder in the application directory and <a href="container-java_main.md">Java Main</a> not detected</td>
The buildpack is designed as a collection of components. These components are divided into three types; _JREs_, _Containers_, and _Frameworks_.
3
-
4
-
## JRE Components
5
-
JRE components represent the JRE that will be used when running an application. This type of component is responsible for determining which JRE should be used, downloading and unpacking that JRE, and resolving any JRE-specific options that should be used at runtime.
6
-
7
-
Only a single JRE component can be used to run an application. If more than one JRE can be used, an error will be raised and application deployment will fail.
2
+
The buildpack is designed as a collection of components. These components are divided into three types; _Containers_, _Frameworks_, and _JREs_.
8
3
9
4
## Container Components
10
5
Container components represent the way that an application will be run. Container types range from traditional application servers and servlet containers to simple Java `main()` method execution. This type of component is responsible for determining which container should be used, downloading and unpacking that container, and producing the command that will be executed by Cloud Foundry at runtime.
11
6
12
-
Only a single container component can run an application. If more than one container can be used, an error will be raised and application deployment will fail.
7
+
Only a single container component can run an application. If more than one container can be used, an error will be raised and application staging will fail.
13
8
14
9
## Framework Components
15
10
Framework components represent additional behavior or transformations used when an application is run. Framework types include the downloading of JDBC JARs for bound services and automatic reconfiguration of `DataSource`s in Spring configuration to match bound services. This type of component is responsible for determining which frameworks are required, transforming the application, and contributing any additional options that should be used at runtime.
16
11
17
12
Any number of framework components can be used when running an application.
13
+
14
+
## JRE Components
15
+
JRE components represent the JRE that will be used when running an application. This type of component is responsible for determining which JRE should be used, downloading and unpacking that JRE, and resolving any JRE-specific options that should be used at runtime.
16
+
17
+
Only a single JRE component can be used to run an application. If more than one JRE can be used, an error will be raised and application deployment will fail.
0 commit comments