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

Примечание

Этот плагин входит в коллекцию kubernetes.core (версия 1.1.1).

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

Для использования в плейбуке укажите: kubernetes.core.k8s_exec.

Новое в версии 0.10.0: из kubernetes.core

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

Обзор

Используйте 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
  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.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/kubernetes/core/k8s_exec_module.html