Cloud Foundry Java Buildpack
java-buildpack is a Cloud Foundry buildpack for running JVM-based applications. It is designed to run many JVM-based applications (Grails, Groovy, Java Main, Play Framework, Spring Boot, and Servlet) with no additional configuration, but supports configuration of the standard components, and extension to add custom components.
To use this buildpack specify the URI of the repository when pushing an application to Cloud Foundry:
cf push <APP-NAME> -p <ARTIFACT> -b https://github.com/cloudfoundry/java-buildpack.git
The following are very simple examples for deploying the artifact types that we support.
Configuration and Extension
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.
To learn how to configure various properties of the buildpack, follow the "Configuration" links below. More information on extending the buildpack is available here.
- Standard Containers
- Standard Frameworks
- AppDynamics Agent (Configuration)
- Java Options (Configuration)
- MariaDB JDBC (Configuration)
- New Relic Agent (Configuration)
- Play Framework Auto Reconfiguration (Configuration)
- Play Framework JPA Plugin (Configuration)
- PostgreSQL JDBC (Configuration)
- Spring Auto Reconfiguration (Configuration)
- Spring Insight
- Standard JREs
- Debugging the Buildpack
- Buildpack Modes
- Related Projects
The buildpack can be packaged up so that it can uploaded to Cloud Foundry using the
cf create-buildpack and
cf update-buildpack commands. In order to create these packages, the rake
package task is used.
The online package is a version of the buildpack that is as minimal as possible and is configured to connect to the network for all dependencies. This package is about 50K in size. To create the online package, run:
bundle install bundle exec rake package ... Creating build/java-buildpack-cfd6b17.zip
The offline package is a version of the buildpack designed to run without access to a network. It packages the latest version of each dependency (as configured in the
config/ directory) and disables
remote_downloads. This package is about 180M in size. To create the offline package, use the
bundle install bundle exec rake package OFFLINE=true ... Creating build/java-buildpack-offline-cfd6b17.zip
Keeping track of different versions of the buildpack can be difficult. To help with this, the rake
package task puts a version discriminator in the name of the created package file. The default value for this discriminator is the current Git hash (e.g.
cfd6b17). To change the version when creating a package, use the
bundle install bundle exec rake package VERSION=2.1 ... Creating build/java-buildpack-2.1.zip
To run the tests, do the following:
bundle install bundle exec rake
Running Cloud Foundry locally is useful for privately testing new features.
This buildpack is released under version 2.0 of the Apache License.