Run Docker container

Learn more about:

POST Parameters

List with common parameters for all Buddy actions

NameTypeDescription
name
Required		StringThe name of the action.
type
Required		StringThe type of the action. Should be set to RUN_DOCKER_CONTAINER.
docker_image_name
Required		StringThe name of the Docker image.
docker_image_tag
Required		StringThe tag of the Docker image.
inline_commands
Required		StringThe commands that will be executed.
run_as_userStringAll build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image).
mount_filesystem_disableBooleanDefines whether or not to mount the filesystem to the running container.
volume_mappingsString[]The path preceding the colon is the filesystem path (the folder from the filesystem to be mounted in the container). The path after the colon is the container path (the path in the container, where this filesystem will be located).
loginStringThe username required to connect to the Dockerhub, private registry or GCR.
passwordStringThe password required to connect to the Dockerhub, private registry or GCR.
registryStringThe url to the Docker registry or GCR.
export_container_pathStringDefines the export path of the container’s filesystem as a tar archive.
integrationIntegrationThe integration. Required for using the image from the Amazon ECR.
regionStringThe name of the Amazon S3 region. Required for using the image from the Amazon ECR. The full list of regions is available here.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
  "name": "Run container",
  "type": "RUN_DOCKER_CONTAINER",
  "trigger_time": "ON_EVERY_EXECUTION",
  "docker_image_name": "library/ubuntu",
  "docker_image_tag": "latest",
  "variables": [
   {
      "key": "containerUser",
      "value": "notRoot"
   }
  ],
  "run_as_user": "$containerUser",
  "inline_commands": "ls -al > ls.log",
  "mount_filesystem_disable": false,
  "export_container_path": "/exportPath",
  "volume_mappings":
    "/:/buddy/mount/directory",
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
  "id": 2,
  "name": "Run container",
  "type": "RUN_DOCKER_CONTAINER",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "docker_image_name": "library/ubuntu",
  "docker_image_tag": "latest",
  "variables": [
   {
      "key": "containerUser",
      "value": "notRoot"
   }
  ],
  "run_as_user": "$containerUser",
  "inline_commands": "ls -al > ls.log",
  "mount_filesystem_disable": false,
  "volume_mappings":
    "/:/buddy/mount/directory",
  "export_container_path": "/exportPath",
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "Live mirror",
    "trigger_mode": "MANUAL",
    "ref_name": "master",
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.