Skip to content

Docker Inventory ​

Docker Inventory shows Docker runtime data reported by endpoint agents.

The endpoint Docker tab shows the latest Docker inventory for one endpoint. Fleet-wide Docker image and container pages use the same collected data for cross-endpoint investigation.

The tab is available on agent endpoints when Docker inventory exists or when Docker inventory can be collected for that endpoint.

Docker support is currently Linux-only in the agent.

Collection ​

Use the Collect Docker inventory job step, or the endpoint inventory recollect action, to refresh the tab.

The agent reads Docker through its configured Docker connection:

  • default Unix socket: /var/run/docker.sock
  • optional TLS Docker endpoint configured in the agent config

For TLS Docker access, configure:

  • docker.host
  • docker.client_certificate_path
  • docker.client_key_path
  • optionally docker.ca_bundle_path

Do not configure docker.socket_path together with docker.host.

Inspect and operate containers ​

Use the endpoint Docker view to investigate container state, images, storage, and networks. You can start, stop, and restart containers and inspect their logs. Volumes and networks are read-only inventory.

Use the Updates column in Docker → Containers to find available image updates and open the image's inventory overview before planning maintenance.

For cross-endpoint investigation, use Docker Images, Docker Containers, or the Docker Updates report.

Compose discovery depends on existing containers. A project without containers may be absent from inventory.

An AI agent can help you review Docker updates before preparing a job.

Docker Compose Jobs ​

Docker Compose management is available through job steps only.

The job steps expect the compose file to already exist on the endpoint. Ordyn does not upload, edit, or generate compose files for these steps.

Available compose actions:

  • Docker Compose up
  • Docker Compose down
  • Docker Compose stop
  • Docker Compose restart
  • Docker Compose update
  • Update Ordyn API
  • Docker Compose exec

Docker Compose update runs pull and then up -d --remove-orphans. Enable Force recreate containers on Compose up/update job steps when unchanged containers should be recreated explicitly.

Docker Compose exec runs a non-interactive shell command inside a service from the compose project. It uses the configured compose file path list and service name, then runs the command through sh -lc inside the container.

Update Ordyn API updates Ordyn and its database on the job target endpoint. See Update Ordyn API for setup and update logs.

Compose jobs accept multiple compose files. Ordyn passes each path as its own -f argument, preserving Docker Compose override-file behavior.

Discovered Compose projects are available to job loops as endpoint.docker.compose_projects. Each project contains:

FieldTypeDescription
projectstring or nullCompose project name reported by the running containers.
working_dirstring or nullProject working directory reported by Compose.
config_filesstring listUnique Compose file paths reported for the project, including override files. Projects without a reported config file are omitted.
servicesstring listUnique Compose service names reported by the project containers.
compose_image_parseobjectWhether uninterpolated service images were parsed. status is parsed or unavailable; reason identifies why parsing was unavailable.
service_imagesobject listUninterpolated Compose image references and parsed tag metadata for each service.
image_updatesobject listNewer tracked tags available for images used by this project.

Each image_updates item contains:

FieldTypeDescription
compose_servicestringCompose service using the image.
image_identifierstringDocker image identifier reported by the endpoint.
registry_hoststringRegistry containing the image.
repository_namestringRepository path inside the registry.
current_referencestringNormalized image reference currently used by the service.
current_tagstringTag currently used by the service.
newest_available_tagstringNewer tag selected by the applicable tracking policy.
newest_available_referencestringComplete registry, repository, and newer tag reference.
checked_atstring or nullTime of the successful cached registry check.
tracking_strategystring or nullTracking strategy used to select the newer tag.
compose_tagobject or nullParsed Compose tag metadata for the service image.

The compose_tag object contains:

FieldTypeDescription
rawstringTag text from the uninterpolated Compose image, such as ${API_TAG:-latest} or 1.4.0.
variable_namestring or nullEnvironment variable that can safely receive a complete replacement tag.
operatorstring or nullCompose interpolation operator, such as :- or :?.
is_variablebooleanWhether the tag contains Compose variable interpolation.
is_updateablebooleanWhether the complete tag can safely be updated through one environment variable.

Whole-tag variables such as $API_TAG, ${API_TAG}, ${API_TAG:-latest}, and ${API_TAG:?required} are updateable. Literal tags and expressions containing prefixes, suffixes, alternatives, multiple variables, nested variables, or digest pins are not updateable.

Use a for_each step over endpoint.docker.compose_projects, followed by a nested loop over loop.vars.compose_project.image_updates. When compose_tag.is_updateable is true, use a Write key/value file value step with operation Update existing, key compose_tag.variable_name, and value newest_available_tag. Run the Compose action as a later, separate step.

The job must provide the target dotenv path explicitly. Compose values can come from the shell, the default .env, or a custom environment file, so the parsed variable name does not identify which file a workflow should edit. An empty image_updates list means that the existing configured tags remain unchanged; a Compose update can still pull newer image content published behind those tags.

The context uses the latest saved inventory and successful image checks. A collection step does not guarantee that a following loop sees new inventory or completed registry checks. Plan updates from reviewed results; an empty image_updates list does not prove that every image is current.

See Docker Compose update for a complete generic update example and Update Ordyn API for the API-specific workflow.