Deploy Google Cloud Run Service Action

A Github Action that deploys a service to Google Cloud Run (GCP managed Knative-Serving).

Usage

Authentication

There are multiple ways to authenticate this action to Google Cloud. The following roles are required:

• roles/run.admin
• roles/iam.serviceAccountUser
• (optional) roles/storage.objectViewer - see the image_tag_pattern parameter

Recommended: google-github-actions/auth

jobs:
  job_id:
    # Add "id-token" with the intended permissions.
    permissions:
      contents: 'read'
      id-token: 'write'

    steps:
    - uses: 'actions/checkout@v4'

    - uses: 'google-github-actions/auth@v2'
      with:
        service_account: my-service-account
        workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'

    - name: Deploy Cloud Run
      id: deploy
      uses: p1nkun1c0rns/deploy-google-cloud-run-action@master
      with:
        project_id: your-gcp-project-id
        gcp_region: europe-west4
        service_name: yourservice
        image_name: eu.gcr.io/your-gcp-project-id/yourservice
        image_tag: '1.5.1'
      env:
        SET_ENV_DISABLE_SIGNAL_HANDLERS: yeah
        SET_ENV_APPLICATION_SECRET: ${{ secrets.APPLICATION_SECRET }}

Service Account Key JSON

jobs:
  job_id:

    steps:
    - name: Deploy Cloud Run
      id: deploy
      uses: p1nkun1c0rns/deploy-google-cloud-run-action@master
      with:
        service_account_key: ${{ secrets.GOOGLE_SERVICEACCOUNT_KEY }}
        project_id: your-gcp-project-id
        gcp_region: europe-west4
        service_name: yourservice
        image_name: eu.gcr.io/your-gcp-project-id/yourservice
        image_tag: '1.5.1'
      env:
        SET_ENV_DISABLE_SIGNAL_HANDLERS: yeah
        SET_ENV_APPLICATION_SECRET: ${{ secrets.APPLICATION_SECRET }}

Prebuilt latest image

Instead of using the latest (@master) or a tagged version, a prebuilt image of the latest release in the action branch is available:

  - name: Deploy Cloud Run
    id: deploy
    uses: p1nkun1c0rns/deploy-google-cloud-run-action@action

Environment Variables

For passing configuration and secrets to the Cloud Run service --set-env-vars is used.

All env variables starting with SET_ENV_ are passed:

env:
  SET_ENV_DISABLE_SIGNAL_HANDLERS: yeah
  SET_ENV_APPLICATION_CONFIG: ${{ env.APPLICATION_CONFIG }}

becomes:

--set-env-vars 'DISABLE_SIGNAL_HANDLERS=yeah,APPLICATION_CONFIG=thisisgreat'

Secrets

Cloud Run supports mounting or setting secrets from Secret Manager via the `--set-secrets argument.

This action translates its environment variables as --set-secrets (similar to --set-env-vars) to simplify the use, as the argument could get quite long.

Values of env variables prefixed with SET_SECRET_ will be used as entries in the --set-secrets list, please see the official documentation for the exact format:

env:
  SET_SECRET_SOME_ENV_SECRET: ENV_VAR_NAME=SECRET_NAME:VERSION
  SET_SECRET_SOME_MOUNT_SECRET: PATH=SECRET_NAME:VERSION
  SET_SECRET_SOME_ENV_SECRET_FROM_FOREIGN_PROJECT: ENV_VAR_NAME=project/PROJECT_NUMBER/secrets/SECRET_NAME:VERSION

becomes:

--set-secrets=ENV_VAR_NAME=SECRET_NAME:VERSION,PATH=SECRET_NAME:VERSION,project/PROJECT_NUMBER/secrets/SECRET_NAME:VERSION

Remark: The service account used by the deployed Cloud Run service needs IAM rights to access all configured secrets, and the Cloud Run service account needs to be "Secret Manager Secret Accessor".

Input

Parameter

Parameter	Description	Default	Required	Reference
project_id	GCP project ID		true	gcloud
service_account_key	Base64 encoded JSON key for GCP service account		false	gcloud auth
image_name	Name of container image to be deployed		true	gcloud run deploy
service_name	Name of the service to be deployed		true	gcloud run deploy
gcp_region	GCP region to deploy the service in		true	gcloud run deploy
image_tag	Tag of container image to be deployed	latest	false	gcloud run deploy
image_tag_pattern	Regex pattern to identify the image_tag automatically	``	false	see below
concurrency_per_instance	Max number of concurrent requests per instance, max: 250	80	false	gcloud run deploy
cpu	VCPU limit per instance, max: 4	1	false	gcloud run deploy
memory	Memory limit per instance, with 4 CPU, min is 2Gi	256Mi	false	gcloud run deploy
max_instances	Max nummber of instances to be scaled	10	false	gcloud run deploy
min_instances	Min nummber of instances to be available in idle	0	false	gcloud run deploy
request_timeout	Timeout for a single request to be processed	10s	false	gcloud run deploy
allow_unauthenticated	Whether the service should not be protected by GCP authorization	true	false	gcloud run deploy
cpu_throttling	Set to false so that CPU is always allocated and available even when there are no incoming requests	true	false	gcloud run deploy
startup_boost	Set to true to have additional CPU available at startup time	false	false	cloud run docs
service_account	Service Account to be used by the revision to be deployed	GCP docs: "If not provided, the revision will use the project's default service account."	false	gcloud_run_deploy
no_traffic	Set to true to just deploy a new revision without shifting traffic	false	false	gcloud run deploy
cloudsql_instances	Comma separated list of CloudSQL instances to connect to		false	gcloud run deploy
vpc_connector	Name of the Serverless VPC Access connector to use with this service		false	gcloud run deploy
vpc_egress	Outbound traffic configuration, if a vpc_connector is configured; options are: private-ranges-only, all-traffic	private-ranges-only	false	gcloud run deploy
vpc_network	Name of VPC network when using direct VPC egress w/o vpc connector		false	gcloud run deploy
vpc_subnet	Name of VPC network's subnet when using direct VPC egress w/o vpc connector		false	gcloud run deploy
vpc_network_tags	Comma-separated list of network tags for the VPC network to be used		false	gcloud run deploy
ingress	Allowed ingress traffic sources; options are: all, internal, internal-and-cloud-load-balancing	all	false	gcloud run deploy
http2	Whether or not to enable http2 end-to-end	false	false	gcloud run deploy
execution_environment	Selects the execution environment where the application will run; options are: gen1, gen2		false	gcloud run deploy, cloud run docs
debug	Whether the gcloud commands should be printed to output	false	false

image_tag_pattern

If parameter image_tag_pattern is provided and no explicit image_tag is given, the highest image tag (bash sort) matching the pattern (grep -E "^${image_tag_pattern}") will be deployed. For doing this, the used GCP service account has to have the role roles/storage.objectViewer.

Example: image_tag_pattern: 1\.3\.\d+

Output

Parameter	Description	Example
cloud_run_revision	Revision of the deployed service	yourservice-v1-5-1-t1587453463
cloud_run_endpoint	Endpoint the service is serving at	https://yourservice-djgts23jkbq-ez.a.run.app
gcloud_log	Log output of the gcloud run deploy command
deployed_image_tag	Tag of the image that was deployed	1.3.23

Remarks

• The service revision suffix is built from the image_tag replacing the dots with dashes concatinating the current epoch seconds for beeing able to redeploy the same version with different configuration.
• Container image name is built by concatinating image_name:image_tag

Contribution

Welcomed