Build Docker Image with YAML

YAML parameters for building Docker images

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to DOCKERFILE.
dockerfile_path
Required
StringThe path of the desired dockerfile in the repository. Default is DOCKERFILE.
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 a private registry.
passwordStringThe password required to connect to the server. Required for delivering the Dockerfile to a private registry.
integration_hashStringThe ID of the integration. Required for delivering the Dockerfile to the Amazon ECR, Google GCR and Docker Hub.
regionStringThe name of the Amazon S3 region. Required for delivering the Dockerfile to the Amazon ECR. The full list of regions is available here.
registryStringThe url to GCR. Can be one of gcr.io, us.gcr.io, eu.gcr.io or asia.gcr.io. Required for Google GCR.
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.
buildkitBooleanThe Docker BuildKit will be activated while invoking the docker build command. By default, it is set to true.
secret_idStringThe identifier to pass into the docker build --secret. This identifier is associated with the RUN --mount identifier to use in the Dockerfile.
secret_srcStringRenames the secret file to a specific file in the Dockerfile RUN command to use.

YAML example for building Docker images

actions:
- action: "Build dockerfile"
  type: "DOCKERFILE"
  region: "us-east-1"
  integration_hash: "5ddb7c180fb38be67bd78a88a"
  docker_image_tag: "14.06"
  dockerfile_path: "dir/Dockerfile"
  repository: "MyDockerRepo"
  build_args:
  - "key=value"
  insecure_registry: true
  do_not_prune_images: true
  buildkit: true
  secret_id: "secretId"
  secret_src: "path_to_secret"

Last modified on March 7, 2023

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

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