community.kubernetes.k8s_exec – Выполнение команды в Pod

Примечание

Этот плагин входит в сборку community.kubernetes (версия 1.1.1).

Для его установки используйте: ansible-galaxy collection install community.kubernetes.

Для использования в книге задач укажите: community.kubernetes.k8s_exec.

Новое в версии 0.10.0: модуля community.kubernetes

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

Обзор

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

Примечание

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

Требования

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

python >= 2.7
openshift == 0.4.3
PyYAML >= 3.11

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка		Токен, используемый для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_API_KEY.
ca_cert путь		Путь к сертификату CA, используемому для аутентификации с API. Для предотвращения ошибок проверки сертификата необходимо указать полный цепочку сертификатов. Также можно указать через переменную окружения K8S_AUTH_SSL_CA_CERT. псевдонимы: ssl_ca_cert
client_cert путь		Путь к сертификату, используемому для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_CERT_FILE. псевдонимы: cert_file
client_key путь		Путь к файлу ключа, используемому для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_KEY_FILE. псевдонимы: key_file
command строка / обязательно		Команда для выполнения
container строка		Имя контейнера в Pod для подключения. По умолчанию используется единственный контейнер, если в Pod только один контейнер.
context строка		Имя контекста, найденного в файле конфигурации. Также можно указать через переменную окружения K8S_AUTH_CONTEXT.
host строка		Укажите URL для доступа к API. Также можно указать через переменную окружения K8S_AUTH_HOST.
kubeconfig путь		Путь к существующему файлу конфигурации Kubernetes. Если не указан и не указаны другие параметры подключения, клиент OpenShift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также можно указать через переменную окружения K8S_AUTH_KUBECONFIG.
namespace строка / обязательно		Имя пространства Pod
password строка		Укажите пароль для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_PASSWORD. Обратитесь к описанию опции `username`, чтобы узнать, когда используется эта опция.
persist_config булево	Варианты: нет да	Сохранять или нет токены обновления конфигурации kube. Также можно указать через переменную окружения K8S_AUTH_PERSIST_CONFIG. Если контекст k8s использует учетные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), токен обновляется библиотекой k8s python, но по умолчанию не сохраняется. В результате старый токен обновления может истечь, и следующая аутентификация может завершиться ошибкой. Установка этого флага в значение true сообщит клиенту k8s python о сохранении нового токена обновления в файл конфигурации kube. По умолчанию значение false. Обратите внимание, что текущая версия библиотеки k8s python пока не поддерживает установку этого флага в значение True. Исправление для этой библиотеки k8s python находится здесь: https://github.com/kubernetes-client/python-base/pull/169
pod строка / обязательно		Имя Pod
proxy строка		URL HTTP-прокси, который нужно использовать для подключения. Также можно указать через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не использует типичные параметры прокси из среды (например, HTTP_PROXY).
username строка		Укажите имя пользователя для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными для использования HTTP Basic Auth. Если ваш кластер имеет другой вид аутентификации (например, OAuth2 в OpenShift), эта опция не будет работать должным образом, и вы должны обратиться к модулю `k8s_auth`, так как он может сделать то, что вам нужно.
validate_certs булево	Варианты: нет да	Проверять или нет сертификаты SSL сервера API. Также можно указать через переменную окружения K8S_AUTH_VERIFY_SSL. псевдонимы: verify_ssl

Примечания

Примечание

Код возврата return_code для выполненной команды добавлен в вывод в версии 1.0.0.
Клиент OpenShift Python оборачивает клиент K8s Python, предоставляя полный доступ ко всем API и моделям, доступным в обеих платформах. Подробную информацию о версиях API и дополнительную информацию см. на странице https://github.com/openshift/openshift-restclient-python
Чтобы избежать ошибок проверки SSL-сертификатов, когда validate_certs имеет значение True, необходимо предоставить полную цепочку сертификатов сервера API с помощью ca_cert или в файле kubeconfig.

Примеры

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

- name: Check RC status of command executed
  community.kubernetes.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.return_code != 0

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

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

Ключ		Возвращаемое значение	Описание
result сложный		успех	Объект команды
	return_code целое число	успех	Код состояния команды
	stderr строка	успех	Вывод команды в stderr
	stderr_lines строка	успех	Вывод команды в stderr
	stdout строка	успех	Вывод команды в stdout
	stdout_lines строка	успех	Вывод команды в stdout

Авторы

Tristan de Cacqueray (@tristanC)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/kubernetes/k8s_exec_module.html