Deploy an app to multiple targets at the same time

Prepare your Skaffold configuration and application manifest

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

In this quickstart, you create a skaffold.yaml file, which identifies the application manifest to be used to deploy the sample app.

1. Open a terminal window.

2. Create a new directory and navigate into it.

   GKE

   mkdir deploy-gke-parallel-quickstart
   cd deploy-gke-parallel-quickstart
   

   Cloud Run

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

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

   GKE

   apiVersion: skaffold/v4beta1
   kind: Config
   manifests:
     rawYaml:
     - k8s-deployment.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta1
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   

   This file is a minimal Skaffold config. For this quickstart, you create the file. But you can also have Cloud Deploy create one for you, for simple, non-production applications.

   See the skaffold.yaml reference for more information about this file.

4. Create the definition for your application—a service definition for Cloud Run or a Kubernetes manifest for GKE.

   GKE

   Create a file named k8s-deployment.yaml, with the following contents:

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
     labels:
       app: my-app
     namespace: default
   spec:
     replicas: 1 # from-param: ${replicaCount}
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
       spec:
         containers:
         - name: nginx
           image: my-app-image
   

   This file is a simple Kubernetes manifest, which is applied to the cluster to deploy the application. The container image to deploy is set here as a placeholder, my-app-image, which is replaced with the specific image when you create the release.

   Cloud Run

   Create a file named service.yaml, with the following contents:

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: my-parallel-run-service
   spec:
     template:
       metadata:
         annotations:
           autoscaling.knative.dev/minScale: 1 # from-param: ${minInstances}
       spec:
         containers:
         - image: my-app-image
   

   This file is a simple Cloud Run service definition, which is used at deploy time to create your Cloud Run service. The container image to deploy is set here as a placeholder, my-app-image, which is replaced with the specific image when you create the release.

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. Create your delivery pipeline and target definition:

   GKE

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-parallel-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: qsprod-multi
       profiles: []
       deployParameters:
       - values:
           replicaCount: "1"
         matchTargetLabels:
           label1: label1
       - values:
           replicaCount: "2"
         matchTargetLabels:
           label2: label2
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: qsprod-multi
   description: production clusters
   multiTarget:
     targetIds: [qsprod-a, qsprod-b]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: qsprod-a
     labels:
       label1: label1
   description: production cluster 2
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/quickstart-cluster-qsprod1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: qsprod-b
     labels:
       label2: label2
   description: production cluster 3
   gke:
     cluster: projects/PROJECT_ID/locations/us-west1/clusters/quickstart-cluster-qsprod2
   

   Cloud Run

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-parallel-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: qsprod-multi
       profiles: []
       deployParameters:
       - values:
           minInstances: "2"
         matchTargetLabels:
           label1: label1
       - values:
           minInstances: "3"
         matchTargetLabels:
           label2: label2
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: qsprod-multi
   description: production
   multiTarget:
     targetIds: [qsprod-a, qsprod-b]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: qsprod-a
     labels:
       label1: label1
   description: production us-central1
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: qsprod-b
     labels:
       label2: label2
   description: production us-west1
   run:
     location: projects/PROJECT_ID/locations/us-west1
   

   Notice that this file includes three targets: a multi-target and two child targets. You can also configure targets in separate file, rather than with your delivery pipeline.

   Notice also that the delivery pipeline includes deployParameters, with labels, and the child targets include labels to match those parameters. This allows you to pass separate values to separate child targets, if you want. Learn more.

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 one multi-target comprising two GKE or Cloud Run targets, ready to deploy your application.

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. Notice that there is one target listed in the Targets column even though you configured three targets (one multi-target and two child targets) in your clouddeploy.yaml file.

   

   Notice that the only target listed is the multi-target qsprod-multi. Child targets are not shown.

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.

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-parallel-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa \
   --to-target=qsprod-multi

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

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

As always, when you create a release, a rollout is created automatically for the first target in your pipeline (or, as in this case, a specific target specified using --to-target=). In this quickstart, this target is a multi-target, so the rollout is a "controller rollout" for two child targets, and there are no subsequent targets in the delivery pipeline. This means that your application is deployed everywhere upon rollout creation.

View the results in Google Cloud console

Now that you've created the release, and the controller rollout and child rollouts are created, those child rollouts are now deployed (or are in the process of being deployed) to their respective GKE clusters or Cloud Run services.

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

   Open the Delivery pipelines page

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

   The pipeline visualization shows the app's deployment status. Because there's only one stage in the pipeline, the visualization shows only one node.

   

   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.