kubernetes.core.k8s_taint модуль — Отмечание узла в кластере Kubernetes/OpenShift

Примечание

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

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

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

Для использования в playbook, укажите: kubernetes.core.k8s_taint.

Новая функция в kubernetes.core 2.3.0

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

Обзор

Отметка позволяет узлу отклонять размещение Pod, если у Pod нет соответствующей толерантности.
Снятие отметки удалит отметки с узлов по мере необходимости.

Требования

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

python >= 3.9
kubernetes >= 24.2.0

Параметры

Параметр	Комментарии
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.
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 client >= 17.17.0. Добавлена в версии 2.2.0.
name строка / обязательно	Имя узла.
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`
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 string	Строка, представляющая пользовательский агент, такой как foo/1.0. Также может быть указана через переменную окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
replace boolean	Если `true`, разрешить замену пометок. Варианты: `false` ← (по умолчанию) `true`
state string	Определяет, добавить или удалить метки. Варианты: `"present"` ← (по умолчанию) `"absent"`
taints list / elements=dictionary / обязательно	Список, содержащий метки.
effect string	Эффект метки на Pod, не допускающие метку. Требуется, когда state=present. Варианты: `"NoSchedule"` `"NoExecute"` `"PreferNoSchedule"`
key string	Ключ метки, применяемый к узлу.
value string	Значение метки, соответствующее ключу метки.
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`

Примечания

Примечание

Чтобы избежать ошибок проверки SSL-сертификатов, когда validate_certs имеет значение True, полная цепочка сертификатов API-сервера должна быть предоставлена через ca_cert или в файле kubeconfig.

Примеры

- name: Taint node "foo"
  kubernetes.core.k8s_taint:
    state: present
    name: foo
    taints:
    - effect: NoExecute
      key: "key1"

- name: Taint node "foo"
  kubernetes.core.k8s_taint:
    state: present
    name: foo
    taints:
    - effect: NoExecute
      key: "key1"
      value: "value1"
    - effect: NoSchedule
      key: "key1"
      value: "value1"

- name: Remove taint from "foo".
  kubernetes.core.k8s_taint:
    state: absent
    name: foo
    taints:
    - effect: NoExecute
      key: "key1"
      value: "value1"

Значения возврата

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

Ключ	Описание
result сложное	Объект узла с метками. Будет пустым в случае удаления. Возвращено: success
api_version строка	Версионированная схема этого представления объекта. Возвращено: success
kind строка	Представляет REST-ресурс, который представляет этот объект. Возвращено: success
metadata сложное	Стандартные метаданные объекта. Включает имя, пространство имен, аннотации, метки и т. д. Возвращено: success
spec сложное	Конкретные атрибуты объекта. Будут различаться в зависимости от api_version и kind. Возвращено: success
status сложное	Текущие детали состояния объекта. Возвращено: success

Авторы

Alina Buzachis (@alinabuzachis)

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

© 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_taint_module.html