Alibaba Cloud DevOps:Pipeline jobs

Optional. The environment in which the pipeline job runs. You can use the public Kubernetes (K8s) cluster environment provided by Apsara DevOps or a private host build cluster. Supported environments include Specified container environment and Default VM environment.

• Specified container environment: Starts a specified container on the build machine to run the build in a single-container environment. The following example shows the syntax:

  jobs:
    my_job:
      name: My task
      runsOn:
        group: public/ap-southeast-1 // The specified container environment currently supports only Apsara DevOps public build clusters.
        container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest // A public image address that can be accessed from the Internet. For more information about official Apsara DevOps system images, see https://atomgit.com/flow-steps/system_images/blob/main/README_INTL.md 

  Build cluster	YAML identifier	Description
  Apsara DevOps Singapore build cluster	group: public/ap-southeast-1	The public K8s cluster that Apsara DevOps provides in Singapore. This is the default cluster if runsOn is not specified.
  Private build cluster	group: private/<private_build_cluster_ID>	A private host cluster that is added to an enterprise through a private build cluster.

• Default VM environment: Runs steps directly on the host or VM of the build cluster. The following is an example:

  jobs:  
    my_job:    
      name: My task      
        runsOn:        
          group: private/<private_build_cluster_ID>   // Only private build clusters are supported. Specifies a private build cluster.        
          labels: windows, amd64          // Specifies the operating system and architecture for scheduling. If this is not specified, the task is randomly scheduled to a machine in the cluster.        
          vm: true                        // Specifies the VM build environment.

  Private build clusters support Linux, Windows, and macOS machines. The following table describes the supported architectures and build environments for each operating system.

  Operating system	Architecture	labels	Description
  Linux	amd64	linux,amd64	Supports the Default environment and the Default VM environment.
  Linux	arm64	linux,arm64	Supports only the Default VM environment. You must set vm: true.
  Windows	amd64	windows,amd64	Supports only the Default VM environment. You must set vm: true.
  Windows	arm64	windows,arm64	Supports only the Default VM environment. You must set vm: true.
  macOS	amd64	darwin,amd64	Supports only the Default VM environment. You must set vm: true.
  macOS	arm64	darwin,arm64	Supports only the Default VM environment. You must set vm: true.

Optional. The build environment specification. Apsara DevOps automatically allocates the DEFAULT specification based on the steps configured in the job. For more information about the default specification, see the documentation at https://www.alibabacloud.com/help/doc-detail/201868.html. You can also specify a build environment specification. Valid values are SMALL_1C2G, MEDIUM_2C4G, LARGE_4C8G, and XLARGE_8C16G.

Example:

jobs:
  my_job:
    name: My task
    runsOn:
      group: public/ap-southeast-1
      container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest
      instanceType: LARGE_4C8G    # Specifies the build environment specification.

Optional. The default timeout period for a job is 240 minutes. You can set the timeout period to a value from 1 to 1,440 minutes.

Example:

jobs:
  my_job:
    name: My task
    runsOn:
      group: public/ap-southeast-1
      container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest
    timeoutMinutes: 60		# The job times out 60 minutes after it starts.

Optional. If you specify these parameters, you can retain the job execution environment after the job is complete and log on to the environment to debug the job.

These parameters can be used only with the Specified container environment.

You must specify both parameters or neither.

Valid values for debugPolicy are:

1. onFailure: The execution environment is retained only if the job fails. The environment is not retained if the job is successful or fails only because of a redline check.

2. always: The build environment is retained regardless of whether the job succeeds or fails.

debugRetentionMinutes specifies the retention period in minutes. The value must be an integer from 1 to 240.

Example:

jobs:
  my_job:
    name: My task
    runsOn:
      group: public/ap-southeast-1
      container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest
    debugPolicy: always
    debugRetentionMinutes: 5

jobs:
  my_job:
    name: My task
    runsOn:
      group: public/ap-southeast-1
      container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest
    driven: manual		#Manually confirm to run the task.
    

jobs:
  my_job:
    name: My task
    runsOn:
      group: public/ap-southeast-1
      container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest
    condition: |
      "${CI_COMMIT_REF_NAME}" == "master"		# Run this job when the branch is master.

jobs:
  deploy_job:
  name: Host group deployment task
  component: VMDeploy             # Specify the component.
  with:                           # Specify the parameters for the component.
    artifact: $[stages.build_stage.build_job.upload_step.artifacts.default]
    machineGroup: <YOUR-MACHINE-GROUP-ID>
    ......