docker_prune – Позволяет очистить различные объекты Docker

Новая в версии 2.8.

Синтаксис
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Синтаксис

Позволяет запускать docker container prune, docker image prune, docker network prune и docker volume prune через API Docker.

Требования

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

Docker API >= 1.25
Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (подробнее см. здесь). Этот модуль не работает с docker-py.
Docker SDK для Python >= 2.1.0
Python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version строка	По умолчанию: "auto"	Версия Docker API, работающая на Docker хосте. По умолчанию устанавливается последняя версия API, поддерживаемая Docker SDK для Python и демоном docker. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, используется значение по умолчанию. алиасы: docker_api_version
builder_cache логическое значение	Варианты: нет ← да	Очищать кэш билдера. Требуется версия Docker SDK для Python 3.3.0 или новее.
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
containers логическое значение	Варианты: нет ← да	Очищать контейнеры.
containers_filters словарь		Словарь значений фильтров для выбора контейнеров для удаления. Например, `until: 24h`. См. документацию docker для получения дополнительной информации о возможных фильтрах.
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
images логическое значение	Варианты: нет ← да	Очищать образы.
images_filters словарь		Словарь значений фильтров для выбора образов для удаления. Например, `dangling: true`. См. документацию docker для получения дополнительной информации о возможных фильтрах.
networks логическое значение	Варианты: нет ← да	Очищать сети.
networks_filters словарь		Словарь значений фильтров для выбора сетей для удаления. См. документацию docker для получения дополнительной информации о возможных фильтрах.
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
volumes логическое значение	Варианты: нет ← да	Очищать тома.
volumes_filters словарь		Словарь значений фильтров для выбора томов для удаления. См. документацию docker для получения дополнительной информации о возможных фильтрах.

Примечания

Примечание

Подключитесь к демону 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] с помощью pip.
Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать $HOME/.docker/config.json если переменная среды DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.

Примеры

- name: Prune containers older than 24h
  docker_prune:
    containers: yes
    containers_filters:
      # only consider containers created more than 24 hours ago
      until: 24h

- name: Prune everything
  docker_prune:
    containers: yes
    images: yes
    networks: yes
    volumes: yes
    builder_cache: yes

- name: Prune everything (including non-dangling images)
  docker_prune:
    containers: yes
    images: yes
    images_filters:
      dangling: false
    networks: yes
    volumes: yes
    builder_cache: yes

Значения возврата

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

Ключ	Возвращаемое значение	Описание
builder_cache_space_reclaimed целое число	builder_cache — `true`	Объем освобожденного дискового пространства из кэша сборщика (builder cache) в байтах. Пример: 0
containers список / элементы=строка	containers — `true`	Список идентификаторов удаленных контейнеров. Пример: []
containers_space_reclaimed целое число	containers — `true`	Объем освобожденного дискового пространства из очистки контейнеров в байтах. Пример: 0
images список / элементы=строка	images — `true`	Список идентификаторов удаленных образов. Пример: []
images_space_reclaimed целое число	images — `true`	Объем освобожденного дискового пространства из очистки образов в байтах. Пример: 0
networks список / элементы=строка	networks — `true`	Список идентификаторов удаленных сетей. Пример: []
volumes список / элементы=строка	volumes — `true`	Список идентификаторов удаленных томов. Пример: []
volumes_space_reclaimed целое число	volumes — `true`	Объем освобожденного дискового пространства из очистки томов в байтах. Пример: 0

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Felix Fontein (@felixfontein)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/docker_prune_module.html