Docker: Delete Image
Description
Docker: Delete Image step is used to delete one or more images.
Notes:
- The step removes and un-tags one or more images from the host node. If an image has multiple tags, using this command with the tag as a parameter only removes the tag. If the tag is the only one for the image, both the image and the tag are removed.
- The step does not remove the image from the registry.
Reference
Configurations
| Field names | Description |
|---|---|
| Step Name | Specify a unique step name. |
| CONNECTION tab: | Connection fields |
| Configuration Type | Select the configuration type, that is, SSH or SSL-TLS. |
| Configuration type: SSH | |
| Server Name | Specify the Server Name or IP Address of the server where the Docker daemon is running. The field data type is String. This field is mandatory. |
| Port | Specify a valid port. The field data type is String. This field is mandatory. |
| Username | Specify the valid Username to connect to server or where the Docker Daemon running. The field data type is String. This field is mandatory. |
| Accept value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| Password | Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). The Data Type is String. This field is mandatory. If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. |
| Use Key | Select if you want to use the key. Allowed values are Yes or No. |
| Private Key | Specify a valid private key path. |
| Browse | Click to extract the private key path. |
| Passphrase | Specify a valid passphrase. |
| Proxy Host | Specify the proxy host or IP address of the proxy host. |
| Proxy Username | Specify a valid proxy user name. |
| Proxy Password | Specify a valid proxy password. |
| Configuration type: SSL-TLS | |
| Docker Host URI | Select a valid Docker Host URI on which Docker Daemon is running. Note: If you set the DOCKER_HOST then no need to provide the Docker host URI. |
| CA path (.pem) | Select a valid ca.pem (Certificate authority that signed) file path. Note: If you want to secure your Docker client connections by default, you can move the files to the .docker directory in your home directory, and also set the DOCKER_TLS_VERIFY variables. |
| Cert Path (.pem) | Select valid cert.pem (Client certificate) file path. |
| Key Path (.pem) | Select valid Key.pem (Client key) file path. |
| Test Connection | Verifies if the connection is established or not. Note: Test connection verifies if the connection is established or not. Even if the SSL-TLS connection parameters are not provided, the verification of the connection is done based on the settings provided in the connection documentation. |
| INPUT tab: | Input fields |
| Image ID/Name | Select one or more Image IDs or Names to delete the image. Note: If the image is pulled with the image tag then the best practice is to provide an image name with a tag like <ImageName>:<ImageTag>. Example => Java:8Format to provide multiple image IDs/Names => |
| Name1,Name2,id1 or name1;name2;id1 The field data type is String. This field is mandatory. | |
| Remove Image Forcefully | Select Yes or No from the dropdown. Select Yes to remove an image forcefully even if it is being used by stopped containers or has other tags. Default value is No. |
| Remove Untagged Parent Images | Select Yes or No from the dropdown. Select Yes to remove an image, along with any untagged parent images that were referenced by that image. Default value: No. |
| Max Wait For Response (Sec) | Select the amount of time to wait for a response. The default value is 10 sec. |