Spec-Zone.ru › Ansible 2.10

community.general.docker_prune – Разрешает удаление различных объектов Docker

Примечание

Этот плагин является частью коллекции community.general (версия 1.3.2).

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

Чтобы использовать его в книге задач, укажите: community.general.docker_prune.

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

Описание

  • Разрешает выполнение 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"
Версия API Docker, работающая на хосте Docker.
По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном Docker.
Если значение не указано в задаче, вместо него будет использоваться значение переменной среды DOCKER_API_VERSION. Если переменная среды не задана, будет использовано значение по умолчанию.

псевдонимы: docker_api_version
builder_cache
логическое значение
    Варианты:
  • нет ←
  • да
Удалить кэш билдера?
Требуется версия 3.3.0 Docker SDK для Python или новее.
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] с помощью ansible.builtin.pip.
  • Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае, он будет использовать $HOME/.docker/config.json если переменная среды DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.

Примеры

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

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

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

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

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

Ключ Возвращаемое значение Описание
builder_cache_space_reclaimed
целое число
builder_cache — true
Объём освобожденного дискового пространства из кэша сборщика после его очистки в байтах.

Пример:
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


Авторы

  • Феликс Фонтейн (@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.10/collections/community/general/docker_prune_module.html

Spec-Zone.ru

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