Cloud customer?
Start for Free >
Upgrade in MyJFrog >
What's New in Cloud >





You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

Overview

The DockerBuild native step performs a build to produce a Docker image from a Dockerfile in a Git source repository.


This step builds a Docker image from a GitRepo source repository resource.  You must provide in the step configuration the name and directory of the Dockerfile that contains the command to be processed by a docker build  command, as well as the name and tag of the resulting image.  The image is built on the build node, and information about that image is stored in the run state.

To build a Docker image that relies on a private base image:

  1. Define the base image as an Image resource, with autopull set to true.
  2. Specify the Image resource as one of the inputResources of the DockerBuild step.

To include artifacts in the Docker image that are not part of the GitRepo source repository:

  1. Define a FileSpec resource that specifies the files to include from Artifactory
  2. Specify the FileSpec resource as one of the inputResources of the DockerBuild step.


Proper usage of DockerBuild step

DockerBuild and DockerPush steps must be assigned to the same affinityGroup to share state. If they are not, the output of DockerBuild won't be available to DockerPush. For more information on using  affinityGroup see Running multiple steps on the same build node.

Usage

DockerBuild
pipelines: 
  - name: <string>
    steps:
      - name: <string>
        type: DockerBuild
        configuration:
          #inherits from bash
          affinityGroup:       <string>
          dockerFileLocation:  <string>
          dockerFileName:      <string>
          dockerImageName:     <string>
          dockerImageTag:      <string>
          dockerOptions:       <string>

          integrations:
            - name:            <artifactory integration>  # required

          inputResources:
            - name:             <GitRepo resource>		   # required, git repository containing your Dockerfile
            - name:             <Image resource>           # optional base image
            - name:             <Filespec resource>        # optional

        execution:
          onStart:
            - echo "Preparing for work..."
          onSuccess:
            - echo "Job well done!"
          onFailure:
            - echo "uh oh, something went wrong"
          onComplete: #always
            - echo "Cleaning up some stuff"
Page Contents

Tags

name 

An alphanumeric string (underscores are permitted) that identifies the step.

type 

Must be DockerBuild for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash/PowerShell step configuration tags, including these pertinent  tags:

Tag

Description of usage

Required/Optional
affinityGroupMust specify an affinity group string that is the same as specified in a subsequent DockerPush step.Optional
inputResources 

Must specify:

  • a GitRepo resource (that contains the DockerFile)

Optionally, may also specify:

  • an Image resource of a base Image to include in the built Image
  • a FileSpec resource that specifies what files to include in the built Image. These files are automatically copied to dockerFileLocation.
Required/Optional


In addition, these tags can be defined to support the step's native operation:

Tag

Description of usage

Required/Optional
dockerFileLocationDirectory containing the Dockerfile, which is the file that has Docker build configuration. This file is also used as the context for the Docker build. The path provided should be relative to the root of the input GitRepo repository. If no location is provided, the default is the root of the GitRepo repository.Required
dockerFileNameName of the DockerfileRequired
dockerImageNameThe name of the Docker image to create. This can be set using environment variables or triggering a run using parameters.Required
dockerImageTagThe tag for the Docker image to create. This can be set using environment variables or triggering a run using parameters.Required
dockerOptions

Additional options for the  docker build command.

Optional

Examples

The following examples use a GoLang Git repository represented by a GitRepo resource named gosvc_app to create a Docker image that is published to Artifactory. They assume that an Artifactory integration named MyArtifactory has been created, and that the Artifactory instance has a Docker repository mapped to docker.artprod.company.

The following resources declarations support these examples. Not all of these resources are used in all examples.

Resources
resources:
# Application source repository
  - name: gosvc_app
    type: GitRepo
    configuration:
      gitProvider: MyGithub
      path: myuser/myrepo                   # replace with your repository name
      branches:
        include: master

# Docker image in an Artifactory repository
  - name: base_image
    type: Image
    configuration:
      registry: MyArtifactory
      sourceRepository: docker-local        # replace with your repository name
      imageName: docker.artprod.mycompany.com/baseimage
      imageTag: latest
      autoPull: true

# Files in an Artifactory repository
  - name: icon_files
    type: FileSpec
    configuration:
      sourceArtifactory: MyArtifactory
      pattern: my-local-repo/all-my-images/
      target: icons/


This example builds a Docker image to a Docker registry in Artifactory. The tag for the image is set to the pipeline's run number.

Build a Docker image from a source repository
pipelines:
  - name: demo_pipeline
    steps:
      - name: bld_image
        type: DockerBuild
        configuration:
          dockerFileLocation: .
          dockerFileName: Dockerfile
          dockerImageName: docker.artprod.mycompany.com/gosvc    # replace with your fully qualified Docker registry/image name
          dockerImageTag: ${run_number}
          inputResources:
            - name: gosvc_app
          integrations:
            - name: MyArtifactory


This example demonstrates use of the dockerOptions tag to set the build-arg option for the Docker command. An environment variable named build_number_env_variable is dynamically set to the pipeline's run number. The example assumes the environment variable is used in the Dockerfile commands.

Build a Docker image with dockerOptions
pipelines:
  - name: demo_pipeline
    steps:
      - name: bld_image
        type: DockerBuild
        configuration:
          dockerFileLocation: .
          dockerFileName: Dockerfile
          dockerImageName: docker.artprod.mycompany.com/gosvc   # replace with your fully qualified Docker registry/image name
          dockerImageTag: ${run_number}
          dockerOptions: --build-arg build_number_env_variable=${run_number}           
          inputResources:
            - name: gosvc_app
          integrations:
            - name: MyArtifactory


This example builds a Docker image that relies on a private base image stored in an Artifactory Docker repository.

Build a Docker image with a private base image
pipelines:
  - name: demo_pipeline
    steps:
      - name: bld_image
        type: DockerBuild
        configuration:
          dockerFileLocation: .
          dockerFileName: Dockerfile
          dockerImageName: docker.artprod.mycompany.com/gosvc       # replace with your fully qualified Docker registry/image name
          dockerImageTag: ${run_number}
          inputResources:
            - name: gosvc_app
            - name: base_image
          integrations:
            - name: MyArtifactory


This example demonstrates building a Docker image that includes files outside of the current path. It pulls icon files stored in an Artifactory repository for integration art named my-local-repo. It is assumed that the Dockerfile has a command that will include the files in /icons into the image.

Build a Docker image with files outside the current path
pipelines:
  - name: demo_pipeline
    steps:
      - name: bld_image
        type: DockerBuild
        configuration:
          dockerFileLocation: .
          dockerFileName: Dockerfile
          dockerImageName: docker.artprod.mycompany.com/gosvc         # replace with your fully qualified Docker registry/image name
          dockerImageTag: ${run_number}
          inputResources:
            - name: gosvc_app
            - name: icon_files
          integrations:
            - name: MyArtifactory

Further Reading

For more samples, check out Pipelines Quickstart section

  • No labels
Copyright © 2022 JFrog Ltd.