Pull an image from a remote Docker container registry e.g. Docker Hub, Amazon ECR, Microsoft ACR , with specific or multiple tags. To pull the image we need to configure the Docker Registry Account, Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers . Depending on the size of the image it is not uncommon for this operation to take several minutes to complete. 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

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. Default value is [/var/run/docker.sock]
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.
Docker Registry Account	`FDDKR_REGISTRY_ACCOUNT_CODE`	No	The Docker Registry Account Code. The plugin input `FDDKR_INP_REGISTRY_ACCOUNT_CODE` takes precedence over this property. Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers

Project Properties

Property Name	Property Code	Required	Description

Property Name	Property Code	Required	Description
Docker Repository Name	`FDDKR_IMAGE_NAME`	No	The name of the image/repository to pull. The plugin input `FDDKR_INP_IMAGE_NAME` takes precedence over this property.
Docker Image Tag	`FDDKR_IMAGE_TAG`	No	The specific tag to pull or Use comma-separated values to specify multiple tags. For example: 1.0,2.0,3.0 . The plugin input `FDDKR_INP_IMAGE_TAG` takes precedence over this property.

Inputs

Input Name	Input Code	Required	Description

Input Name	Input Code	Required	Description
Docker Repository Name	`FDDKR_INP_IMAGE_NAME`	No	The name of the image/repository to pull. This input will take priority over the `FDDKR_IMAGE_NAME` project property. Note: If `FDDKR_IMAGE_NAME` or `FDDKR_INP_IMAGE_NAME` is specified with preceding “/”, then the registry address from `FDDKR_REGISTRY_ACCOUNT_CODE or FDDKR_INP_REGISTRY_ACCOUNT_CODE` will get auto prepended to form the full image name. Example: `FDDKR_INP_IMAGE_NAME`=/nginximage and registry address corresponding to the `FDDKR_REGISTRY_ACCOUNT_CODE` is 898334.dkr.ecr.us-east-1.amazonaws.com, then plugin will consider the image name as 898334.dkr.ecr.us-east-1.amazonaws.com/nginximage.
Image Tag	`FDDKR_INP_IMAGE_TAG`	No	The specific tag to pull or Use comma-separated values to specify multiple tags. For example: 1.0,2.0,3.0 . This input will take priority over the `FDDKR_IMAGE_TAG` project property.
Docker Registry Account	`FDDKR_INP_REGISTRY_ACCOUNT_CODE`	No	The Docker Registry Account Code. There are a couple different spots to specify this for convenience. In order of precedence: This plugin input Target Property Please refer to the link to set up the Docker Registry Account: Docker Registry Setup For Cloud Providers
Additional Options	`FDDKR_INP_ADDITIONAL_PARAMS`	No	Add any additional options not listed above, which will be added to the pull command.

Artifacts

This operation doesn’t consume or produce any artifacts.

Endpoint Selection

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

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

Depending on the bandwidth and image size this operation may take several minutes to complete.

FlexDeploy 8.0

dockerPullImage