Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию community.docker (версия 3.13.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.
  • Этот модуль пытается определить это наилучшим образом. Могут быть особые случаи, в которых он не работает; если вы столкнетесь с таким случаем, пожалуйста, создайте отчет об ошибке.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

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

diff_mode

Поддержка: Нет данных

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

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

facts

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

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/docker/current_container_facts_module.html

Spec-Zone.ru

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