community.docker.docker_container_info – Извлекает сведения о контейнере Docker

Примечание

Этот плагин входит в состав коллекции community.docker (версия 1.2.2).

Для его установки используйте: ansible-galaxy collection install community.docker.

Для использования в книге задач укажите: community.docker.docker_container_info.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Извлекает сведения о контейнере Docker.
В основном возвращает вывод docker inspect <name>, аналогично тому, что возвращает community.docker.docker_container для контейнера, который не отсутствует.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

API Docker >= 1.20
Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (подробнее см. здесь). Для Python 2.6 необходимо использовать docker-py. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке и удалении одного из модулей другой может перестать работать, и потребуется его повторная установка.
Docker SDK для Python >= 1.8.0 (для Python 2.6 используйте docker-py)

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version строка	Значение по умолчанию: "auto"	Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном Docker. Если значение не указано в задаче, используется значение переменной среды `DOCKER_API_VERSION`. Если переменная среды не задана, используется значение по умолчанию. псевдонимы: docker_api_version
ca_cert путь		Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и задана переменная среды `DOCKER_CERT_PATH`, используется файл `ca.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`. псевдонимы: tls_ca_cert, cacert_path
client_cert путь		Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче и задана переменная среды `DOCKER_CERT_PATH`, используется файл `cert.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`. псевдонимы: tls_client_cert, cert_path
client_key путь		Путь к файлу TLS-ключа клиента. Если значение не указано в задаче и задана переменная среды `DOCKER_CERT_PATH`, используется файл `key.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`. псевдонимы: tls_client_key, key_path
debug булево	Варианты: нет ← да	Режим отладки
docker_host строка	Значение по умолчанию: "unix://var/run/docker.sock"	URL или путь к Unix-сокету для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, используется значение переменной среды `DOCKER_HOST`. Если переменная среды не задана, используется значение по умолчанию. псевдонимы: docker_url
name строка / обязательно		Имя контейнера для проверки. При идентификации существующего контейнера имя может быть именем, длинным или коротким идентификатором контейнера.
ssl_version строка		Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, используется значение переменной среды `DOCKER_SSL_VERSION`.
timeout целое число	Значение по умолчанию: 60	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, используется значение переменной среды `DOCKER_TIMEOUT`. Если переменная среды не задана, используется значение по умолчанию.
tls булево	Варианты: нет ← да	Защитите соединение с API с помощью TLS без проверки подлинности хоста Docker. Обратите внимание, что если validate_certs также установлено в `yes`, будет применено это значение. Если значение не указано в задаче, используется значение переменной среды `DOCKER_TLS`. Если переменная среды не задана, используется значение по умолчанию.
tls_hostname строка	Значение по умолчанию: "localhost"	При проверке подлинности хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, используется значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не задана, используется значение по умолчанию.
validate_certs булево	Варианты: нет ← да	Защитите соединение с API с помощью TLS и проверьте подлинность хоста Docker. Если значение не указано в задаче, используется значение переменной среды `DOCKER_TLS_VERIFY`. Если переменная среды не задана, используется значение по умолчанию. псевдонимы: tls_verify

Примечания

Примечание

Подключайтесь к демону Docker, предоставляя параметры в каждой задаче или определяя переменные среды. Вы можете определить DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите предоставленный скрипт, который настраивает среду. Он задаст эти переменные за вас. Для получения более подробной информации см. https://docs.docker.com/machine/reference/env/.
При подключении к демону Docker с помощью TLS, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK для Python, версии 2.4 или новее, это можно сделать, установив docker[tls] с помощью ansible.builtin.pip.
Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень ограниченного числа функций. В общем случае он будет использовать $HOME/.docker/config.json если переменная среды DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.
Этот модуль использует Docker SDK для Python для взаимодействия с демоном Docker.

Примеры

- name: Get infos on container
  community.docker.docker_container_info:
    name: mydata
  register: result

- name: Does container exist?
  ansible.builtin.debug:
    msg: "The container {{ 'exists' if result.exists else 'does not exist' }}"

- name: Print information about container
  ansible.builtin.debug:
    var: result.container
  when: result.exists

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
container словарь	всегда	Сведения, представляющие текущее состояние контейнера. Соответствует выводу проверки Docker. Будет `none` если контейнер не существует. Пример: { "AppArmorProfile": "", "Args": [], "Config": { "AttachStderr": false, "AttachStdin": false, "AttachStdout": false, "Cmd": [ "/usr/bin/supervisord" ], "Domainname": "", "Entrypoint": null, "Env": [ "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" ], "ExposedPorts": { "443/tcp": {}, "80/tcp": {} }, "Hostname": "8e47bf643eb9", "Image": "lnmp_nginx:v1", "Labels": {}, "OnBuild": null, "OpenStdin": false, "StdinOnce": false, "Tty": false, "User": "", "Volumes": { "/tmp/lnmp/nginx-sites/logs/": {} }, ... }
exists булево	всегда	Возвращает, существует ли контейнер. Пример: True

Авторы

Felix Fontein (@felixfontein)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/docker/docker_container_info_module.html