Deploy an app to Cloud Run using Cloud Deploy

Prepare your Skaffold configuration

Cloud Deploy uses Skaffold to provide the details for what to deploy and how to deploy it properly for your separate targets.

For this quickstart, you create a skaffold.yaml file, which identifies the Cloud Run service or job definition to be used to deploy the sample app.

1. Open a terminal window.

2. Create a new directory, named deploy-run-quickstart and navigate into it.

   mkdir deploy-run-quickstart
   cd deploy-run-quickstart
   

3. Create a file named skaffold.yaml with the following contents:

   Services

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata: 
     name: deploy-run-quickstart
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-service-dev.yaml
   - name: prod
     manifests:
       rawYaml:
       - run-service-prod.yaml
   deploy:
     cloudrun: {}
   

   Jobs

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata: 
     name: deploy-run-quickstart
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-job-dev.yaml
   - name: prod
     manifests:
       rawYaml:
       - run-job-prod.yaml
   deploy:
     cloudrun: {}
   

   This file is a minimal Skaffold config, identifying your Cloud Run services or jobs. See the skaffold.yaml reference for more information about this file.

Prepare your Cloud Run services or jobs

For this quickstart, you'll create either two different Cloud Run services or two Cloud Run jobs, in the same project. Cloud Deploy also supports deploying across multiple projects. Also, we use Skaffold profiles to make it possible to have two services or jobs in the same project. When you use different projects, you might not need to use Skaffold profiles.

Create your delivery pipeline and targets

You can define your pipeline and targets in one file or in separate files. In this quickstart, you create a single file.

1. In the deploy-run-quickstart directory, create a new file: clouddeploy.yaml, with the following contents:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-run-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: run-qsdev
       profiles: [dev]
     - targetId: run-qsprod
       profiles: [prod]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: run-qsdev
   description: Cloud Run development service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: run-qsprod
   description: Cloud Run production service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

2. Register your pipeline and targets with the Cloud Deploy service:

   gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
   

   You now have a pipeline, with targets, ready to deploy your application to your first target.

3. Confirm your pipeline and targets:

   In the Google Cloud console, navigate to the Cloud Deploy Delivery pipelines page to view of list of your available delivery pipelines.

   Open the Delivery pipelines page

   The delivery pipeline you just created is shown, and the two targets are listed in the Targets column.

   

Create a release

A release is the central Cloud Deploy resource representing the changes being deployed. The delivery pipeline defines the lifecycle of that release. See Cloud Deploy service architecture for details about that lifecycle.

Run the following command from the deploy-run-quickstart directory to create a release resource that represents the container image to deploy:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/job@sha256:d7c33651fbad911a9a0a0c16f2f9b3a79f0b9e3e89afb205603af706067feac5

Notice the --images= flag, which you use to replace the placeholder (my-app-image) in the service or job definition with the specific, SHA-qualified image. Google recommends that you templatize your service and job definitions this way, and that you use SHA-qualified image names at release creation.

As with all releases (unless they include --disable-initial-rollout), Cloud Deploy automatically creates a rollout resource too. The application is automatically deployed into the first target in the progression.

Promote the release

1. From the Delivery pipelines page, click the my-run-demo-app-1 pipeline.

   Open the Delivery pipelines page

   The Delivery pipeline details page shows a graphical representation of your delivery pipeline's progress. In this case, it shows that the release was deployed to the run-qsdev target.

   

2. On the first target in the delivery pipeline visualization, click Promote.

   The Promote release dialog is shown. It shows the details of the target you're promoting to.

3. Click Promote.

   The release is now queued for deployment into run-qsprod. When deployment is complete, the delivery pipeline visualization shows it as deployed:

   

View the results in Google Cloud console

1. In the Google Cloud console, navigate to the Cloud Deploy Delivery pipelines page to view your my-run-demo-app-1 delivery pipeline.

   Open the Delivery pipelines page

2. Click the name of your delivery pipeline "my-run-demo-app-1".

   The pipeline visualization shows the app's progress through the pipeline.

   

   And your release is listed on the Releases tab under Delivery pipeline details.

3. Click the release name, test-release-001.

   Your rollouts appear under Rollouts. You can click a rollout to view its details, including the deployment log.

   

Accessing your Cloud Run service

By default, you must be authenticated in order to access newly created Cloud Run services. See the Cloud Run Authentication overview to learn how to provide credentials and to find out what Identity and Access Management configuration is required in order access the service without authentication. This doesn't apply to Cloud Run jobs.