Модуль community.okd.openshift_adm_prune_auth — удаляет ссылки на указанные роли, роли кластера, пользователей и группы

api_key

string

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

ca_cert

псевдонимы: ssl_ca_cert

path

Путь к сертификату ЦС, используемому для аутентификации в 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.

kubeconfig

any

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

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

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

label_selectors

list / elements=string

Селектор (запрос по меткам) для фильтрации.

Несовместим с параметром name.

name

string

Имя удаляемого объекта.

Несовместим с параметром label_selectors.

Если не указан ни name, ни label_selectors, будут удалены все ресурсы в пространстве имён.

namespace

string

Пространство имён объекта.

Игнорируется, если для resource задано значение clusterroles.

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.

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

resource

string / обязательный

Указанный ресурс для удаления.

Варианты:

• "roles"
• "clusterroles"
• "users"
• "groups"

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

authorization

list / elements=string

Список удалённых OAuthClientAuthorization.

Возвращается: resource=users

cluster_role_binding

list / elements=string

Список удалённых привязок ролей кластера.

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

group

list / elements=string

Список удалённых ограничений контекста безопасности.

Возвращается: resource=users

role_binding

list / elements=string

Список удалённых привязок ролей.

Возвращается: resource=users или resource=groups или resource=clusterroles

security_context_constraints

list / elements=string

Список удалённых ограничений контекста безопасности.

Возвращается: resource=users или resource=groups