Skip to content

Commit e3d8068

Browse files
nebhalenebhale
committed
Add Grails documentation
Previously there was no mention of Grails applications anywhere in the documentation. This was because Grails applications are treated as Servlet applications and therefore didn't require anything extra. Grails users were confused so it needed to be improved. This change adds Grails to the first bit of body text in the README and adds an example of how to run Grails applications. [#63612598]
1 parent e65cd40 commit e3d8068

2 files changed

Lines changed: 32 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,19 @@
44
[![Code Climate](https://codeclimate.com/repos/5224adaec7f3a3415107004c/badges/bc49f7d7f8dfc47057c8/gpa.png)](https://codeclimate.com/repos/5224adaec7f3a3415107004c/feed)
55
[![Code Climate](https://codeclimate.com/repos/5224adaec7f3a3415107004c/badges/bc49f7d7f8dfc47057c8/coverage.png)](https://codeclimate.com/repos/5224adaec7f3a3415107004c/feed)
66

7-
The `java-buildpack` is a [Cloud Foundry][] buildpack for running Java applications. It is designed to run most Java applications with no additional configuration, but supports configuration of the standard components, and extension to add custom components.
7+
The `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.
88

99
## Usage
1010
To use this buildpack specify the URI of the repository when pushing an application to Cloud Foundry:
1111

1212
```bash
13-
cf push --buildpack https://github.com/cloudfoundry/java-buildpack
13+
cf push -b https://github.com/cloudfoundry/java-buildpack
1414
```
1515

16-
or if using the [`gcf`][] tool:
16+
## Examples
17+
The following are _very_ simple examples for deploying the artifact types that we support.
1718

18-
```bash
19-
gcf push -b https://github.com/cloudfoundry/java-buildpack
20-
```
19+
* [Grails](docs/example-grails.md)
2120

2221
## Configuration and Extension
2322
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.
@@ -79,8 +78,11 @@ This buildpack is released under version 2.0 of the [Apache License][].
7978
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
8079
[Cloud Foundry]: http://www.cloudfoundry.com
8180
[contributor guidelines]: CONTRIBUTING.md
82-
[`gcf`]: https://github.com/cloudfoundry/cli
8381
[GitHub's forking functionality]: https://help.github.com/articles/fork-a-repo
82+
[Grails]: http://grails.org
83+
[Groovy]: http://groovy.codehaus.org
84+
[Installing Cloud Foundry on Vagrant]: http://blog.cloudfoundry.com/2013/06/27/installing-cloud-foundry-on-vagrant/
85+
[Play Framework]: http://www.playframework.com
8486
[pull request]: https://help.github.com/articles/using-pull-requests
8587
[Pull requests]: http://help.github.com/send-pull-requests
86-
[Installing Cloud Foundry on Vagrant]: http://blog.cloudfoundry.com/2013/06/27/installing-cloud-foundry-on-vagrant/
88+
[Spring Boot]: http://projects.spring.io/spring-boot/

‎docs/example-grails.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Grails Examples
2+
The Java Buildpack treats Grails applications as normal Servlet applications built as WAR files. The following example shows how to deploy the sample application located in the [Java Test Applications][j].
3+
4+
**Note:** The Grails community recommends running applications with no less than 768M of memory.
5+
6+
```bash
7+
$ ./grailsw war
8+
$ cf push -m 768M -p target/grails-application-0.1.war -b https://github.com/cloudfoundry/java-buildpack.git
9+
-----> Downloading Open Jdk JRE 1.7.0_51 from http://.../openjdk/lucid/x86_64/openjdk-1.7.0_51.tar.gz (0.0s)
10+
Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.1s)
11+
-----> Downloading Spring Auto Reconfiguration 0.8.7 from http://.../auto-reconfiguration/auto-reconfiguration-0.8.7.jar (0.0s)
12+
Modifying /WEB-INF/web.xml for Auto Reconfiguration
13+
-----> Downloading Tomcat 7.0.50 from http://.../tomcat/tomcat-7.0.50.tar.gz (0.0s)
14+
Expanding Tomcat to .java-buildpack/tomcat (0.1s)
15+
-----> Downloading Buildpack Tomcat Support 1.1.1 from http://.../tomcat-buildpack-support/tomcat-buildpack-support-1.1.1.jar (0.0s)
16+
-----> Uploading droplet (68M)
17+
18+
$ curl ...cfapps.io
19+
ok
20+
```
21+
22+
[j]: https://github.com/cloudfoundry/java-test-applications/tree/master/grails-application

0 commit comments

Comments
 (0)