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.
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Docker Unix Socket |
| No | The socket the Docker daemon listens on. Required if Docker Server and Docker Port are not set. Default value is [/var/run/docker.sock] |
Docker Server Address |
| No | The IP address of the Docker server. Required if Docker Unix Socker is not set. |
Docker Port |
| No | The port the Docker service is listening on. Required if Docker Unix Socker is not set. |
Docker Registry Account |
| 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. The plugin input Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers |
...
Property Name | Property Code | Required | Description |
|---|---|---|---|
Docker Image Repository Name |
| No | The name of the docker image, including the repository if desiredProvide docker repository name with optional namespace. i.e. foo/bar or bar. The plugin input |
Docker Image Tag |
| No | The Provide tag of to apply to the docker built image. Use comma-separated values to specify multiple tags. For example: 1.0,2.0,3.0 . The plugin input |
...
Input Name | Input Code | Required | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
| 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 Build Context |
| No | You can pass the relative or absolute path to a local directory as the context for a build. | |||||||||
Docker Repository Name |
| No | The Docker image use when running the containerProvide docker repository name with optional namespace. i.e. foo/bar or bar. This input will take priority over the
| |||||||||
Image Tag |
| No | The Provide tag to use when creating the containerapply to the built image. Use comma-separated values to specify multiple tags. For example: 1.0,2.0,3.0 . This input will take priority over the | |||||||||
Docker Registry Account |
| 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:
Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers | |||||||||
Push Image to repository |
| No | Push Image to repository.to configured Registry. | |||||||||
Tag Image with latest tag |
| No | Check to tag built image with 'latest' tag. | |||||||||
Additional Options |
| No | Add any additional options not listed above, which will be added to the build command. e.g. --cpu-period=100000 --cpu-quota=150000 |
Outputs
Output Name | Description |
|---|---|
| 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. |
| 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. |
| The tag of the built image. This output will always be made available to the deploy workflow. |
| The built docker image. This output will always be made available to the deploy workflow. |
| 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.
...
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:
...
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?
...
docker tag %ImageId% %RepoName%:%tagName%
To tag the image you can also use dockerTagImage operation.