Модуль community.docker.docker_container_exec — Выполнение команды в контейнере Docker

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.docker. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

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

Новый в community.docker 1.5.0

Обзор
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Обзор

Выполняет команду в контейнере Docker.

Требования

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

API Docker >= 1.25
backports.ssl_match_hostname (при использовании TLS в Python 2)
paramiko (при использовании SSH с use_ssh_client=false)
pyOpenSSL (при использовании TLS)
pywin32 (при использовании именованных каналов на Windows 32)
requests

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version строка	Версия Docker API, работающая на Docker хосте. По умолчанию используется последняя версия API, поддерживаемая этим сбором и демоном docker. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, используется значение по умолчанию. По умолчанию: `"auto"`
argv список / элементы=строка	Команда для выполнения. Поскольку это список аргументов, цитирование не требуется. Должен быть указан ровно один из `argv` или `command`.
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path путь	Используйте сертификат УЦ для проверки сервера, указав путь к файлу сертификата УЦ. Если значение не указано в задаче и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Этот параметр назывался `ca_cert` и был переименован в `ca_path` в community.docker 3.6.0. Старое имя добавлено в качестве псевдонима и по-прежнему может использоваться.
chdir строка	Каталог для выполнения команды.
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`.
command строка	Команда для выполнения. Должен быть указан ровно один из `argv` или `command`.
container строка / обязательно	Имя контейнера для выполнения команды.
debug логический тип	Режим отладки Варианты: `false` ← (по умолчанию) `true`
detach логический тип добавлен в community.docker 2.1.0	Выполнять команду синхронно (`detach=false`, по умолчанию) или асинхронно (`detach=true`). Если установлено значение `true`, `stdin` не может быть предоставлено, и значения возврата `stdout`, `stderr`, и `rc` не возвращаются. Варианты: `false` ← (по умолчанию) `true`
docker_host псевдонимы: docker_url строка	URL или путь к Unix-сокету для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, используется значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
env словарь добавлен в community.docker 2.1.0	Словарь переменных окружения с соответствующими значениями, которые будут переданы команде, запущенной внутри контейнера. Значения, которые могут быть распарсены как числа, булевы значения или другие типы парсером YAML, должны быть заключены в кавычки (например, `"true"`) для предотвращения потери данных. Обратите внимание, что если вы передаёте значения с использованием шаблонов Jinja2, например `"{{ value }}"`, вам необходимо добавить `\| string` для предотвращения преобразования Ansible строк, таких как `"true"`, обратно в булевы значения. Правильный способ — использовать `"{{ value \| string }}"`.
ssl_version строка	Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_SSL_VERSION`.
stdin строка	Установите stdin команды непосредственно на указанное значение. Может быть использован только если `detach=false`.

stdin_add_newline boolean	Если установлено в `true`, добавляет новую строку к `stdin`. Варианты: `false` `true` ← (по умолчанию)
strip_empty_ends boolean	Удаляет пустые строки из конца stdout/stderr в результате. Варианты: `false` `true` ← (по умолчанию)
timeout integer	Максимальное время в секундах ожидания ответа от API. Если значение не указано в задании, будет использовано значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `60`
tls boolean	Защищает подключение к API с использованием TLS без проверки подлинности сервера Docker. Обратите внимание, что если `validate_certs` также установлено в `true`, оно будет иметь приоритет. Если значение не указано в задании, будет использовано значение переменной окружения `DOCKER_TLS`. Если переменная окружения не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname string	При проверке подлинности сервера Docker укажите ожидаемое имя сервера. Если значение не указано в задании, будет использовано значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не задана, будет использовано значение по умолчанию. Обратите внимание, что этот параметр имел значение по умолчанию `localhost` в более ранних версиях. Он был удалён в community.docker 3.0.0.
tty boolean	Признак выделения TTY. Варианты: `false` ← (по умолчанию) `true`
use_ssh_client boolean добавлен в community.docker 1.5.0	Для SSH-транспортов использовать утилиту командной строки `ssh` вместо paramiko. Варианты: `false` ← (по умолчанию) `true`
user string	Если указано, пользователь, с которым будет выполняться эта команда.
validate_certs aliases: tls_verify boolean	Защищает подключение к API с использованием TLS и проверяет подлинность сервера Docker. Если значение не указано в задании, будет использовано значение переменной окружения `DOCKER_TLS_VERIFY`. Если переменная окружения не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.docker.docker, docker	Используйте `group/docker` или `group/community.docker.docker` в `module_defaults` для установки значений по умолчанию для данного модуля.
check_mode	Поддержка: нет	Может работать в режиме проверки и возвращать прогноз изменения статуса без изменения целевого объекта.
diff_mode	Поддержка: нет	Возвращает подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), при использовании режима сравнения.

Примечания

Примечание

Не работает с сокетами TCP TLS при использовании stdin. Это вызвано невозможностью отправки close_notify без закрытия соединения с SSLSocket Python. Подробнее см. https://github.com/ansible-collections/community.docker/issues/605.
Если вам нужно оценить переменные среды контейнера в command или argv, необходимо передать команду через оболочку, например, command=/bin/sh -c "echo $ENV_VARIABLE".
Подключение к демону 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 SDK для Python для связи с демоном Docker. Он использует код, полученный из Docker SDK или Python, включённый в эту коллекцию.

Примеры

- name: Run a simple command (command)
  community.docker.docker_container_exec:
    container: foo
    command: /bin/bash -c "ls -lah"
    chdir: /root
  register: result

- name: Print stdout
  ansible.builtin.debug:
    var: result.stdout

- name: Run a simple command (argv)
  community.docker.docker_container_exec:
    container: foo
    argv:
      - /bin/bash
      - "-c"
      - "ls -lah > /dev/stderr"
    chdir: /root
  register: result

- name: Print stderr lines
  ansible.builtin.debug:
    var: result.stderr_lines

Значения возврата

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

Ключ	Описание
exec_id строка добавлено в community.docker 2.1.0	Идентификатор выполнения команды. Возвращаемое значение: успех и `detach=true` Пример: `"249d9e3075655baf705ed8f40488c5e9434049cf3431976f1bfdb73741c574c5"`
rc целое число	Код завершения команды. Возвращаемое значение: успех и `detach=false` Пример: `0`
stderr строка	Вывод стандартной ошибки контейнерной команды. Возвращаемое значение: успех и `detach=false`
stdout строка	Вывод стандартного вывода контейнерной команды. Возвращаемое значение: успех и `detach=false`

Авторы

Felix Fontein (@felixfontein)

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

© 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/docker_container_exec_module.html