Модуль kubernetes.core.k8s_drain — вывод узла из эксплуатации, запрет или разрешение планирования в кластере k8s

Примечание

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

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

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

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

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

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

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

Выводит узел из эксплуатации перед обслуживанием, как команда kubectl drain.
Cordon помечает узел как недоступный для планирования.
Uncordon помечает узел как доступный для планирования.
Указанный узел будет помечен как недоступный для планирования, чтобы на него не назначались новые поды.
Затем drain удаляет все поды, кроме зеркальных подов (которые нельзя удалить через API-сервер).

Примечание

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

Требования

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

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.
delete_options dictionary	Укажите параметры удаления подов. Этот параметр действует только если для `state` задано значение drain. По умолчанию: `{}`
delete_emptydir_data boolean добавлен в kubernetes.core 2.3.0	Продолжать, даже если есть поды, использующие emptyDir (локальные данные, которые будут удалены при выводе узла из эксплуатации). Варианты: `false` ← (по умолчанию) `true`
disable_eviction boolean	Принудительно использовать удаление вместо вытеснения при выводе узла из эксплуатации. Варианты: `false` ← (по умолчанию) `true`
force boolean	Продолжать, даже если есть поды, не управляемые ReplicationController, Job или DaemonSet. Варианты: `false` ← (по умолчанию) `true`
ignore_daemonsets boolean	Игнорировать поды, управляемые DaemonSet. Варианты: `false` ← (по умолчанию) `true`
terminate_grace_period integer	Укажите, сколько секунд ждать до принудительного завершения. Если значение не указано, будет использоваться период ожидания по умолчанию для типа объекта. Нулевое значение означает немедленное удаление.
wait_sleep integer	Количество секунд ожидания между проверками. Игнорируется, если не задано `wait_timeout`. По умолчанию: `5`
wait_timeout integer	Время ожидания удаления пода в секундах до прекращения ожидания; нулевое значение означает бесконечное ожидание.
host string	Укажите URL для доступа к API. Также можно задать с помощью переменной окружения K8S_AUTH_HOST.
impersonate_groups list / elements=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 auth), токен обновляется клиентской библиотекой python k8s, но по умолчанию не сохраняется. Поэтому старый токен обновления может истечь, и следующая аутентификация завершится ошибкой. Если установить этот флаг в true, клиентская библиотека python k8s сохранит новый токен обновления в файл конфигурации kube. По умолчанию — false. Обратите внимание: текущая версия клиентской библиотеки python k8s пока не поддерживает установку этого флага в True. Исправление для этой библиотеки python k8s находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `false` `true`
pod_selectors псевдонимы: label_selectors list / elements=string добавлен в kubernetes.core 3.0.0	Селектор меток для фильтрации подов на узле. Этот параметр действует только если для `state` задано значение drain.
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.
state string	Определяет, следует ли вывести узел из эксплуатации, запретить или разрешить планирование. Варианты: `"cordon"` `"drain"` ← (по умолчанию) `"uncordon"`
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: Drain node "foo", even if there are pods not managed by a ReplicationController, Job, or DaemonSet on it.
  kubernetes.core.k8s_drain:
    state: drain
    name: foo
    delete_options:
      force: yes

- name: Drain node "foo", but abort if there are pods not managed by a ReplicationController, Job, or DaemonSet, and use a grace period of 15 minutes.
  kubernetes.core.k8s_drain:
    state: drain
    name: foo
    delete_options:
      terminate_grace_period: 900

- name: Mark node "foo" as schedulable.
  kubernetes.core.k8s_drain:
    state: uncordon
    name: foo

- name: Mark node "foo" as unschedulable.
  kubernetes.core.k8s_drain:
    state: cordon
    name: foo

- name: Drain node "foo" using label selector to filter the list of pods to be drained.
  kubernetes.core.k8s_drain:
    state: drain
    name: foo
    pod_selectors:
    - 'app!=csi-attacher'
    - 'app!=csi-provisioner'

Возвращаемые значения

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

Ключ	Описание
result string	Состояние узла и количество удалённых подов. Возвращается: при успешном выполнении

Авторы

Aubin Bikouo (@abikouo)

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

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