Модуль community.okd.openshift_adm_prune_deployments — удаление старых завершённых и неудачных конфигураций развёртывания

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 / 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.

keep_younger_than

integer

Укажите минимальный возраст развёртывания (в минутах), после которого его можно считать кандидатом на очистку.

kubeconfig

any

Путь к существующему файлу конфигурации Kubernetes. Если путь не указан и не заданы другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно указать с помощью переменной среды K8S_AUTH_KUBECONFIG.

Можно указать несколько файлов конфигурации Kubernetes, разделив их символом «;» в Windows или символом «:» на других платформах.

Конфигурацию Kubernetes можно передать в виде словаря. Для этой возможности требуется версия клиента Python Kubernetes >= 17.17.0. Добавлено в версии 2.2.0.

namespace

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”

orphans

boolean

Если true, очищаются все развёртывания, для которых связанная DeploymentConfig больше не существует, состояние — «завершено» или «сбой», а размер реплики равен 0.

Возможные значения:

• false ← (по умолчанию)
• true

password

string

Пароль для аутентификации в API. Также можно указать с помощью переменной среды K8S_AUTH_PASSWORD.

Описание параметра username содержит пояснение о случаях применения этого параметра.

persist_config

boolean

Сохранять ли токены обновления конфигурации kube. Также можно указать с помощью переменной среды K8S_AUTH_PERSIST_CONFIG.

Если в контексте k8s используются учётные данные пользователя с токенами обновления (например, oidc или аутентификация gke/gcloud), токен обновляется библиотекой клиента k8s для Python, но по умолчанию не сохраняется. Поэтому старый токен обновления может истечь, и следующая аутентификация завершится ошибкой. Если установить этот флаг в true, клиент k8s для Python сохранит новый токен обновления в файл конфигурации kube.

По умолчанию — false.

Обратите внимание: текущая версия библиотеки клиента k8s для Python пока не поддерживает установку этого флага в True.

Исправление для этой библиотеки 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.

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

replication_controllers

list / elements=string

Список контроллеров репликации, кандидатов на очистку.

Возвращается: всегда