community.docker.docker_volume_info – Получение данных о томах Docker

Примечание

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

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

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

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

Обзор

Выполняет в основном ту же функцию, что и подкоманда «docker volume inspect» командной строки.

Требования

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

API Docker >= 1.21
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-сокету, используемый для подключения к API Docker. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, вместо него используется значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, используется значение по умолчанию. Псевдонимы: docker_url
name строка / обязательно		Имя тома для проверки. Псевдонимы: volume_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 volume
  community.docker.docker_volume_info:
    name: mydata
  register: result

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

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

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

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

Ключ	Возвращаемое значение	Описание
exists логический тип	всегда	Возвращает, существует ли том. Пример: True
volume словарь	успех	Результаты проверки тома для данного тома. Будет `none`, если том не существует. Пример: { "CreatedAt": "2018-12-09T17:43:44+01:00", "Driver": "local", "Labels": null, "Mountpoint": "/var/lib/docker/volumes/ansible-test-bd3f6172/_data", "Name": "ansible-test-bd3f6172", "Options": {}, "Scope": "local" }

Авторы

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_volume_info_module.html