Configure tasks

This document describes how to configure tasks in Cloud Deploy. A task is a unit of work that can be used as a deploy hook , for deployment verification , for deploy analysis , or for a custom render or custom deploy in a custom target type .

You can configure a task on the delivery pipeline (as part of the strategy ) or the custom target type render or deploy.

With tasks, you can use system parameters by templating them into your task configuration.

Define a task

You can define a task in your delivery pipeline configuration or as part of a custom target type definition. The following YAML shows the task stanza used in either case:

   
 task 
 : 
  
 type 
 : 
  
 container 
  
 image 
 : 
  
 IMAGE 
  
 command 
 : 
  
 [ 
 COMMANDS_TO_RUN 
 ] 
  
 args 
 : 
  
 [ 
 LIST_OF_ARGS 
 ] 
  
 env 
 : 
  
 - 
  
 KEY1:VAL1 
  
 - 
  
 KEY2:VAL2 
  
 ... 
 

For the task configuration:

• type

  Specifies the kind of task being configured. Only container is supported.

• image

  Is the path to the container image.

• command

  Is the command or commands to run on the container.

• args

  Is a collection of arguments to the command .

• env

  Is a collection of environment variables to be provided to the running container.

System Parameters as task environment variables

Cloud Deploy offers system-generated parameters that you can use as environment variables in your tasks, using the env field in the container task. The templated parameters can be present in the key or value fields of an env map entry.

Here are a couple of example use cases:

• Passing in the Cloud Run service name, service URL, and revision name as environment variables.

    task 
   : 
    
   type 
   : 
    
   container 
    
   image 
   : 
    
   my-image 
    
   command 
   : 
    
   [ 
   "/bin/bash" 
   ] 
    
   env 
   : 
    
   - 
    
   RUN_SERVICE_NAME 
   : 
    
   "${{ 
    
   render.metadata.cloud_run.service.name 
    
   }}" 
    
   - 
    
   RUN_SERVICE_URL 
   : 
    
   "${{ 
    
   rollout.metadata.cloud_run.service_url 
    
   }}" 
    
   - 
    
   RUN_REVISION_NAME 
   : 
    
   "${{ 
    
   render.metadata.cloud_run.revision.name 
    
   }}" 
   
  

• Using multiple parameters in a single entry.

    task 
   : 
    
   type 
   : 
    
   container 
    
   image 
   : 
    
   my-image 
    
   command 
   : 
    
   [ 
   "/bin/bash" 
   ] 
    
   env 
   : 
    
   - 
    
   DEPLOY_PARAMS_KEY 
   : 
    
   "${{ 
    
   deploy_params['FOO'] 
    
   }}-with-${{ 
    
   deploy_params['BAR'] 
    
   }}" 
    
   - 
    
   "${{ 
    
   project.id 
    
   }}_${{ 
    
   location 
    
   }}" 
    
   : 
    
   "${{ 
    
   target.id 
    
   }}" 
   
  

Available system parameters

Cloud Deploy provides the following system parameters that you can use in your tasks configuration using this format:

${{ parameter }}

$${{ }} .

The following is the list of parameters available for templating:

Available environment variables

Cloud Deploy also provides and populates the following environment variables in the execution environment . You can use these environment variables as part of your deploy hook , verify job , or custom target render or deploy.

• ANTHOS_MEMBERSHIP

  For targets of type ANTHOS , the fully specified resource name of the Anthos membership.

• CLOUD_RUN_LOCATION

  For targets of type RUN , the region the Cloud Run service is deployed in.

• CLOUD_RUN_PROJECT

  For targets of type RUN , the project in which the Cloud Run service was created.

• CLOUD_RUN_SERVICE

  For targets of type RUN , the name of the Cloud Run service deployed.

• CLOUD_RUN_SERVICE_URLS

  For targets of type RUN , the URL or URLs (comma-separated list) that end users will use to access your service. You can find these in the Cloud Run service details for your service, in the Google Cloud console. The URLs are generated by Cloud Run after your Cloud Run Service or Services have been successfully deployed. Therefore this environment variable is only available in postdeploy hooks and verify jobs .

• CLOUD_RUN_REVISION

  For targets of type RUN , the specific revision of the Cloud Run service.

• GKE_CLUSTER

  For targets of type GKE , the fully specified resource name of the Google Kubernetes Engine cluster, for example projects/p/locations/us-central1/clusters/dev .

• TARGET_TYPE

  The specific runtime type of the target. Either GKE , ANTHOS , or RUN . For custom targets, this won't be set.

• CLOUD_DEPLOY_LOCATION

  The region containing the Cloud Deploy resources.

• CLOUD_DEPLOY_DELIVERY_PIPELINE

  The ID of the delivery pipeline.

• CLOUD_DEPLOY_TARGET

  The ID of the target.

• CLOUD_DEPLOY_PROJECT

  The Google Cloud project number for the project containing the Cloud Deploy resources.

• CLOUD_DEPLOY_PROJECT_ID

  The Google Cloud project ID for the project.

• CLOUD_DEPLOY_RELEASE

  The ID of the release in which the hooks will run.

• CLOUD_DEPLOY_ROLLOUT

  The ID of the rollout that contains the jobs for the hooks.

• CLOUD_DEPLOY_JOB_RUN

  The ID of the job run that represents the current execution of the job.

• CLOUD_DEPLOY_PHASE

  The phase in the rollout that contains the job for the deploy hook, verify job, or custom render or deploy.

What's next

• Learn how to run deploy hooks using tasks
• Learn how to verify your deployment using tasks
• Learn about custom targets