Build Dockerfile

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 DOCKERFILE.
dockerfile_path
Required		StringThe path to the desired Dockerfile in the filesystem.
context_pathStringThe docker build image context path.
docker_image_tagStringThe tag of the Docker image.
loginStringThe username required to connect to the server. Required for delivering the Dockerfile to the Docker Hub or a private registry.
passwordStringThe password required to connect to the server. Required for delivering the Dockerfile to the Docker Hub or a private registry.
integrationIntegrationThe integration. Required for delivering the Dockerfile to the Amazon ECR.
regionStringThe name of the Amazon S3 region. Required for delivering the Dockerfile to the Amazon ECR. The full list of regions is available here.
repositoryStringThe location of the Docker repository.
build_argsString[]The arguments used when building the image from the Dockerfile.
insecure_registryBooleanIf set to true, ignore SSL errors upon connecting to the Docker registry.
do_not_prune_imagesBooleanIf set to true, dangling images will not be pruned after the build.
buildkitBooleanIf set to true, the Docker BuildKit will be activated while invoking the docker build command.

Example

Request

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

JSON

{
  "name": "Build dockerfile",
  "type": "DOCKERFILE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "docker_image_tag": "14.06",
  "region": "us-east-1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "dockerfile_path": "dir/Dockerfile",
  "repository": "MyDockerRepo",
  "insecure_registry": true,
  "do_not_prune_images": true,
  "buildkit": true,
  "build_args": [
     "key=value"
  ]
}

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": "Build dockerfile",
  "type": "DOCKERFILE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "last_execution_status": "INITIAL",
  "trigger_time": "ON_EVERY_EXECUTION",
  "docker_image_tag": "14.06",
  "region": "us-east-1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "dockerfile_path": "dir/Dockerfile",
  "repository": "MyDockerRepo",
  "insecure_registry": true,
  "do_not_prune_images": true,
  "buildkit": true,
  "build_args": [
     "key=value"
  ],
  "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.