Build multi-arch image

POST Parameters

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. Should be set to `DOCKER_BUILD_MULTI_ARCH`.
dockerfile_path `Required`	String	The path of the desired dockerfile in the repository. Default is `DOCKERFILE`.
context_path	String	The docker build image context path.
target_stage	String	Specifes an intermediate build stage by name as a final stage for the resulting image. Commands after the target stage are skipped.
secret_id	String	The identifier to pass into the `docker build --secret`. This identifier is associated with the `RUN --mount` identifier to use in the Dockerfile.
secret_src	String	Renames the secret file to a specific file in the Dockerfile RUN command to use.
build_args	String[]	The arguments used when building the image from the Dockerfile.
target_platform	String[]	Specifies the target platform for the build output. You can set multiple target platforms. Default value: `linux/amd64`. Available values: `linux/amd64`, `linux/arm64`, `linux/arm/v7`, `linux/arm/v6`.
docker_image_tag	String	The tag of the Docker image.
login	String	The username required to connect to the server. Required for delivering the Dockerfile to a private registry.
password	String	The password required to connect to the server. Required for delivering the Dockerfile to a private registry.
integration_hash	String	The ID of the integration. Required for delivering the Dockerfile to the Amazon ECR, Google GCR and Docker Hub.
region	String	The name of the Amazon S3 region. Required for delivering the Dockerfile to the Amazon ECR. The full list of regions is available here.
registry	String	The url to GCR. Can be one of gcr.io, us.gcr.io, eu.gcr.io or asia.gcr.io. Required for Google GCR.
repository	String	The location of the Docker repository.

Sample Request

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

JSON

{
  "name": "Build multi-arch image",
  "type": "DOCKER_BUILD_MULTI_ARCH",
  "build_args": [
    "key=value"
  ],
  "dockerfile_path": "Dockerfile",
  "context_path": "/contextPath",
  "target_stage": "$targetStage",
  "secret_id": "$secretId",
  "secret_src": "$path_to_secret",
  "target_platform": "linux/amd64,linux/arm64"
}

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 multi-arch image",
  "type": "DOCKER_BUILD_MULTI_ARCH",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "trigger_time": "ON_EVERY_EXECUTION",
  "dockerfile_path": "Dockerfile",
  "target_platform":"linux/amd64,linux/arm64",
  "secret_id": "$secretId",
  "secret_src": "$path_to_secret",
  "build_args": [
     "key=value"
  ],
  "context_path": "/contextPath",
  "target_stage": "$targetStage",
  "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",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

Last modified on March 8, 2023

Build multi-arch image

Knowledge is power!