Building Custom Runtimes

A custom runtime allows you to use an alternate implementation of any supported App Engine flexible environment language, or to customize a Google-provided one. It also allows you to write code in any other language that can handle incoming HTTP requests (example). With a custom runtime, the App Engine flexible environment provides and manages your scaling, monitoring, and load balancing infrastructure for you, so you can focus on building your application.

To create a custom runtime you must:

• Provide an app.yaml file that describes your application's runtime configuration to App Engine.
• Add a Dockerfile that internally configures the runtime environment.
• Ensure that your code follows some basic rules.

Note: Google supplies some base images that you can customize, but you aren't required to use these. You can use other images so long as they satisfy the conditions in the list above.

Provide an app.yaml file

Your app.yaml configuration file must contain at least the following settings:

runtime: custom
env: flex

For information about what else you can set for your app, see Configuring your App with app.yaml.

Create a Dockerfile

Comprehensive documentation on creating Dockerfiles is available on the Docker website. If you are using a custom runtime, you must provide a Dockerfile whether you are providing your own base image or using one of Google's base images.

Specifying a Google base image

The first command in a Dockerfile is usually a FROM command specifying a base image. The following table shows you the FROM command to use to specify any Google-provided base images, along with the github project used to build the image:

Runtime	Command	Note
Go github project	FROM gcr.io/google-appengine/golang
Java (Open JDK 8 only) github project	FROM gcr.io/google-appengine/openjdk	Dockerfiles for Java.
Java (Open JDK 8 + Eclipse Jetty 9.3) github project	FROM gcr.io/google-appengine/jetty	Dockerfiles for Java.
Python 2.7 & 3.6 github project	FROM gcr.io/google-appengine/python
Node.js github project	FROM gcr.io/google-appengine/nodejs
Ruby github project	FROM gcr.io/google-appengine/ruby
PHP github project	FROM gcr.io/google-appengine/php

Using App Engine service APIs

To access the App Engine service APIs from a Go app that is running the golang base image, you must import the App Engine Go libraries into your source code.

OK

Using custom Java runtimes

To customize a Java runtime and add additional directives, you must create a Dockerfile.

Example Dockerfile for Java 8 / Jetty 9:

FROM gcr.io/google-appengine/jetty
ADD test-webapp-1.0-SNAPSHOT.war $JETTY_BASE/webapps/root.war
WORKDIR $JETTY_BASE
RUN java -jar $JETTY_HOME/start.jar --approve-all-licenses --add-to-startd=jmx,stats,hawtio 

 && chown -R jetty:jetty $JETTY_BASE

where test-webapp-1.0-SNAPSHOT.war is the name of the built WAR file in your target/ (maven) or build/staged-app/ (gradle) directory.

In contrast, don't need a Dockerfile to deploy your app to App Engine, if you choose to use an uncustomized base image of one of the Google-provided Java runtimes. For more information, see Java 8 runtime or Java 8 / Jetty 9 runtime.

OK

For a complete list of all the Google-provided images, see the google-appengine project.

Naming and locating the Dockerfile

In general, the Dockerfile is always named Dockerfile and is placed in the same directory as the corresponding app.yaml file. In some cases, however, the tooling environment might have different requirements. For example, Cloud SDK-based Java tools such as the Maven, Gradle, Eclipse, and IntelliJ plugins require the Dockerfile to be in src/main/docker/Dockerfile and the app.yaml file to be in src/main/appengine/app.yaml. See the documentation for your tooling environment for more information.

Required code structure

This section describes behavior that your code must implement whether you use a Google-provided base image or your own base image.

Listening to port 8080

The App Engine front end will route incoming requests to the appropriate module on port 8080. You must be sure that your application code is listening on 8080.

Handling lifecycle events

The App Engine flexible environment periodically sends your application certain lifecycle events.

Application Shutdown

When shutting down an instance, App Engine flexible environment normally sends a STOP (SIGTERM) signal to the app container. Your application does not need to respond to this event, but your application can use it to perform any necessary clean-up actions before the container is shut down. Under normal conditions, the system waits up to 30 seconds for the app to stop and then sends a KILL (SIGKILL) signal.

In rare cases, outages can prevents App Engine from providing 30 seconds of shutdown time, which means the STOP and KILL signals might not be sent before an instance terminates. To handle this possibility, you should periodically checkpoint the state of your instance, using it primarily as an in-memory cache rather than a reliable data store.

Health check requests

You can use periodic health check requests to confirm that a VM instance has been successfully deployed, and to check that a running instance maintains a healthy status.

Integrating your application with Google Cloud Platform

Applications running in custom runtimes can use the Google Cloud Client Libraries to access Google Cloud Platform services. Applications in custom runtimes can also use any third-party service via standard APIs.

Authenticating with Google Cloud Platform services

In general, Application Default Credentials provide the simplest way to authenticate with and call Google APIs.

It is possible to authenticate your application directly with access tokens using the Compute Engine Metadata API, but this is considerably more complex. You can then use these access tokens in API requests, such as requests against Cloud Storage and Datastore services and resources.

For more information on authentication options, see here.

Logging

When a request is sent to your application running in App Engine, the request and response details are logged automatically. They can be viewed in the Google Cloud Console Logs Viewer.

When your application handles a request, it can also write its own logging messages to stdout and stderr. These files are automatically collected and can be viewed in the Logs Viewer. Only the most recent entries to stdout and stderr are retained, in order to limit their size.

The request and application logs for your app are collected by a Cloud Logging agent and are kept for a maximum of 90 days, up to a maximum size of 1GB. If you want to store your logs for a longer period or store a larger size than 1GB, you can export your logs to Cloud Storage. You can also export your logs to BigQuery and Pub/Sub for further processing.

Other logs are also available for your use. The following are some of the logs that are configured by default:

Log name	Payload type	Purpose
crash.log	text	Information logged when setup fails. If your application fails to run, check this log.
monitoring.*	text	Information from the Docker container publishing data to Cloud Monitoring.
shutdown.log	text	Information logged on shutdown.
stdout	text	Standard output from your app.
stderr	text	Standard error from your container.
syslog	text	The VM syslog, outside of the Docker container.