модуль community.docker.docker_context_info — получение информации о контекстах Docker для текущего пользователя

Примечание

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

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

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

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

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

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

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

Возвращает информацию о контекстах Docker.
Включает общую информацию, а также словарь contexts[].config, который можно использовать в качестве значений по умолчанию для модулей всех модулей community.docker, использующих группу значений по умолчанию модуля community.docker.docker.

Параметры

Параметр	Комментарии
cli_context string	Переопределение имени контекста по умолчанию. Предпочтительно использовать для выбора контекста при `only_current=true`; также используется для вычисления возвращаемых значений `contexts[].current` и `current_context_name`.
name string	Определенный контекст CLI Docker для запроса. Модуль завершится с ошибкой, если этот контекст не существует. Если нужно только проверить, существует ли контекст, не указывайте этот параметр и используйте Jinja2 для поиска в результирующем списке контекста с заданным именем. Взаимоисключающий параметр с `only_current`.
only_current boolean	Если задано значение `true`, `contexts` будет содержать только текущий контекст. Если задано значение `false` (по умолчанию), `contexts` будет содержать список всех контекстов, если не указан параметр `name`. Взаимоисключающий параметр с `name`. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).
idempotent	Поддержка: полная Это действие не изменяет состояние.	При повторном запуске с теми же аргументами вне режима проверки второй запуск сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или которую он опрашивает, не изменилась существенным образом.

Примеры

---
- name: Get infos on contexts
  community.docker.docker_context_info:
  register: result

- name: Show all contexts
  ansible.builtin.debug:
    msg: "{{ result.contexts }}"

- name: Get current context
  community.docker.docker_context_info:
    only_current: true
  register: docker_current_context

- name: Run community.docker modules with current context
  module_defaults:
    group/community.docker.docker: "{{ docker_current_context.contexts[0].config }}"
  block:
    - name: Task using the current context
      community.docker.docker_container:
        image: ubuntu:latest
        name: ubuntu
        state: started

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

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

Ключ	Описание
contexts list / элементы=dictionary	Список всех контекстов (параметры `only_current=false` и `name` не указаны), только текущий контекст (`only_current=true`) или запрошенный контекст (указан параметр `name`). Возвращается: при успешном выполнении
config dictionary	Если контекст предназначен для Docker, содержит значения параметров для настройки модулей community.docker на использование этого контекста. Обратите внимание, что точные значения, возвращаемые здесь, могут со временем измениться, если будут обнаружены несовместимости с существующими модулями. Цель состоит в том, чтобы эта конфигурация работала со всеми модулями коллекции, однако на данный момент мы не можем протестировать все возможные параметры конфигурации. Возвращается: при успешном выполнении Пример: `{}`
ca_path boolean	Сертификат CA, используемый для проверки сертификата демона Docker. Возвращается: при успешном выполнении, если контекст предназначен для Docker, присутствует конфигурация TLS и сертификат CA Пример: `"/path/to/ca-cert.pem"`
client_cert boolean	Сертификат клиента для аутентификации на демоне Docker. Возвращается: при успешном выполнении, если контекст предназначен для Docker, присутствует конфигурация TLS и информация о сертификате клиента Пример: `"/path/to/client-cert.pem"`
client_key boolean	Ключ сертификата клиента для аутентификации на демоне Docker. Возвращается: при успешном выполнении, если контекст предназначен для Docker, присутствует конфигурация TLS и информация о сертификате клиента Пример: `"/path/to/client-key.pem"`
docker_host string	Демон Docker, к которому нужно подключиться. Возвращается: при успешном выполнении, если контекст предназначен для Docker Пример: `"unix:///var/run/docker.sock"`
tls boolean	Должен ли контекст Docker использовать непроверяемое TLS-соединение. Возвращается: при успешном выполнении, если контекст предназначен для Docker Пример: `false`
validate_certs boolean	Должен ли контекст Docker использовать проверяемое TLS-соединение. Возвращается: при успешном выполнении, если контекст предназначен для Docker и присутствует конфигурация TLS Пример: `true`
current boolean	Является ли этот контекст текущим. Возвращается: при успешном выполнении Пример: `true`
description boolean	Описание контекста, если оно доступно. Возвращается: при успешном выполнении Пример: `"My context"`
meta_path string	Путь к каталогу метаданных контекста. Отсутствует для `contexts[].name=default`. Возвращается: при успешном выполнении Пример: `"/home/felix/.docker/contexts/meta/0123456789abcdef01234567890abcdef0123456789abcdef0123456789abcde"`
name boolean	Имя контекста. Возвращается: при успешном выполнении Пример: `"default"`
tls_path string	Путь к каталогу конфигурации TLS контекста. Отсутствует для `contexts[].name=default`. Возвращается: при успешном выполнении Пример: `"/home/user/.docker/contexts/tls/0123456789abcdef01234567890abcdef0123456789abcdef0123456789abcde/"`
current_context_name string	Имя текущего контекста Docker. Возвращается: при успешном выполнении Пример: `"default"`

Авторы

Felix Fontein (@felixfontein)

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

© 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_context_info_module.html