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

Примечание

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

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

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

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

Новая в kubernetes.core 0.10.0

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

Описание

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

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

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

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

Параметры

Параметр	Комментарии
api_key строка	Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY.
ca_cert алиасы: ssl_ca_cert путь	Путь к сертификату CA, используемому для аутентификации с 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 cmdline.
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 может быть предоставлена в виде словаря. Эта функция требует библиотеки python kubernetes версии >= 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 auth), токен обновляется библиотекой k8s python, но по умолчанию не сохраняется. Поэтому старый токен обновления может истечь, и следующая аутентификация может завершиться неудачей. Установка этого флага в true сообщит библиотеке k8s python о сохранении нового токена обновления в файл конфигурации kube. По умолчанию false. Обратите внимание, что текущая версия библиотеки k8s python еще не поддерживает установку этого флага в True. Исправление для этой библиотеки k8s python находится здесь: 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 string	Пользователь:пароль, разделенные двоеточием, для аутентификации по протоколу Basic. Также можно указать через переменную окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.
proxy_basic_auth string	Пользователь:пароль, разделенные двоеточием, для аутентификации прокси-сервера по протоколу Basic. Также можно указать через переменную окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.
user_agent string	Строка, представляющая пользовательского агента, например, foo/1.0. Также можно указать через переменную окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
username string	Укажите имя пользователя для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными для использования HTTP Basic Auth. Если ваш кластер использует другой метод аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует обратиться к модулю community.okd.k8s_auth, так как он может быть полезен.
validate_certs aliases: verify_ssl boolean	Проверять ли 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 complex	Объект команды Возвращаемое значение: успех
rc integer добавлен в kubernetes.core 2.2.0	Код состояния команды Возвращаемое значение: успех
return_code integer	Код состояния команды. Этот атрибут устарел и будет удален в будущей версии. Используйте rc вместо него. Возвращаемое значение: успех
stderr string	stderr команды Возвращаемое значение: успех
stderr_lines string	stderr команды Возвращаемое значение: успех
stdout string	stdout команды Возвращаемое значение: успех
stdout_lines string	stdout команды Возвращаемое значение: успех

Авторы

Tristan de Cacqueray (@tristanC)

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

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