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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: kubernetes.core.k8s_taint.

Добавлено в kubernetes.core 2.3.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Ограничение позволяет запретить планирование Pod на узле, если у этого Pod нет соответствующего допуска.
При необходимости ограничение можно снять с узла.

Требования

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

python >= 3.9
kubernetes >= 24.2.0

Параметры

Параметр	Комментарии
api_key string	Токен для аутентификации при обращении к API. Также можно задать с помощью переменной окружения K8S_AUTH_API_KEY.
ca_cert псевдонимы: ssl_ca_cert path	Путь к сертификату CA, используемому для аутентификации при обращении к API. Во избежание ошибок проверки сертификата необходимо указать всю цепочку сертификатов. Также можно задать с помощью переменной окружения K8S_AUTH_SSL_CA_CERT.
client_cert псевдонимы: cert_file path	Путь к сертификату, используемому для аутентификации при обращении к API. Также можно задать с помощью переменной окружения K8S_AUTH_CERT_FILE.
client_key псевдонимы: key_file path	Путь к файлу ключа, используемому для аутентификации при обращении к API. Также можно задать с помощью переменной окружения K8S_AUTH_KEY_FILE.
context string	Имя контекста из файла конфигурации. Также можно задать с помощью переменной окружения K8S_AUTH_CONTEXT.
host string	URL для доступа к API. Также можно задать с помощью переменной окружения K8S_AUTH_HOST.
impersonate_groups list / элементы=string добавлено в kubernetes.core 2.3.0	Группа или группы, от имени которых выполняется операция. Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2
impersonate_user string добавлено в kubernetes.core 2.3.0	Имя пользователя, от имени которого выполняется операция. Также можно задать с помощью переменной окружения K8S_AUTH_IMPERSONATE_USER.
kubeconfig any	Путь к существующему файлу конфигурации Kubernetes. Если он не указан и не заданы другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно задать с помощью переменной окружения K8S_AUTH_KUBECONFIG. Можно указать несколько файлов конфигурации Kubernetes, разделив их символом «;» в Windows или символом «:» на других платформах. Конфигурацию Kubernetes можно передать в виде словаря. Для этого требуется версия клиента Python Kubernetes >= 17.17.0. Добавлено в версии 2.2.0.
name string / обязательный	Имя узла.
no_proxy string добавлено в 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 string	Пароль для аутентификации при обращении к API. Также можно задать с помощью переменной окружения K8S_AUTH_PASSWORD. Описание параметра `username` содержит сведения о случаях, когда применим этот параметр.
persist_config boolean	Сохранять ли токены обновления конфигурации kube. Также можно задать с помощью переменной окружения K8S_AUTH_PERSIST_CONFIG. Если контекст k8s использует учётные данные пользователя с токенами обновления (например, аутентификацию oidc или gke/gcloud), токен обновляется клиентской библиотекой Python k8s, но по умолчанию не сохраняется. В результате срок действия старого токена обновления может истечь, и следующая попытка аутентификации завершится ошибкой. Если установить этот флаг в true, клиент Python k8s сохранит новый токен обновления в файл конфигурации kube. По умолчанию — false. Обратите внимание: текущая версия клиентской библиотеки Python k8s пока не поддерживает установку этого флага в True. Исправление для этой библиотеки Python k8s доступно здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `false` `true`
proxy string	URL HTTP-прокси, используемого для подключения. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY. Обратите внимание: этот модуль не считывает стандартные параметры прокси из окружения (например, HTTP_PROXY).
proxy_headers dictionary добавлено в 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	Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.
proxy_basic_auth string	Имя пользователя и пароль, разделённые двоеточием, для заголовка базовой аутентификации прокси. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.
user_agent string	Строка, задающая желаемое значение user-agent, например foo/1.0. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
replace boolean	Если `true`, разрешить замену ограничений. Варианты: `false` ← (по умолчанию) `true`
state string	Определяет, следует ли добавлять или удалять ограничения. Варианты: `"present"` ← (по умолчанию) `"absent"`
taints list / элементы=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 псевдонимы: 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 complex	Объект Node с применёнными ограничениями. При удалении будет пустым. Возвращается: success
api_version string	Версия схемы, описывающей этот объект. Возвращается: success
kind string	Тип REST-ресурса, который представляет этот объект. Возвращается: success
metadata complex	Стандартные метаданные объекта. Включают имя, пространство имён, аннотации, метки и т. д. Возвращается: success
spec complex	Специфичные атрибуты объекта. Их состав зависит от значений api_version и kind. Возвращается: success
status complex	Сведения о текущем состоянии объекта. Возвращается: success

Авторы

Alina Buzachis (@alinabuzachis)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/kubernetes/core/k8s_taint_module.html