Модуль kubernetes.core.k8s_exec — выполнение команды в Pod

Примечание

Этот модуль входит в коллекцию kubernetes.core (версия 6.4.0).

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

Для установки используйте: ansible-galaxy collection install kubernetes.core. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в playbook, укажите: kubernetes.core.k8s_exec.

Добавлено в kubernetes.core 0.10.0

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

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

Использует клиент Kubernetes для Python для выполнения команд в подах K8s.

Примечание

Для этого модуля предусмотрен соответствующий плагин действий.

Требования

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

python >= 3.9
kubernetes >= 24.2.0
PyYAML >= 3.11

Параметры

Параметр	Комментарии
api_key строка	Токен для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_API_KEY.
ca_cert псевдонимы: ssl_ca_cert путь	Путь к сертификату ЦС, используемому для аутентификации в API. Чтобы избежать ошибок проверки сертификата, необходимо указать всю цепочку сертификатов. Также можно задать с помощью переменной окружения K8S_AUTH_SSL_CA_CERT.
client_cert псевдонимы: cert_file путь	Путь к сертификату, используемому для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_CERT_FILE.
client_key псевдонимы: key_file путь	Путь к файлу ключа, используемого для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_KEY_FILE.
command строка / обязательный	Команда для выполнения.
container строка	Имя контейнера в поде, к которому нужно подключиться. Если в поде только один контейнер, по умолчанию используется он. Если параметр не указан, будет выбран первый контейнер в заданном поде, как это делает командная строка kubectl.
context строка	Имя контекста из файла конфигурации. Также можно задать с помощью переменной окружения K8S_AUTH_CONTEXT.
host строка	URL для доступа к API. Также можно задать с помощью переменной окружения K8S_AUTH_HOST.
impersonate_groups список / элементы=строка добавлено в kubernetes.core 2.3.0	Группа или группы, от имени которых выполняется операция. Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2
impersonate_user строка добавлено в kubernetes.core 2.3.0	Имя пользователя, от имени которого выполняется операция. Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_USER.
kubeconfig любой тип	Путь к существующему файлу конфигурации Kubernetes. Если путь не указан и другие параметры подключения также не заданы, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно задать с помощью переменной окружения K8S_AUTH_KUBECONFIG. Можно указать несколько файлов конфигурации Kubernetes, используя в качестве разделителя «;» в Windows или «:» на других платформах. Конфигурацию Kubernetes можно задать в виде словаря. Для этой возможности требуется версия клиента Kubernetes для Python >= 17.17.0. Добавлено в версии 2.2.0.
namespace строка / обязательный	Имя пространства имён пода.
no_proxy строка добавлено в kubernetes.core 2.3.0	Разделённый запятыми список хостов/доменов/IP/CIDR, для которых не следует использовать прокси. Также можно задать с помощью переменной окружения K8S_AUTH_NO_PROXY. Обратите внимание: этот модуль не использует стандартные настройки прокси из окружения (например, NO_PROXY). Для этой возможности требуется kubernetes>=19.15.0. Если версия библиотеки kubernetes ниже 19.15.0, модуль завершится с ошибкой, даже если no_proxy задан корректно. Пример значения: “localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16”
password строка	Пароль для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_PASSWORD. Описание параметра `username` содержит сведения о случаях применения этого параметра.
persist_config логический	Сохранять ли токены обновления конфигурации kube. Также можно задать с помощью переменной окружения K8S_AUTH_PERSIST_CONFIG. Если контекст k8s использует учётные данные пользователя с токенами обновления (например, oidc или аутентификацию gke/gcloud), токен обновляется клиентской библиотекой k8s для Python, но по умолчанию не сохраняется. Поэтому срок действия старого токена обновления может истечь, и следующая попытка аутентификации завершится ошибкой. Если задать этому флагу значение true, клиентская библиотека k8s для Python будет сохранять новый токен обновления в файл конфигурации kube. По умолчанию — false. Обратите внимание: текущая версия клиентской библиотеки k8s для Python пока не поддерживает установку этого флага в True. Исправление для этой библиотеки k8s доступно здесь: https://github.com/kubernetes-client/python-base/pull/169 Допустимые значения: `false` `true`
pod строка / обязательный	Имя пода.
proxy строка	URL HTTP-прокси, используемого для подключения. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY. Обратите внимание: этот модуль не использует стандартные настройки прокси из окружения (например, HTTP_PROXY).
proxy_headers словарь добавлено в kubernetes.core 2.0.0	Заголовок, используемый для HTTP-прокси. Документация доступна здесь: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.
basic_auth строка	Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.
proxy_basic_auth строка	Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации прокси. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.
user_agent строка	Строка с нужным значением user-agent, например foo/1.0. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
username строка	Имя пользователя для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_USERNAME. Обратите внимание: этот параметр работает только с кластерами, настроенными на использование базовой HTTP-аутентификации. Если в кластере используется другой способ аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать ожидаемым образом. В таком случае используйте модуль community.okd.k8s_auth — возможно, он подойдёт для вашей задачи.
validate_certs псевдонимы: verify_ssl логический	Проверять ли SSL-сертификаты сервера API. Также можно задать с помощью переменной окружения K8S_AUTH_VERIFY_SSL. Допустимые значения: `false` `true`

Примечания

Примечание

Код возврата rc выполненной команды добавлен в вывод в версии 2.2.0; код возврата return_code считается устаревшим.
Код возврата return_code выполненной команды добавлен в вывод в версии 1.0.0.
У аутентифицированного пользователя должен быть как минимум доступ на чтение к ресурсу pods и доступ на запись к ресурсу pods/exec.
Чтобы избежать ошибок проверки SSL-сертификатов, когда validate_certs имеет значение True, необходимо предоставить полную цепочку сертификатов сервера API через ca_cert или в файле kubeconfig.

Примеры

- name: Execute a command
  kubernetes.core.k8s_exec:
    namespace: myproject
    pod: zuul-scheduler
    command: zuul-scheduler full-reconfigure

- name: Check RC status of command executed
  kubernetes.core.k8s_exec:
    namespace: myproject
    pod: busybox-test
    command: cmd_with_non_zero_exit_code
  register: command_status
  ignore_errors: True

- name: Check last command status
  debug:
    msg: "cmd failed"
  when: command_status.rc != 0

- name: Specify a container name to execute the command on
  kubernetes.core.k8s_exec:
    namespace: myproject
    pod: busybox-test
    container: manager
    command: echo "hello"

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

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

Ключ	Описание
result сложный	Объект команды Возвращается: при успехе
rc целое число добавлено в kubernetes.core 2.2.0	Код состояния команды Возвращается: при успехе
return_code целое число	Код состояния команды. Этот атрибут устарел и будет удалён в одном из будущих выпусков. Используйте rc. Возвращается: при успехе
stderr строка	Поток stderr команды Возвращается: при успехе
stderr_lines строка	Поток stderr команды Возвращается: при успехе
stdout строка	Поток stdout команды Возвращается: при успехе
stdout_lines строка	Поток stdout команды Возвращается: при успехе

Авторы

Tristan de Cacqueray (@tristanC)

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

© 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/kubernetes/core/k8s_exec_module.html