Docker CLI with YAML

YAML Parameters for Docker CLI

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The ID of the action.
type `Required`	String	The type of the action. Must be set to `NATIVE_BUILD_DOCKER_CLI`.
working_directory `Required`	String	The directory in which the pipeline filesystem will be mounted.
commands `Required`	String[]	The commands that will be executed.
execute_every_command	Boolean	If set to `true` all commands will be executed regardless of the result of the previous command.
sync_paths	SyncPath[]	Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).
docker_layer_caching	Boolean	Enables or disables Docker layer caching.
docker_layer_caching_scope	Boolean	Required if `docker_layer_caching` is set to `true`. Defines the caching scope. Available values: `WORKSPACE`, `PROJECT`, `PIPELINE`, `ACTION`.
docker_layer_caching_tag	String	Defines the name of the tag assigned to the cached layer.
vm_from_prev_action	Boolean	Set to `true` if you want the action to use the VM from the previous Docker CLI action.
vm_action_name	String	The 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.
distribution	String	Set to `AMI` if you want to use your own ami (default `UBUNTU_20_04`)
ami	Ami	Set if `distribution` is set to `AMI`.

AMI Properties

Name	Type	Description
id	String	Defines the AMI ID of the image. Ohio-region images only. The image must have Rsync installed.
user	String	The name of the user in the custom image.
port	String	The port used for SSH in the custom image.

YAML example for Docker CLI

yaml
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"

Last modified on Apr 9, 2025

Docker Dockerfile Linter

On this page

YAML Parameters for Docker CLI AMI Properties YAML example for Docker CLI