dockerRemoveImage

Remove an image with specific or multiple tags. Use comma-separated values to specify multiple tags. For example: 1.0,2.0,3.0 . 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.

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 remove. The plugin input FDDKR_INP_IMAGE_NAME takes precedence over this property.

Docker Image Tag

FDDKR_IMAGE_TAG

No

The specific tag to remove or a list of multiple tags e.g 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 remove. This input will take priority over the FDDKR_IMAGE_NAME project property.

Image Tag

FDDKR_INP_IMAGE_TAG

No

The specific tag to remove or a list of multiple tags e.g 1.0,2.0,3.0 . This input will take priority over the FDDKR_IMAGE_TAG project property.

Force Remove

FDDKR_INP_FORCE_REMOVE

No

Force removal of the image. Default value is false.

Additional Options

FDDKR_INP_ADDITIONAL_PARAMS

No

Add any additional options, which will be concatenated to the rmi 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.

The following macros are not currently supported in the footer:
  • style