This plugin has been deprecated. Please migrate to the currently maintained appengine-maven-plugin.

Cloud SDK App Engine Apache Maven Plugin

Apache Maven is a software project management and comprehension tool. It is capable of building WAR files for deployment into App Engine. The App Engine team provides both a plugin and Maven Archetypes for the purpose of speeding up development.

Requirements

To use Maven with Managed VMs, you need to do the following:

0. Download and install Maven if you don't have it installed.

1. Install the Google Cloud SDK on your machine. The new Maven plugin goals will not download it automatically on build. Make sure you install an up-to-date version (Beta or later) that has the App Engine Managed VM components installed.

2. Install the Cloud SDK app-engine-java component:

   gcloud components update app-engine-java

3. If you want to start with a Java Managed VM sample code and tutorial, you can use the GitHub project: https://github.com/GoogleCloudPlatform/appengine-java-vm-guestbook-extras

4. The Maven plugin relies on configuration done by the cloud SDK. For example, the project name you want to use for a deployment step can be defined with:

   gcloud auth login gcloud config set project

Adding the Cloud SDK App Engine Maven plugin to an existing Maven project

To add the Cloud SDK Google App Engine Maven plugin to an existing Maven project, add the following into the plugins section in the project pom.xml file:

<plugin>
   <groupId>com.google.appengine</groupId>
   <artifactId>gcloud-maven-plugin</artifactId>
   <version>2.0.9.121.v20160815</version>
</plugin>

Compile and build your project using Maven

To build a Java App Engine Web Application using Maven with its pom.xml file:

1. Change directory to the main directory for your project, for example, guestbook/

2. Invoke Maven as follows:

   mvn clean install

3. Wait for the project to build. When the project successfully finishes you will see a message similar to this one:

   BUILD SUCCESS
    Total time: 10.724s
    Finished at: Mon Jul 14 14:50:06 PST 2014
    Final Memory: 24M/213M

4. Optionally, run and test the application locally using the Cloud SDK development server, as described in the next section.

Run and test your app with the Cloud SDK development server

During the development phase, you can run and test your app at any time in the development server by invoking the Cloud SDK App Engine Maven plugin.

To run your app in the development server:

1. Build your app if you haven't already done so:

   mvn clean install

2. Run your app by changing directory to the top level of your project (for example, to myapp) and invoking Maven as follows:

   $ mvn gcloud:run

3. Wait for the the server to start and use your browser to visit http://localhost:8080/ to access your app.

4. Shut down the app and the development server by pressing Control+C in the Windows/Linux terminal window where you started it, or CMD+C on the Mac.

5. You can stage the application,i.e create a directory under target/appengine-staging which is ready to be deploy by standard gcloud command with:

   $ mvn gcloud:stage

App Engine Maven plugin goals for the Cloud SDK

The App Engine Maven plugin goals have been extended to work with a local Cloud SDK installation that enable Managed VMs development and deployment. These goals are listed in the following sections.

Development server goals

These are the Cloud SDK App Engine development server goals:

Available parameters for all gcloud:* goals:

Available parameters, corresponding to gcloud app run command line flags:

The following example shows how to use some of these settings:

  <plugin>
    <groupId>com.google.appengine</groupId>
    <artifactId>gcloud-maven-plugin</artifactId>
    <version>>2.0.9.121.v20160815</version>
    <configuration>
      <gcloud_directory>/usr/foo/private/google-cloud-sdk</gcloud_directory>
      <verbosity>debug</verbosity>
      <version>specific_version</version>
      <log_level>info</log_level>
      <max_module_instances>2</max_module_instances>
    </configuration>
  </plugin>

Application deployment goal

You can deploy an App Engine Application via the goal gcloud:deploy.

    $ mvn gcloud:deploy

If you want to just produced a deployable stage application directory ready to be used by the Cloud SDK commands, you can use the stage gcloud:stage:

    $ mvn gcloud:stage

the resulting directory will be in the target/appengine-staging directory.

Available parameters, corresponding to gcloud app deploy command line flags:

Application management goals

The application and project management goals are listed in the following table:

Available parameters corresponding to gcloud app modules command line flags:

Configuration elements override via the command line interface

Instead of editing the pom.xml with the desired configuration, all the configuration parameters can be defined in the mvn command line, following the simple pattern -Dgcloud.PARAM_NAME=PARAM_VALUE. For example:

  # To start the development server with debug flag:
  $ mvn gcloud:run -Dgcloud.verbosity=debug
  # To start the development server listening to 0.0.0.0 so it can be accessed outside of localhost:
  $ mvn gcloud:run -Dgcloud.host=0.0.0.0:8081
  # To specify a non default Cloud SDK installation directory:
  $ mvn gcloud:run -Dgcloud.gcloud_directory=YOUR_OWN_SPECIFIC_INSTALLATION_PATH
  # To specify the project ID and version at deployment time:
  $ mvn gcloud:deploy -Dgcloud.gcloud_project=myproject  -Dgcloud.version=myversion

Note: The configuration parameters cannot be overriden, due to this Maven bug.

Enterprise Archive (EAR) support

You can use the Cloud SDK Maven plugin on App Engine projects of type war and ear.