dockerBuildImage

This operation builds an image from a docker file.  It will not create or start a container.

Environment/Instance Properties

Property Name

Property Code

Required

Description

Docker Server Address

FDDKR_DOCKER_SERVER

No

The IP address of the Docker server.  Required if Docker Unix Socker is not set.

Docker PortFDDKR_DOCKER_PORTNoThe port the Docker service is listening on.  Required if Docker Unix Socker is not set.
Docker Unix SocketFDDKR_UNIX_SOCKETNoThe socket the Docker daemon listens on. Required if Docker Server and Docker Port are not set.

Project Properties

Property Name

Property Code

Required

Description





Inputs

Input Name

Input Code

Required

Description

Docker FileFDDKR_INP_DOCKER_FILENo

The path to the Docker File to build. If empty Dockerfile is used as the name, and it is searched as specified in the next line.

If an absolute path is given, it is used. Otherwise the file is checked for relative to the FD_TEMP_DIR and any checkout folders.

Docker File ArgumentsFDDKR_INP_DOCKER_FILE_ARGSNoThe docker file arguments to use. These are the ARG instructions in the docker file.  KeyValue pairs should be separated by "|" and the key and value should be separated by ",".  Example: key1,value|key2,value|key3,value
Docker RepositoryFDDKR_INP_REPOSITORYNoThe image name/repository to create the image in.  This is the REPOSITORY column when running the command 'docker images'.
Image TagFDDKR_INP_IMAGE_TAGNoThe tag to apply to the image.  Example: 'latest'.

Outputs

Output Name

Required

Description

FDDKR_OUT_IMAGE_ID

No

The image id that was created from the operation.  The IMAGE_ID column when running the command 'docker images'.

Artifacts

This operation consumes a Dockerfile from the artifacts repository.  Can also be overridden through the docker file input.


Endpoint Selection

This operation delegates the selection to the workflow developer to determine.


Endpoint Execution

This operations delegates the execution to the workflow developer to decide.


Special Considerations

Build Args were not consumed

If using the 'Docker File Arguments' input and the docker file doesn't contain a matching ARG instruction, the operation will fail with the following error:

'com.github.dockerjava.api.exception.DockerClientException: Could not build image: One or more build-args were not consumed, failing build.'

To correct this, either remove the key/value mapping from the input or add an ARG instruction for the missing key in your docker file.


Docker Repository Required?

The 'Docker Repository' input is not required to build the image but in order to make use of other docker functionality, like pushing to a registry, you need to specify a repository.  If you forgot to specify a repository on build you can tag the image from the command line at any point.

docker tag %ImageId% %RepoName%:%tagName%