DockerBuild - Tags

JFrog Pipelines Documentation

ft:sourceType
Paligo

This topic lists tags that can be used with DockerBuild Pipeline steps. For more information on DockerBuild Pipeline steps, see DockerBuild.

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 pertinenttags:

Tag

Description of usage

Required/Optional

affinityGroup

Must 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, you may also specify:

  • One or more Image resources to pull base images used in the build or to trigger this build.

  • One or more FileSpec resources that specify what files to include in the build context. These files are automatically copied to dockerFileLocation.

Required/Optional

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

Tags derived from Bash

All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.

Tag

Description of usage

Required/Optional

dockerFileLocation

Directory 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

dockerFileName

Name of the Dockerfile.

Required

dockerImageName

The name of the Docker image to create. This can be set using environment variables or triggering a run using parameters.

Required

dockerImageTag

The 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

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag

Description of usage

Required/Optional

onStart

Commands to execute in advance of the native operation

Optional

onSuccess

Commands to execute on successful completion

Optional

onFailure

Commands to execute on failed completion

Optional

onComplete

Commands to execute on any completion

Optional

The actions performed for the onExecute phase are inherent to this step type and may not be overridden.