Docker CLI with YAML

YAML Parameters for Docker CLI

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Must be set to NATIVE_BUILD_DOCKER_CLI.
working_directory
Required
StringThe directory in which the pipeline filesystem will be mounted.
commands
Required
String[]The commands that will be executed.
execute_every_commandBooleanIf set to true all commands will be executed regardless of the result of the previous command.
sync_pathsSyncPath[]Define file paths that should be copied before (PIPELINE_TO_VM) and after the execution (VM_TO_PIPELINE).
docker_layer_cachingBooleanEnables or disables Docker layer caching.
docker_layer_caching_scopeBooleanRequired if docker_layer_caching is set to true. Defines the caching scope. Available values: WORKSPACE, PROJECT, PIPELINE, ACTION.
docker_layer_caching_tagStringDefines the name of the tag assigned to the cached layer.
vm_from_prev_actionBooleanSet to true if you want the action to use the VM from the previous Docker CLI action.
vm_action_nameStringThe name of the action from which the VM is reused (if vm_from_prev_action is set to true). If not set, the previous one will be used.
distributionStringSet to AMI if you want to use your own ami (default UBUNTU_20_04)
amiAmiSet if distribution is set to AMI.

Ami Properties

NameTypeDescription
idStringDefines the AMI ID of the image. Ohio-region images only. The image must have Rsync installed.
userStringThe name of the user in the custom image.
portStringThe port used for SSH in the custom image.

YAML example for Docker CLI

actions:
- action: "Execute: docker --version"
  type: "NATIVE_BUILD_DOCKER_CLI"
  working_directory: "/home/ubuntu/build"
  commands:
  - "docker --version"
  variables:
  - key: "env"
    value: "dev"
    type: "VAR"
  sync_paths:
  - pipeline_path: "/"
    vm_path: "/home/ubuntu/build"
    direction: "PIPELINE_TO_VM"
    excludes: "/.git"
  - pipeline_path: "/"
    vm_path: "/home/ubuntu/build"
    direction: "VM_TO_PIPELINE"
    excludes: ""
  vm_from_prev_action: true
  vm_action_name: "Build action"

Get Started

Sign up for free and deploy your project in less than 10 minutes.