Docker Inspect action is a premium action which allows you to output low-level information on Docker objects to a Continua CI variable.
A friendly name for this action (will be displayed in the actions workflow area).
Determines if this action will be run within the relevant stage.
The directory from where the Docker command will be run. If left empty, this defaults to the workspace folder.
The ID or name of the object (e.g. container, image, volume, network, node, service, or task) to inspect.
The type of object that we are inspecting:
If you leave this as 'Any', a container will be inspected in preference to an image with the same name.
Choose the query format to use to select a value from the command output.
The relevant input boxes below will be shown for entering the associated template or query as each option is selected.
This input box is shown when the 'Go template' option is chosen for Output Selection Format. Enter the template for selecting the required value. See the Docker command and log output documentation for examples. Command line option: --format
This input box is shown when the 'Json path' option is chosen for Output Selection Format. Enter a JSONPath expression for selecting the required value.
Tick this checkbox to prevent the build failing if no node is found in the output which matches the JSONPath expression. A warning will be logged to build log instead.
Tick to open a new Host tab to specify an alternative Docker host to the one local to the agent.
The version of Docker to use when running the Docker Inspect command. It is important that the correct version of Docker is installed on the agent.
The address of the host running the Docker daemon. This can be in the form of a URL or any IP4 Address. If a non-standard port is required simply use the <IPAddress>:<Port> specification format.
Tick to connect to the Docker host using TLS where the host is not verified against a CA.
This is available only if 'Use TLS' is ticked. Tick to verify the TLS certificate with a root authority.
When using Verify TLS, if the host's certification authority (CA) is not trusted by the agent, then the connection is not established.
The path to Docker host CA certificate file.
The path to Docker host certificate file
The path to a PEM format file containing the key for the accessing the Docker Host Certificate.
Select the name of the build variable to set with the result of the inspection.
Tick to ignore any errors setting the variable value. e.g. variable is the wrong type. A warning will be logged to build log instead.
Tick to include the total size of the files in the output if the type is a container. Docker command line argument: --size
The amount of information detail to display in the build log.
How long to wait for the action to finish running before timing out. Leaving this blank (or zero) will default to 86400 seconds (24 hours).
Tick to continue build on failure marking the action with a warning status.
If this is ticked, any warnings logged will not mark the action with a warning status.
Multiple environment variables can be defined - one per line. These are set before the command line is run.
If this is ticked, environment variable values are written to the build log.
Tick this checkbox to set up a list of new environment variables prefixed with 'ContinuaCI.' for all current system expression objects and variables.
This checkbox is visible only if the 'Generate system environment variables' checkbox is ticked.
If this is ticked, the values of any variables marked as sensitive will be masked with **** when setting system environment variables. Clear this to expose the values.