Example Documentation

Previously, all the documentation for the Java Buildpack was reference
documentation.  This change adds the beginnings of more by adding
examples of building and deploying the artifact types that we
currently support.

[#63612640]

Author: nebhale

README.md

@@ -17,6 +17,11 @@ cf push -b https://github.com/cloudfoundry/java-buildpack
 The following are _very_ simple examples for deploying the artifact types that we support.
 
 * [Grails](docs/example-grails.md)
+* [Groovy](docs/example-groovy.md)
+* [Java Main](docs/example-java_main.md)
+* [Play Framework](docs/example-play_framework.md)
+* [Servlet](docs/example-servlet.md)
+* [Spring Boot CLI](docs/example-spring_boot_cli.md)
 
 ## 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.

docs/example-groovy.md

@@ -0,0 +1,21 @@
+# Groovy Examples
+The Java Buildpack can run Groovy applications written with the [Ratpack framework][r] and from raw `.groovy` files (no pre-compilation).
+
+## Raw Groovy
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ cf push -b https://github.com/cloudfoundry/java-buildpack.git
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.3s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Downloading Groovy 2.2.1 from http://.../groovy/groovy-2.2.1.zip (0.0s)
+       Expanding Groovy to .java-buildpack/groovy (0.4s)
+-----> Uploading droplet (82M)
+
+$ curl ...cfapps.io
+ok
+```
+
+[j]: https://github.com/cloudfoundry/java-test-applications/tree/master/groovy-application
+[r]: http://www.ratpack.io

docs/example-java_main.md

@@ -0,0 +1,37 @@
+# Java Main Examples
+The Java Buildpack can run Java applications with a `main()` method provided that they are packaged as [self-executable JARs][e].
+
+## Gradle
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ gradle build
+$ cf push -p build/libs/java-main-application-1.0.0.BUILD-SNAPSHOT.jar -b https://github.com/cloudfoundry/java-buildpack.git
+
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.2s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Uploading droplet (48M)
+
+$ curl ...cfapps.io
+ok
+```
+
+## Maven
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ mvn package
+$ cf push -p target/java-main-application-1.0.0.BUILD-SNAPSHOT.jar -b https://github.com/cloudfoundry/java-buildpack.git
+
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.2s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Uploading droplet (48M)
+
+$ curl ...cfapps.io
+ok
+```
+
+[e]: https://github.com/cloudfoundry/java-buildpack/blob/master/docs/container-java_main.md
+[j]: https://github.com/cloudfoundry/java-test-applications/tree/master/java-main-application

docs/example-play_framework.md

@@ -0,0 +1,39 @@
+# Play Framework Examples
+The Java Buildpack can run [Play Framework][p] applications packaged either with the `play dist` or `play stage` commands.
+
+## `play dist`
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ play dist
+$ cf push -p target/universal/play-application-1.0-SNAPSHOT.zip -b https://github.com/cloudfoundry/java-buildpack.git
+
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.2s)
+-----> Downloading Play Framework Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Uploading droplet (71M)
+
+$ curl ...cfapps.io
+ok
+```
+
+## `play stage`
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ play stage
+$ cf push -p target/universal/stage -b https://github.com/cloudfoundry/java-buildpack.git
+
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.2s)
+-----> Downloading Play Framework Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Uploading droplet (71M)
+
+$ curl ...cfapps.io
+ok
+```
+
+[j]: https://github.com/cloudfoundry/java-test-applications/tree/master/play-application
+[p]: http://www.playframework.com

docs/example-servlet.md

@@ -0,0 +1,44 @@
+# Servlet Examples
+The Java Buildpack can run Servlet-based applications provided that they are packaged as a WAR file.
+
+## Gradle
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ gradle build
+$ cf push -p build/libs/web-servlet-2-application-1.0.0.BUILD-SNAPSHOT.war -b https://github.com/cloudfoundry/java-buildpack.git
+
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.1s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+       Modifying /WEB-INF/web.xml for Auto Reconfiguration
+-----> Downloading Tomcat 7.0.50 from http://.../tomcat/tomcat-7.0.50.tar.gz (0.0s)
+       Expanding Tomcat to .java-buildpack/tomcat (0.1s)
+-----> Downloading Buildpack Tomcat Support 1.1.1 from http://.../tomcat-buildpack-support/tomcat-buildpack-support-1.1.1.jar (0.0s)
+-----> Uploading droplet (51M)
+
+$ curl ...cfapps.io
+ok
+```
+
+## Maven
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ mvn package
+$ cf push -p cf push -p target/web-servlet-2-application-1.0.0.BUILD-SNAPSHOT.war -b https://github.com/cloudfoundry/java-buildpack.git -b https://github.com/cloudfoundry/java-buildpack.git
+
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.1s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+       Modifying /WEB-INF/web.xml for Auto Reconfiguration
+-----> Downloading Tomcat 7.0.50 from http://.../tomcat/tomcat-7.0.50.tar.gz (0.0s)
+       Expanding Tomcat to .java-buildpack/tomcat (0.1s)
+-----> Downloading Buildpack Tomcat Support 1.1.1 from http://.../tomcat-buildpack-support/tomcat-buildpack-support-1.1.1.jar (0.0s)
+-----> Uploading droplet (51M)
+
+$ curl ...cfapps.io
+ok
+```
+
+[j]: https://github.com/cloudfoundry/java-test-applications/tree/master/web-servlet-2-application

docs/example-spring_boot_cli.md

@@ -0,0 +1,39 @@
+# Spring Boot CLI Examples
+The Java Buildpack can run [Spring Boot CLI][s] applications packaged with the `spring grab` or `spring jar` commands.
+
+## `spring grab`
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ spring grab *.groovy
+$ $ cf push -b https://github.com/cloudfoundry/java-buildpack.git
+
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.2s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Downloading Spring Boot CLI 1.0.0_RC2 from http://.../spring-boot-cli/spring-boot-cli-1.0.0_RC2.tar.gz (0.0s)
+       Expanding Spring Boot CLI to .java-buildpack/spring_boot_cli (0.1s)
+-----> Uploading droplet (59M)
+
+$ curl ...cfapps.io
+ok
+```
+
+## `spring jar`
+The following example shows how deploy the sample application located in the [Java Test Applications][j].
+
+```bash
+$ spring jar spring-boot-cli-application-1.0.0.BUILD-SNAPSHOT.jar *.groovy
+$ cf push -p spring-boot-cli-application-1.0.0.BUILD-SNAPSHOT.jar -b https://github.com/cloudfoundry/java-buildpack.git
+
+-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
+       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.2s)
+-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
+-----> Uploading droplet (52M)
+
+$ curl ...cfapps.io
+ok
+```
+
+[j]: https://github.com/cloudfoundry/java-test-applications/tree/master/spring-boot-cli-application
+[s]: http://projects.spring.io/spring-boot/