Google App Engine

Spinnaker supports deploying applications to Google App Engine.

In Google App Engine , an Account maps to a credential able to authenticate against a given Google Cloud Platform project.

Prerequisites

You need a Google Cloud Platform project to run Spinnaker against. The next steps assume you’ve already created a project , and installed gcloud . You can check that gcloud is installed and authenticated by running:

  1. gcloud info

If this is your first time deploying to App Engine in your project, create an App Engine application. You cannot change your application’s region, so pick wisely:

  1. gcloud app create --region <e.g., us-central>

You will also need to enable the App Engine Admin API for your project:

  1. gcloud services enable appengine.googleapis.com

Downloading credentials

Spinnaker does not need to be given service account credentials if it is running on a Google Compute Engine VM whose application default credentials have sufficient scopes to deploy to App Engine and Spinnaker is deploying to an App Engine application inside the same Google Cloud Platform project in which it is running. If Spinnaker will not need to be given service account credentials, or if you already have such a service account with the corresponding JSON key downloaded, skip ahead to Adding an Account .

Run the following commands to create a service account with the roles/appengine.appAdmin and roles/storage.admin roles enabled:

  1. SERVICE_ACCOUNT_NAME=spinnaker-appengine-account
  2. SERVICE_ACCOUNT_DEST=~/.gcp/appengine-account.json
  4. gcloud iam service-accounts create \
  5.     $SERVICE_ACCOUNT_NAME \
  6.     --display-name $SERVICE_ACCOUNT_NAME
  8. SA_EMAIL=$(gcloud iam service-accounts list \
  9.     --filter="displayName:$SERVICE_ACCOUNT_NAME" \
  10.     --format='value(email)')
  12. PROJECT=$(gcloud config get-value project)
  14. gcloud projects add-iam-policy-binding $PROJECT \
  15.     --role roles/storage.admin \
  16.     --member serviceAccount:$SA_EMAIL
  18. gcloud projects add-iam-policy-binding $PROJECT \
  19.     --role roles/appengine.appAdmin \
  20.     --member serviceAccount:$SA_EMAIL
  22. mkdir -p $(dirname $SERVICE_ACCOUNT_DEST)
  24. gcloud iam service-accounts keys create $SERVICE_ACCOUNT_DEST \
  25.     --iam-account $SA_EMAIL

Your service account JSON key now sits inside $SERVICE_ACCOUNT_DEST.

Adding an account

First, make sure that the provider is enabled:

  1. hal config provider appengine enable

Next, run the following hal command to add an account named my-appengine-account to your list of App Engine accounts:

  1. hal config provider appengine account add my-appengine-account \
  2.   --project $PROJECT \
  3.   --json-path $SERVICE_ACCOUNT_DEST

You can omit the --json-path flag if Spinnaker does not need service account credentials.

Deploying to App Engine

Deploying from Git

Spinnaker supports deploying your source code to App Engine by cloning your application’s git repository and submitting it to App Engine. Unless your code is public, Spinnaker needs a mechanism to authenticate with your repositories - many of the configuration flags for App Engine manage this authentication.

You can view the available configuration flags for App Engine within the Halyard reference .

Deploying from storage

Much like deploying from Git, Spinnaker also supports deploying your source code to App Engine from a Google Cloud Storage bucket. This method of deploying requires you to bundle your code into a .tar archive and then store that on GCS. When the deploy stage executes, Spinnaker will fetch your tar archive, untar it, and then deploy the code to App Engine.

Deploying from Google Container Registry URL

Spinnaker supports deploying Docker containers on the App Engine Flex runtime from images built and stored in Google Container Registry from just a gcr.io URL.

You’ll find an option in the Create Server Group dialog in Deck to use a Container Image as a deployment’s Source Type. Selecting the Container Image option reveals a textbox that can then be used to specify the gcr.io URL. Alternatively you can use an Artifact as the source of the container image URL.

Next steps

Optionally, you can set up another cloud provider , but otherwise you’re ready to choose an environment in which to install Spinnaker.

Last modified December 22, 2021: docs(fix): Fix various encoding issues (#170) (0475fe5)