Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию community.docker (версия 5.2.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.

Требования

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

  • API Docker >= 1.25
  • 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, а в community.docker 3.6.0 был переименован в ca_path. Старое имя добавлено как псевдоним и по-прежнему может использоваться.

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

images_filters

словарь

Словарь значений фильтров для выбора образов, которые нужно удалить.

Например, dangling: true.

Дополнительные сведения о возможных фильтрах см. в документации Docker.

networks

логическое значение

Следует ли очищать сети.

Варианты:

  • false ← (по умолчанию)
  • true

networks_filters

словарь

Словарь значений фильтров для выбора сетей, которые нужно удалить.

Дополнительные сведения о возможных фильтрах см. в документации Docker.

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 вместо paramiko.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

псевдонимы: 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).

idempotent

Поддержка: полная

При повторном запуске с теми же аргументами вне режима проверки второй запуск сообщает об отсутствии изменений.

Предполагается, что система, которой управляет модуль или данные которой он запрашивает, не изменилась существенным образом.

Примечания

Примечание

  • До community.docker 3.5.1 модуль всегда возвращал changed=false.
  • Подключайтесь к демону Docker, указывая параметры в каждой задаче или задавая переменные окружения. Можно задать DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите поставляемый с продуктом скрипт настройки окружения. Он задаст эти переменные. Подробнее см. на странице https://docs.docker.com/machine/reference/env/.
  • Этот модуль не использует Docker SDK for 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

list / elements=string

added in community.docker 3.10.0

Удалённые кэши сборки.

Возвращается: builder_cache=true и версия API — 1.39 или более поздняя

Пример: []

builder_cache_space_reclaimed

integer

Объём освобождённого дискового пространства в байтах при очистке кэша сборки.

Возвращается: builder_cache=true

Пример: 0

containers

list / elements=string

Список идентификаторов удалённых контейнеров.

Возвращается: containers=true

Пример: []

containers_space_reclaimed

integer

Объём освобождённого дискового пространства в байтах при очистке контейнеров.

Возвращается: containers=true

Пример: 0

images

list / elements=string

Список идентификаторов удалённых образов.

Возвращается: images=true

Пример: []

images_space_reclaimed

integer

Объём освобождённого дискового пространства в байтах при очистке образов.

Возвращается: images=true

Пример: 0

networks

list / elements=string

Список идентификаторов удалённых сетей.

Возвращается: networks=true

Пример: []

volumes

list / elements=string

Список идентификаторов удалённых томов.

Возвращается: volumes=true

Пример: []

volumes_space_reclaimed

integer

Объём освобождённого дискового пространства в байтах при очистке томов.

Возвращается: volumes=true

Пример: 0

Авторы

  • Felix Fontein (@felixfontein)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Запросить помощь (Docker)
  • Запросить помощь (Docker Compose)
  • Запросить помощь (Docker Swarm)
  • Сообщить об ошибке
  • Запросить новую функцию
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API