This quickstart shows how to deploy a sample app on App Engine. If you want to learn about coding an app for App Engine, see Building an app.
There are no costs associated with running this guide. Running this sample app alone does not exceed your free quota.
Before you beginThis quickstart assumes that you have installed the Java SE 11 Development Kit (JDK).
Before running and deploying this quickstart, install the Cloud SDK and then set up a GCP project for App Engine:
Download and install Cloud SDK:
gcloud components update
Create a new project:
gcloud projects create [YOUR_PROJECT_ID] --set-as-default
Verify the project was created:
gcloud projects describe [YOUR_PROJECT_ID]
You see project details that might look like the following:
createTime: year-month-hour lifecycleState: ACTIVE name: project-name parent: id: '433637338589' type: organization projectId: project-name-id projectNumber: 499227785679
Initialize your App Engine app with your project and choose its region:
gcloud app create --project=[YOUR_PROJECT_ID]
When prompted, select the region where you want your App Engine application located.
Make sure billing is enabled for your project. A billing account needs to be linked to your project in order for the application to be deployed to App Engine.
Install the following prerequisites:
- Download and install Git.
Install the App Engine component:
gcloud components install app-engine-java
Install Maven. This quickstart uses Apache Maven version 3.5 or greater to build, run, and deploy the sample app. For details about installing Maven, see Using Apache Maven and the App Engine Plugin.
App Engine locations
App Engine is regional, which means the infrastructure that runs your apps is located in a specific region and is managed by Google to be redundantly available across all the zones within that region.
Meeting your latency, availability, or durability requirements are primary factors for selecting the region where your apps are run. You can generally select the region nearest to your app's users but you should consider the location of the other GCP products and services that are used by your app. Using services across multiple locations can affect your app's latency as well as pricing.
App Engine is available in the following regions:
You cannot change an app's region after you set it.
If you already created an App Engine application, you can view the
region by running the
gcloud app describe command or opening the
App Engine Dashboard in the GCP Console.
The region of your App Engine application is listed under
Download the Hello World app
We've created a simple Hello World app for Java 11 so you can quickly get a feel for deploying an app to the Google Cloud Platform.
Clone the Hello World sample app repository to your local machine.
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
Alternatively, you can download the sample as a zip file and extract it.
Change to the directory that contains the sample code.
Run Hello World on your local machine
Start the local Tomcat web server using the Spring Boot Maven plugin.
In your web browser, enter the following address:
The Hello World message from the sample app displays on the page. In your terminal window, press Ctrl+C to exit the web server.
Deploy and run Hello World on App EngineTo deploy your app to the App Engine standard environment:
Deploy the Hello World app by running the following commands from the
gcloud app deploy
mvn appengine:deploy -Dapp.deploy.projectId=YOUR_PROJECT_ID
Launch your browser to view the app at
gcloud app browsewhere
YOUR_PROJECT_IDrepresents your GCP project ID.
This time, the page that displays the Hello World message is delivered by a web server running on an App Engine instance.
Congratulations! You've deployed your first Java 11 app to App Engine standard environment!
See the following sections for information about cleaning up as well as links to possible next steps that you can take.
To avoid incurring charges, you can delete your GCP project to stop billing for all the resources used within that project.
- In the GCP Console, go to the Manage resources page.
- In the project list, select the project you want to delete and click Delete delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Learn the whole platform
Now that you know what it's like to develop and deploy App Engine apps, you can explore the rest of GCP. You already have the Cloud SDK installed which gives you the tools to interact with products like Cloud SQL, Cloud Storage, Cloud Firestore, and more.
Learn about the App Engine standard environment
Here are some topics to help continue your learning about App Engine: