pyinfra 3.x
Docker Facts¶
Facts about Docker containers, volumes and networks. These facts give you information from the view of the current inventory host. See the @docker Connector to use Docker containers as inventory directly.
See also: Docker Operations.
docker.DockerAuths¶
host.get_fact(DockerAuths)
Returns the list of registry servers the current user is authenticated
against, read from ${DOCKER_CONFIG:-$HOME/.docker}/config.json.
Returns an empty list if no config file exists or no auths are stored.
docker.DockerContainer¶
host.get_fact(DockerContainer, object_id)
Returns docker inspect output for a single Docker container.
docker.DockerContainerEnvs¶
host.get_fact(DockerContainerEnvs)
Returns environment variables for all Docker containers, keyed by container ID.
docker.DockerContainerFsChanges¶
host.get_fact(DockerContainerFsChanges, container_id)
Returns filesystem changes for a single container (docker diff) as a list of
{"path": ..., "change": "A"|"C"|"D"} entries.
docker.DockerContainerLabels¶
host.get_fact(DockerContainerLabels)
Returns labels for all Docker containers, keyed by container ID.
docker.DockerContainerMounts¶
host.get_fact(DockerContainerMounts)
Returns mounts for all Docker containers, keyed by container ID.
docker.DockerContainerNetworks¶
host.get_fact(DockerContainerNetworks)
Returns networks for all Docker containers, keyed by container ID.
docker.DockerContainerPorts¶
host.get_fact(DockerContainerPorts)
Returns published port bindings for all Docker containers, keyed by container ID.
docker.DockerContainerProcesses¶
host.get_fact(DockerContainerProcesses, container_id)
Returns processes running inside a single container (docker top) as a list of
column dicts. Column names follow the ps output header.
docker.DockerContainerStats¶
host.get_fact(DockerContainerStats)
Returns resource-usage stats for all running containers (docker stats) as a list
of dicts (one entry per container).
docker.DockerContainers¶
host.get_fact(DockerContainers)
Returns docker inspect output for all Docker containers.
docker.DockerImage¶
host.get_fact(DockerImage, object_id)
Returns docker inspect output for a single Docker image.
docker.DockerImageHistory¶
host.get_fact(DockerImageHistory, image_id)
Returns the layer history of a single image (docker history) as a list of dicts.
docker.DockerImageLabels¶
host.get_fact(DockerImageLabels)
Returns labels for all Docker images, keyed by image ID.
docker.DockerImageLayers¶
host.get_fact(DockerImageLayers)
Returns layer digests for all Docker images, keyed by image ID.
docker.DockerImages¶
host.get_fact(DockerImages)
Returns docker inspect output for all Docker images.
docker.DockerNetwork¶
host.get_fact(DockerNetwork, object_id)
Returns docker inspect output for a single Docker network.
docker.DockerNetworkLabels¶
host.get_fact(DockerNetworkLabels)
Returns labels for all Docker networks, keyed by network ID.
docker.DockerNetworks¶
host.get_fact(DockerNetworks)
Returns docker inspect output for all Docker networks.
docker.DockerPlugin¶
host.get_fact(DockerPlugin, object_id)
Returns docker plugin inspect output for a single Docker plugin.
docker.DockerPlugins¶
host.get_fact(DockerPlugins)
Returns docker plugin inspect output for all Docker plugins.
docker.DockerSingleMixin¶
host.get_fact(DockerSingleMixin, object_id)
docker.DockerSystemInfo¶
host.get_fact(DockerSystemInfo)
Returns docker system info output in JSON format.
docker.DockerVersion¶
host.get_fact(DockerVersion)
Returns the Docker version.
docker.DockerVolume¶
host.get_fact(DockerVolume, object_id)
Returns docker inspect output for a single Docker container.
docker.DockerVolumeLabels¶
host.get_fact(DockerVolumeLabels)
Returns labels for all Docker volumes, keyed by volume name.
docker.DockerVolumes¶
host.get_fact(DockerVolumes)
Returns docker inspect output for all Docker volumes.