Quickstart for Go App Engine Standard Environment

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.

Costs

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, you must set up a GCP project for App Engine and then install the Cloud SDK:

  1. Create a new GCP project and App Engine application using the GCP Console:

    Go to App Engine

    When prompted, select the region where you want your App Engine application located. After your App Engine application is created, the Dashboard opens.

  2. Download and install the Cloud SDK. Follow the instructions in the Cloud SDK page to initialize and set your GCP project ID in the gcloud command-line tool:

    Download the SDK

  3. Run the following command to install the gcloud component that includes the App Engine extension for Go:

    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:

  • northamerica-northeast1 (Montréal)
  • us-central (Iowa)
  • us-west2 (Los Angeles)
  • us-east1 (South Carolina)
  • us-east4 (Northern Virginia)
  • southamerica-east1 (São Paulo) *
  • europe-west (Belgium)
  • europe-west2 (London)
  • europe-west3 (Frankfurt)
  • asia-northeast1 (Tokyo)
  • asia-east2 (Hong Kong)
  • asia-south1 (Mumbai)
  • australia-southeast1 (Sydney)

* For customers using the São Paulo region, all regional product SLAs remain in force. However, multi-region and cross-region functionality that span across North America and South America might temporarily have reduced availability or performance.

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 http://[YOUR_PROJECT_ID].appspot.com.

Download the Hello World app

We've created a simple Hello World app for Go so that you can quickly get a feel for deploying an app to Google Cloud Platform.

To download Hello World app to your local machine:

  1. Download the Hello World sample app repository and its dependencies to a directory called helloworld on your local machine:

    go get -u -d github.com/GoogleCloudPlatform/golang-samples/appengine/helloworld/...
    
  2. Navigate to the helloworld directory:

    cd helloworld
    

Alternatively, you can download the sample as a .zip file and then extract it to a directory called helloworld.

Test the application

Test the application using the local development server, which is included with the SDK.

  1. From within the helloworld directory where the app's app.yaml configuration file is located, run the dev_appserver.py command to compile your app and then start the local development server:

      dev_appserver.py app.yaml
    

    The local development server is now running and listening for requests on port 8080. Something go wrong?

  2. Visit http://localhost:8080/ in your web browser to see the app in action.

Running the local development server (dev_appserver.py)

To run the local development server, you can either run dev_appserver.py by specifying the full directory path or you can add dev_appserver.py to your PATH environment variable:

  • If you installed the original App Engine SDK, the tool is located at:

    [PATH_TO_APP_ENGINE_SDK]/dev_appserver.py
    
  • If you installed the Google Cloud SDK, the tool is located at:

    [PATH_TO_CLOUD_SDK]/google-cloud-sdk/bin/dev_appserver.py
    

    Tip: To add the Google Cloud SDK tools to your PATH environment variable and enable command-completion in your shell, you can run:

    [PATH_TO_CLOUD_SDK]/google-cloud-sdk/install.sh
    

For more information about running the local development server including how to change the port number, see the Local Development Server reference.

Make a change

The local development server watches for changes in your project files. As you update your source code, your app is recompiled and launched.

  1. Try it now: Leave the local development server running and then try editing the hello.go file to change Hello, world! to something else.
  2. Reload http://localhost:8080/ to see the change.

Deploy your app

To deploy your app to App Engine, run the following command from within the root directory of your application where the app.yaml file is located:

gcloud app deploy

Learn about the optional flags.

Common gcloud command flags

  • Include the --version flag to specify an ID that uniquely identifies that version of your app, otherwise one is generated for you. Example: --version [YOUR_VERSION_ID]
  • Include the --project flag to specify an alternate GCP project ID to what you initialized as the default in the gcloud tool. Example: --project [YOUR_PROJECT_ID]

Example:

gcloud app deploy --version pre-prod-5 --project my-sample-app

To learn more about deploying your app from the command line, see Deploying a Go App . For a list of all the command flags, see the gcloud app deploy reference.

View your application

To launch your browser and view the app at http://[YOUR_PROJECT_ID].appspot.com, run the following command:

gcloud app browse

Congratulations!

You have completed this quickstart.

See the following sections for information about cleaning up as well as links to the possible next steps that you can take.

To learn more about this Hello World app, see the Hello World code review section.

Clean up

If you enabled billing for your project, you can delete your GCP project to stop billing for all the resources used within that project.

  1. GCP Console で [プロジェクト] ページに移動します。

    プロジェクト ページに移動

  2. プロジェクト リストで、削除するプロジェクトを選択し、[プロジェクトの削除] をクリックします。 プロジェクト名の横にあるチェックボックスを選択し、[プロジェクトの削除] をクリックする
  3. ダイアログにプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。

What's next

Learn the whole platform

Now that you know what it's like to develop and deploy App Engine apps, you can stretch out and see the rest of Google Cloud Platform. For a guided walkthrough which teaches you how to create an application that uses more of the Cloud platform, not just App Engine, check out our "Building an App" guide. The guide builds on what you've learned from this quickstart, teaching you how to deploy a simple blog application where users can upload and store posts.

Learn more about App Engine standard environment

Here are some topics to help you to continue learning about App Engine:

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

App Engine standard environment for Go