Skip to content

Latest commit

 

History

History
406 lines (289 loc) · 17.4 KB

README.md

File metadata and controls

406 lines (289 loc) · 17.4 KB
Raw

deploy-cloudrun

The deploy-cloudrun GitHub Action deploys to Google Cloud Run. It can deploy a container image or from source, and the resulting service URL is available as a GitHub Actions output for use in future steps.

This is not an officially supported Google product, and it is not covered by a Google Cloud support contract. To report bugs or request features in a Google Cloud product, please contact Google Cloud support.

Prerequisites

  • This action requires Google Cloud credentials that are authorized to access the secrets being requested. See Authorization for more information.

  • This action runs using Node 20. If you are using self-hosted GitHub Actions runners, you must use a runner version that supports this version or newer.

Usage

jobs:
  job_id:
    # ...

    permissions:
      contents: 'read'
      id-token: 'write'

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

    - uses: 'google-github-actions/auth@v2'
      with:
        workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
        service_account: '[email protected]'

    - id: 'deploy'
      uses: 'google-github-actions/deploy-cloudrun@v2'
      with:
        service: 'hello-cloud-run'
        image: 'gcr.io/cloudrun/hello'

    - name: 'Use output'
      run: 'curl "${{ steps.deploy.outputs.url }}"'

Inputs

  • service: (Optional) ID of the service or fully-qualified identifier of the service. This is required unless providing metadata or job.

  • job: (Optional) ID of the job or fully-qualified identifier of the job. This is required unless providing metadata or service.

  • metadata: (Optional) YAML service description for the Cloud Run service. This is required unless providing service or job.

  • image: (Optional) (Required, unless providing metadata or source) Fully-qualified name of the container image to deploy. For example:

    gcr.io/cloudrun/hello:latest

    or

    us-docker.pkg.dev/my-project/my-container/image:1.2.3

  • source: (Optional) (Required, unless providing metadata, image, or job) Path to source to deploy. If specified, this will deploy the Cloud Run service from the code specified at the given source directory.

    Learn more about the required permissions in Deploying from source code.

  • suffix: (Optional) String suffix to append to the revision name. Revision names always start with the service name automatically. For example, specifying v1 for a service named helloworld, would lead to a revision named helloworld-v1. This option is only applies to services.

  • env_vars: (Optional) List of environment variables that should be set in the environment. These are comma-separated or newline-separated KEY=VALUE. Keys or values that contain separators must be escaped with a backslash (e.g. \, or \\n) unless quoted. Any leading or trailing whitespace is trimmed unless values are quoted.

    env_vars: |-
  FRUIT=apple
  SENTENCE=" this will retain leading and trailing spaces "

    This value will only be set if the input is a non-empty value. If a non-empty value is given, the field values will be overwritten (not merged). To remove all values, set the value to the literal string {}.

    If both env_vars and env_vars_file are specified, the keys in env_vars will take precendence over the keys in env_vars_file.

  • env_vars_file: (Optional) Path to a file on disk, relative to the workspace, that defines environment variables. The file can be newline-separated KEY=VALUE pairs, JSON, or YAML format. If both env_vars and env_vars_file are specified, the keys in env_vars will take precendence over the keys in env_vars_file.

    NAME=person
[email protected]\,[email protected]

    When specified as KEY=VALUE pairs, the same escaping rules apply as described in env_vars. You do not have to escape YAML or JSON.

    If both env_vars and env_vars_file are specified, the keys in env_vars will take precendence over the keys in env_vars_file.

    ⚠️ DEPRECATION NOTICE: This input is deprecated and will be removed in the next major version release.

  • env_vars_update_strategy: (Required, default: merge) Controls how the environment variables are set on the Cloud Run service. If set to "merge", then the environment variables are merged with any upstream values. If set to "overwrite", then all environment variables on the Cloud Run service will be replaced with exactly the values given by the GitHub Action (making it authoritative).

  • secrets: (Optional) List of KEY=VALUE pairs to use as secrets. These are comma-separated or newline-separated KEY=VALUE. Keys or values that contain separators must be escaped with a backslash (e.g. \, or \\n) unless quoted. Any leading or trailing whitespace is trimmed unless values are quoted.

    These can either be injected as environment variables or mounted as volumes. Keys starting with a forward slash '/' are mount paths. All other keys correspond to environment variables:

    with:
  secrets: |-
    # As an environment variable:
    KEY1=secret-key-1:latest

    # As a volume mount:
    /secrets/api/key=secret-key-2:latest

    This value will only be set if the input is a non-empty value. If a non-empty value is given, the field values will be overwritten (not merged). To remove all values, set the value to the literal string {}.

  • secrets_update_strategy: (Required, default: merge) Controls how the secrets are set on the Cloud Run service. If set to merge, then the secrets are merged with any upstream values. If set to overwrite, then all secrets on the Cloud Run service will be replaced with exactly the values given by the GitHub Action (making it authoritative).

  • labels: (Optional) List of labels that should be set on the function. These are comma-separated or newline-separated KEY=VALUE. Keys or values that contain separators must be escaped with a backslash (e.g. \, or \\n) unless quoted. Any leading or trailing whitespace is trimmed unless values are quoted.

    labels: |-
  labela=my-label
  labelb=my-other-label

    This value will only be set if the input is a non-empty value. If a non-empty value is given, the field values will be overwritten (not merged). To remove all values, set the value to the literal string {}.

    Google Cloud restricts the allowed values and length for labels. Please see the Google Cloud documentation for labels for more information.

  • skip_default_labels: (Optional, default: false) Skip applying the special annotation labels that indicate the deployment came from GitHub Actions. The GitHub Action will automatically apply the following labels which Cloud Run uses to enhance the user experience:

    managed-by: github-actions
