Spec-Zone.ru › Ansible

Модуль community.docker.current_container_facts — возвращает сведения о том, выполняется ли модуль в контейнере

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.docker.

Чтобы использовать её в плейбуке, укажите: community.docker.current_container_facts.

Добавлено в community.docker 1.1.0

  • Краткое описание
  • Атрибуты
  • Примеры
  • Возвращаемые факты

Краткое описание

  • Возвращает сведения о том, выполняется ли модуль в контейнере Docker или podman.
  • Модуль пытается определить это с максимально возможной точностью. В некоторых особых случаях он может работать некорректно; если вы столкнулись с таким случаем, убедитесь, что проблема сохраняется в последней версии community.docker, и, если это так, сообщите о ней.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

Это действие не изменяет состояние.

Может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: не применимо

Это действие не изменяет состояние.

В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в check_mode).

facts

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

Действие возвращает словарь ansible_facts, который обновляет существующие факты узла.

idempotent

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

Это действие не изменяет состояние.

При повторном запуске подряд вне режима check mode с теми же аргументами второй вызов указывает на отсутствие изменений.

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

Примеры

---
- name: Get facts on current container
  community.docker.current_container_facts:

- name: Print information on current container when running in a container
  ansible.builtin.debug:
    msg: "Container ID is {{ ansible_module_container_id }}"
  when: ansible_module_running_in_container

Возвращаемые факты

Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляют их, и на них можно ссылаться по имени, как и на любые другие факты узла. Чтобы использовать их, регистрировать их не нужно.

Ключ

Описание

ansible_module_container_id

строка

Обнаруженный идентификатор контейнера.

Содержит пустую строку, если контейнер не обнаружен.

Возвращается: всегда

ansible_module_container_type

строка

Обнаруженная среда контейнера.

Содержит пустую строку, если контейнер не обнаружен, или непустую строку, идентифицирующую среду контейнера.

docker означает, что модуль выполнялся в обычном контейнере Docker.

azure_pipelines означает, что модуль выполнялся в Azure Pipelines. Похоже, сейчас это значение больше не возвращается.

github_actions означает, что модуль выполнялся в контейнере Docker в GitHub Actions. Поддерживается начиная с community.docker 2.4.0.

podman означает, что модуль выполнялся в обычном контейнере Podman. Поддерживается начиная с community.docker 3.3.0.

Возвращается: всегда

Возможные значения:

  • ""
  • "docker"
  • "azure_pipelines"
  • "github_actions"
  • "podman"

ansible_module_running_in_container

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

Удалось ли модулю определить, что он выполняется в контейнере.

Возвращается: всегда

Авторы

  • 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/current_container_facts_module.html

Spec-Zone.ru

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