community.okd.openshift_adm_prune_deployments модуль — Удаление устаревших завершенных и не удачных конфигураций развертывания
Примечание
Этот модуль входит в коллекцию community.okd (версия 3.0.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.okd. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Чтобы использовать его в книге задач, укажите: community.okd.openshift_adm_prune_deployments.
Новое в community.okd 2.2.0
Обзор
- Этот модуль позволяет администраторам удалять устаревшие завершенные и не удачные конфигурации развертывания.
- Аналогично
oc adm prune deployments.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 3.6
- kubernetes >= 12.0.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. |
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. |
keep_younger_than целое число | Укажите минимальный возраст (в минутах) развертывания, чтобы оно считалось кандидатом для удаления. |
kubeconfig любой | Путь к существующему файлу конфигурации Kubernetes. Если не указано и не указаны другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG. Несколько файлов конфигурации Kubernetes могут быть предоставлены с разделителем «;» для платформ Windows или «:» для других платформ. Конфигурация Kubernetes может быть предоставлена в виде словаря. Эта функция требует версии клиента python kubernetes >= 17.17.0. Добавлено в версии 2.2.0. |
namespace строка | Используется для указания пространства имен для развертываний, которые необходимо удалить. |
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» |
orphans логическое | Если Варианты:
|
password строка | Укажите пароль для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_PASSWORD. Пожалуйста, прочитайте описание параметра |
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 Варианты:
|
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. |
username строка | Укажите имя пользователя для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными на использование HTTP Basic Auth. Если ваш кластер имеет другой тип аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует обратиться к модулю community.okd.k8s_auth, так как он может вам подойти. |
validate_certs псевдонимы: verify_ssl булево | Проверять или нет сертификаты SSL сервера API. Также можно указать через переменную окружения K8S_AUTH_VERIFY_SSL. Варианты:
|
Примечания
Примечание
- Чтобы избежать ошибок проверки сертификатов SSL при
validate_certsравняется True, полная цепочка сертификатов сервера API должна быть предоставлена черезca_certили в файле kubeconfig.
Примеры
- name: Prune Deployments from testing namespace
community.okd.openshift_adm_prune_deployments:
namespace: testing
- name: Prune orphans deployments, keep younger than 2hours
community.okd.openshift_adm_prune_deployments:
orphans: true
keep_younger_than: 120
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
replication_controllers список / элементы=строка | Список контроллеров репликации, кандидатов для удаления. Возвращается: всегда |
Ссылки на коллекции
© 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/community/okd/openshift_adm_prune_deployments_module.html