kubernetes.core.k8s_drain модуль – Отказ, блокировка или разблокировка узла в кластере k8s

Примечание

Этот модуль является частью коллекции kubernetes.core (версия 3.2.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.
Блокировка пометит узел как неподготовленный для планирования.
Разблокировка пометит узел как готовый для планирования.
Указанный узел будет помечен как неподготовленный для планирования, чтобы предотвратить появление новых под.
Затем отказ удаляет все под, кроме зеркал (которые не могут быть удалены через сервер API).

Примечание

Для этого модуля существует соответствующий плагин действий.

Требования

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

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.
delete_options словарь	Укажите параметры для удаления под. Этот параметр действует только когда `state` установлен в drain. По умолчанию: `{}`
delete_emptydir_data логическое значение добавлено в kubernetes.core 2.3.0	Продолжить, даже если есть под, использующие emptyDir (локальные данные, которые будут удалены при отводе узла). Возможные значения: `false` ← (по умолчанию) `true`
disable_eviction логическое значение	Принудительно использовать удаление вместо изгнания. Возможные значения: `false` ← (по умолчанию) `true`
force логическое значение	Продолжить, даже если есть под, не управляемые ReplicationController, Job или DaemonSet. Возможные значения: `false` ← (по умолчанию) `true`
ignore_daemonsets логическое значение	Игнорировать под, управляемые DaemonSet. Возможные значения: `false` ← (по умолчанию) `true`
terminate_grace_period целое число	Укажите количество секунд ожидания перед принудительным завершением. Если не указано, будет использоваться значение по умолчанию для типа объекта. Значение ноль означает немедленное удаление.
wait_sleep целое число	Количество секунд ожидания между проверками. Игнорируется, если `wait_timeout` не задано. По умолчанию: `5`
wait_timeout целое число	Время ожидания в секундах для удаления под перед отказом, ноль означает бесконечное время.
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.
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”
пароль строка	Укажите пароль для аутентификации с 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_selectors псевдонимы: label_selectors список / элементы=строка добавлено в kubernetes.core 2.5.0	Селектор меток для фильтрации под на узле. Этот параметр эффективен только когда `state` установлен в drain.
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 строка	Строка, представляющая пользовательского агента, например foo/1.0. Также может быть указано в переменной окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
state строка	Определяет, нужно ли выполнить drain, cordon или uncordon узла. Варианты: `"cordon"` `"drain"` ← (по умолчанию) `"uncordon"`
имя пользователя строка	Укажите имя пользователя для аутентификации с API. Также может быть указан в переменной окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными на использование HTTP Basic Auth. Если ваш кластер использует другой тип аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать как ожидается, и вам следует обратиться к модулю community.okd.k8s_auth, так как он может быть полезен для вашей ситуации.
validate_certs псевдонимы: verify_ssl булево	Проверять ли 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
    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 строка	Статус узла и количество удалённых под. Возвращаемое значение: успех

Авторы

Aubin Bikouo (@abikouo)

Ссылки на сборку

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