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 pods.
Примечание
Для данного модуля существует соответствующий плагин действий.
Требования
Ниже приведены требования к хосту, на котором выполняется данный модуль.
- 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. - Python-клиент OpenShift оборачивает Python-клиент K8s, предоставляя полный доступ ко всем 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_lines строка | успех | Вывод стандартной ошибки команды | |
| stdout строка | успех | Вывод стандартного вывода команды | |
| stdout_lines строка | успех | Вывод стандартного вывода команды | |
Авторы
- Tristan de Cacqueray (@tristanC)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_exec_module.html
