Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This operation builds an image from a docker file.  It will not create or start a container. This operation uses Docker CLI, it requires the docker executable to be on the path of the docker endpoint.

...

Property Name

Property Code

Required

Description

Docker Unix Socket

FDDKR_UNIX_SOCKET

No

The socket the Docker daemon listens on. Required if Docker Server and Docker Port are not set.

Docker Server Address

FDDKR_DOCKER_SERVER

No

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

Docker Port

FDDKR_DOCKER_PORT

No

The port the Docker service is listening on.  Required if Docker Unix Socker is not set.

Registry Account

FDDKR_REGISTRY_ACCOUNT_CODE

No

The Docker Registry account to use. Required when we want to push the image or the base image mentioned in the Docker file residing in a remote registry and require login to pull the image.

Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers

...

Input Name

Input Code

Required

Description

Docker File

FDDKR_INP_DOCKER_FILE

No

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 Arguments

FDDKR_INP_DOCKER_FILE_ARGS

No

The 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

Escape commas in values with backslashes. \,

Image Name

FDDKR_INP_IMAGE_NAME

No

The Docker image use when running the container. This input will take priority over the FDDKR_IMAGE_NAME project property.

Image Tag

FDDKR_INP_IMAGE_TAG

No

The tag to use when creating the container. This input will take priority over the FDDKR_IMAGE_TAG project property.

Docker Registry Account

FDDKR_INP_REGISTRY_ACCOUNT_CODE

No

The Registry you Docker Registry account to use. Required when we want to push the image or the base image mentioned in the Docker file residing in a remote registry and require login to pull the image. There are a couple different spots to specify this for convenience.

In order of precedence:

Target Property

  • This plugin input.

  • Target Property

Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers

Push Image to repository

FDDKR_INP_PUSH_IMAGE

No

Push Image to repository.

Additional Parameters

FDDKR_INP_ADDITIONAL_PARAMS

No

Add any additional parameters not listed above, which will be added to the build command. e.g. --cpu-period=100000 --cpu-quota=150000

...

Output Name

Description

FD_BUILT_DOCKER_IMAGE_ID

The image id that was created from the operation.  The IMAGE_ID column when running the command 'docker images'. This output will always be made available to the deploy workflow.

FD_BUILT_DOCKER_IMAGE_NAME

The built docker image name. The IMAGE_NAME column when running the command ‘docker images'. This output will always be made available to the deploy workflow.

FD_BUILT_DOCKER_IMAGE_TAG

The tag of the built image. This output will always be made available to the deploy workflow.

FD_BUILT_DOCKER_IMAGE

The built docker image. This output will always be made available to the deploy workflow.

FD_BUILT_DOCKER_LINK

The link to the built docker image when pushed to a repository. This output will always be made available to the deploy workflow.

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.

...