Модуль community.docker.docker_prune – Позволяет очистить различные объекты Docker

Примечание

Этот модуль входит в коллекцию community.docker (версия 3.13.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.docker. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.docker.docker_prune.

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

Описание

Позволяет выполнять docker container prune, docker image prune, docker network prune и docker volume prune через API Docker.

Требования

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

Docker API >= 1.25
backports.ssl_match_hostname (при использовании TLS в Python 2)
paramiko (при использовании SSH с use_ssh_client=false)
pyOpenSSL (при использовании TLS)
pywin32 (при использовании именованных каналов на Windows 32)
requests

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version строка	Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая этим модулем и демоном docker. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `"auto"`
builder_cache логическое	Выполнить очистку кэша билдера. Варианты: `false` ← (по умолчанию) `true`
builder_cache_all логическое добавлен в community.docker 3.10.0	Удалить все типы кэша билда. Варианты: `false` ← (по умолчанию) `true`
builder_cache_filters словарь добавлен в community.docker 3.10.0	Словарь фильтров, используемых для выбора изображений для удаления. Например, `until: 10m`. См. документацию API для получения дополнительной информации о возможных фильтрах.
builder_cache_keep_storage строка добавлен в community.docker 3.10.0	Объем дискового пространства для хранения кэша в формате `<number>[<unit>]`. Число — положительное целое число. Единица измерения может быть одной из `B` (байт), `K` (кибибайт, 1024Б), `M` (мебибайт), `G` (гибибайт), `T` (тебибайт) или `P` (пебибайт). Опускание единицы измерения по умолчанию предполагает байты.
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path путь	Использование сертификата CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Этот параметр назывался `ca_cert` и был переименован в `ca_path` в community.docker 3.6.0. Старое имя добавлено как псевдоним и может по-прежнему использоваться.
client_cert псевдонимы: tls_client_cert, cert_path путь	Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
client_key псевдонимы: tls_client_key, key_path путь	Путь к файлу TLS-ключа клиента. Если значение не указано в задаче и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
containers логическое	Очистить контейнеры. Варианты: `false` ← (по умолчанию) `true`
containers_filters словарь	Словарь значений фильтров, используемых для выбора контейнеров для удаления. Например, `until: 24h`. См. документацию docker для получения дополнительной информации о возможных фильтрах.
debug логическое	Режим отладки Варианты: `false` ← (по умолчанию) `true`
docker_host псевдонимы: docker_url строка	URL или путь к сокету Unix, используемый для подключения к API Docker. Для подключения к удаленному хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
images логическое	Очистить изображения. Варианты: `false` ← (по умолчанию) `true`

END_OF_DOCUMENT_MARKER

images_filters словарь	Словарь значений фильтров, используемых для выбора изображений, которые нужно удалить. Например, `dangling: true`. См. документацию Docker для получения дополнительной информации о возможных фильтрах.
networks логическое	Нужно ли очищать сети. Варианты: `false` ← (по умолчанию) `true`
networks_filters словарь	Словарь значений фильтров, используемых для выбора сетей, которые нужно удалить. См. документацию Docker для получения дополнительной информации о возможных фильтрах.
ssl_version строка	Укажите допустимый номер версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_SSL_VERSION`.
timeout целое число	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не установлена, будет использовано значение по умолчанию. По умолчанию: `60`
tls логическое	Обеспечьте безопасное соединение с API, используя TLS без проверки подлинности сервера Docker. Обратите внимание, что если `validate_certs` также установлено в `true`, оно будет иметь приоритет. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TLS`. Если переменная окружения не установлена, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname строка	При проверке подлинности сервера Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не установлена, будет использовано значение по умолчанию. Обратите внимание, что этот параметр имел значение по умолчанию `localhost` в более ранних версиях. Он был удален в community.docker 3.0.0.
use_ssh_client логическое добавлен в community.docker 1.5.0	Для SSH-транспортов используйте утилиту `ssh` CLI вместо paramiko. Варианты: `false` ← (по умолчанию) `true`
validate_certs aliases: tls_verify логическое	Обеспечьте безопасное соединение с API, используя TLS и проверяя подлинность сервера Docker. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TLS_VERIFY`. Если переменная окружения не установлена, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
volumes логическое	Нужно ли очищать тома. Варианты: `false` ← (по умолчанию) `true`
volumes_filters словарь	Словарь значений фильтров, используемых для выбора томов, которые нужно удалить. См. документацию Docker для получения дополнительной информации о возможных фильтрах.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.docker.docker, docker	Используйте `group/docker` или `group/community.docker.docker` в `module_defaults` для установки значений по умолчанию для данного модуля.
check_mode	Поддержка: нет	Может работать в `check_mode` и возвращать прогноз состояния изменения без изменения целевого объекта.
diff_mode	Поддержка: нет	Вернёт информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда используется режим diff.

Примечания

Примечание

Модуль всегда возвращал changed=false до community.docker 3.5.1.
Подключитесь к демону 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 SDK для Python для связи с демоном Docker. Он использует код, полученный из Docker SDK или Python, включённый в этот набор.

Примеры

- name: Prune containers older than 24h
  community.docker.docker_prune:
    containers: true
    containers_filters:
      # only consider containers created more than 24 hours ago
      until: 24h

- name: Prune containers with labels
  community.docker.docker_prune:
    containers: true
    containers_filters:
      # Prune containers whose "foo" label has value "bar", and
      # whose "bam" label has value "baz". If you only want to
      # compare one label, you can provide it as a string instead
      # of a list with one element.
      label:
        - foo=bar
        - bam=baz
      # Prune containers whose label "bar" does *not* have value
      # "baz". If you want to avoid more than one label, you can
      # provide a list of multiple label-value pairs.
      "label!": bar=baz

- name: Prune everything
  community.docker.docker_prune:
    containers: true
    images: true
    networks: true
    volumes: true
    builder_cache: true

- name: Prune everything (including non-dangling images)
  community.docker.docker_prune:
    containers: true
    images: true
    images_filters:
      dangling: false
    networks: true
    volumes: true
    builder_cache: true

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

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

Ключ	Описание
builder_cache_caches_deleted список / элементы=строка добавлен в community.docker 3.10.0	Удаленные кэши сборки. Возвращается: `builder_cache=true` и версия API 1.39 или выше Пример: `[]`
builder_cache_space_reclaimed целое число	Объем освобожденного дискового пространства из кэша сборки в байтах. Возвращается: `builder_cache=true` Пример: `0`
containers список / элементы=строка	Список идентификаторов удалённых контейнеров. Возвращается: `containers=true` Пример: `[]`
containers_space_reclaimed целое число	Объем освобожденного дискового пространства из удаления контейнеров в байтах. Возвращается: `containers=true` Пример: `0`
images список / элементы=строка	Список идентификаторов удалённых образов. Возвращается: `images=true` Пример: `[]`
... (rest of the table)

Авторы

Феликс Фонтейн (@felixfontein)

Ссылки на коллекцию

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