This page shows you how to deploy a basic App Engine application that displays a short message. For a more in-depth introduction to Go on App Engine, see Building an App.
Is App Engine the right computing option for you? See other options for hosting your application on Google Cloud Platform.
There are no costs associated with running this guide. Running this sample app alone does not exceed your free quota.
Before you begin
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:
Run the following command to install the gcloud component that includes the App Engine extension for Go 1.11:
gcloud components install app-engine-go
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
This quickstart assumes that you are familiar with the Go programming language and that you have installed Go.
Download the Hello World app
We've created a simple Hello World app for Go so you can quickly get a feel for deploying an app to Google Cloud Platform. Follow these steps to download Hello World to your local machine.
Download the sample app and navigate into the app directory:
Clone the Hello World sample app repository:
go get -u -d github.com/GoogleCloudPlatform/golang-samples
Alternatively, download the sample as a zip file and extract it.
Change to the directory that contains the sample code:
Deploying Hello World to App Engine
Deploy the Hello World app on App Engine by running the following command from the
gcloud app deploy
View the live app at
gcloud app browse
The message Hello, World! is now delivered by a web server running on an App Engine instance.
Congratulations! You've successfully deployed a Go web service on App Engine!
If you want to continue learning about App Engine, you can keep your GCP project and follow along with Building an App.
Alternatively, you can delete your GCP project to stop billing for all the resources used within that project.
- In the GCP Console, go to the Projects 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.
Now that you have experience deploying a web service on App Engine, get a more in-depth introduction to Go on App Engine by reading Building an App.