Docker: List Images
Description
Docker: List Images step is used to get list of images.
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 |
| Include All Images | Select Yes or No. Select Yes to show all images. Only images from a final layer (no children) are shown by default. Default is Yes. |
| Output Format | Select the formatting output pretty-prints container output using a Go template. Valid placeholders for the Go template are listed in Additional notes. |
| Digests | Select Yes or No. Select Yes to show the digests. Default value is No. |
| Truncate Output | Select Yes or No. Select Yes to truncate the output. Default value is Yes. |
| Filters | Specify the filters to process on the image list. |
| Max Wait For Response (Sec) | Specify the amount of time to wait for a response. The default value is 10 sec. |
| OUTPUT tab: | Output fields |
| Container List | Specify the output field to hold the containers list. Default value is ContainerList. |
Additional notes
- The filtering format is a key=value pair. If there is more than one filter, then pass multiple
values in comma(,) or semicolon(;) separated values. Example,
Key=value,key=value;key=value. Currently, supported filters are as follows:
| Filter | Description |
|---|---|
| dangling | Dangling=true or false |
| label | An arbitrary string representing either a key or a key-value pair. Expressed as label=<key> or label=<key>=”<value>” or label=<key>=<value> Note: If value contains space the use this format label=<key>=”<value>” |
| before or since | (<image-name>:<tag>, <image id> or <image@digest>) - filter images created before or since given id or references.Example, Before=java:8 |
| reference | reference (pattern of an image reference) - filter images whose reference matches the specified pattern. Example. reference=hello*:lat |
- Output Format Examples,
{{.ID}}or{{.ID}}: {{.Repository}}or table{{.ID}}\t{{.Repository}}\t{{.Tag}}. Following are available Go-Templates:
| Placeholder | Description |
|---|---|
| .ID | Image ID |
| .Repository | Image repository |
| .Tag | Image tag |
| .Digest | Image digest |
| .CreatedSince | Elapsed time since the image was created. |
| .CreatedAt | The time when the image was created. |
| .Size | Image disk size. |