commit-sha: <sha>

    Setting this to true will skip adding these special labels.

  • tag: (Optional) Traffic tag to assign to the newly-created revision. This option is only applies to services.

  • timeout: (Optional) Maximum request execution time, specified as a duration like "10m5s" for ten minutes and 5 seconds.

  • flags: (Optional) Space separate list of additional Cloud Run flags to pass to the deploy command. This can be used to apply advanced features that are not exposed via this GitHub Action. For Cloud Run services, this command will be gcloud run deploy. For Cloud Run jobs, this command will be `gcloud jobs deploy.

    with:
  flags: '--add-cloudsql-instances=...'

    Flags that include other flags must quote the entire outer flag value. For example, to pass --args=-X=123:

    with:
  flags: '--add-cloudsql-instances=... "--args=-X=123"'

    See the complete list of flags for more information.

    Please note, this GitHub Action does not parse or validate the flags. You are responsible for making sure the flags are available on the gcloud version and subcommand.

  • no_traffic: (Optional, default: false) If true, the newly deployed revision will not receive traffic. This option is only applies to services.

  • revision_traffic: (Optional) Comma-separated list of revision traffic assignments.

    with:
  revision_traffic: 'my-revision=10' # percentage

    To update traffic to the latest revision, use the special tag "LATEST":

    with:
  revision_traffic: 'LATEST=100'

    This is mutually-exclusive with tag_traffic. This option is only applies to services.

  • tag_traffic: (Optional) Comma-separated list of tag traffic assignments.

    with:
  tag_traffic: 'my-tag=10' # percentage

    This is mutually-exclusive with revision_traffic. This option is only applies to services.

  • update_traffic_flags: (Optional) Space separate list of additional Cloud Run flags to pass to the gcloud run services update-traffic command. This can be used to apply advanced features that are not exposed via this GitHub Action. This flag only applies with revision_traffic or tag_traffic is set.

    with:
  traffic_flags: '--set-tags=...'

    Flags that include other flags must quote the entire outer flag value. For example, to pass --args=-X=123:

    with:
  flags: '--set-tags=... "--args=-X=123"'

    See the complete list of flags for more information.

    Please note, this GitHub Action does not parse or validate the flags. You are responsible for making sure the flags are available on the gcloud version and subcommand.

  • project_id: (Optional) ID of the Google Cloud project in which to deploy the service.

  • region: (Optional, default: us-central1) Region in which the Cloud Run services are deployed.

  • gcloud_version: (Optional) Version of the Cloud SDK to install. If unspecified or set to "latest", the latest available gcloud SDK version for the target platform will be installed. Example: "290.0.1".

  • gcloud_component: (Optional) Version of the Cloud SDK components to install and use.

Custom metadata YAML

For advanced use cases, you can define a custom Cloud Run metadata file. This is a YAML description of the Cloud Run service or job. This allows you to customize your service configuration, such as memory limits, CPU allocation, max instances, and more.

⚠️ When using a custom metadata YAML file, all other inputs are ignored!

  • metadata: (Optional) The path to a Cloud Run service or job metadata file.

To deploying a new service to create a new YAML service definition:

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: SERVICE
spec:
  template:
    spec:
      containers:
      - image: IMAGE

To update a revision or to deploy a new revision of an existing service, download and modify the YAML service definition:

gcloud run services describe SERVICE --format yaml > service.yaml

Allowing unauthenticated requests

A Cloud Run product recommendation is that CI/CD systems not set or change settings for allowing unauthenticated invocations. New deployments are automatically private services, while deploying a revision of a public (unauthenticated) service will preserve the IAM setting of public (unauthenticated). For more information, see Controlling access on an individual service.

Outputs

  • url: The URL of the Cloud Run service.

Authorization

There are a few ways to authenticate this action. The caller must have permissions to access the secrets being requested.

You will need to authenticate to Google Cloud as a service account with the following roles:

  • Cloud Run Admin (roles/run.admin):
    • Can create, update, and delete services.
    • Can get and set IAM policies.

This service account needs to be a member of the Compute Engine default service account, ([email protected]), with role Service Account User. To grant a user permissions for a service account, use one of the methods found in Configuring Ownership and access to a service account.

Via google-github-actions/auth

Use google-github-actions/auth to authenticate the action. You can use Workload Identity Federation or traditional Service Account Key JSON authentication.

jobs:
  job_id:
    permissions:
      contents: 'read'
      id-token: 'write'

    steps:

    # ...

    - uses: 'google-github-actions/auth@v2'
      with:
        workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
        service_account: '[email protected]'

    - uses: 'google-github-actions/deploy-cloudrun@v2'
      with:
        image: 'gcr.io/cloudrun/hello'
        service: 'hello-cloud-run'

Via Application Default Credentials

If you are hosting your own runners, and those runners are on Google Cloud, you can leverage the Application Default Credentials of the instance. This will authenticate requests as the service account attached to the instance. This only works using a custom runner hosted on GCP.

jobs:
  job_id:
    steps:
    # ...

    - uses: 'google-github-actions/deploy-cloudrun@v2'
      with:
        image: 'gcr.io/cloudrun/hello'
        service: 'hello-cloud-run'

The action will automatically detect and use the Application Default Credentials.

Example Workflows