Spec-Zone.ru › Ansible

community.okd.openshift_adm_prune_builds модуль – Удаление старых завершенных и неудавшихся билдов

Примечание

Этот модуль является частью коллекции community.okd (версия 3.0.1).

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

Чтобы установить ее, используйте: ansible-galaxy collection install community.okd. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Чтобы использовать его в playbook, укажите: community.okd.openshift_adm_prune_builds.

Новый в community.okd 2.3.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль позволяет администраторам удалять старые завершенные и неудавшиеся билды.
  • Аналогично oc adm prune builds.

Требования

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

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

Для платформ Windows можно использовать разделитель ';', а для других платформ - ':'.

Конфигурацию kubernetes можно предоставить в виде словаря. Эта функция требует версии python kubernetes client >= 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

булево

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

Варианты:

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

password

строка

Укажите пароль для аутентификации с 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

proxy

строка

URL HTTP-прокси для подключения. Также может быть указан через переменную среды K8S_AUTH_PROXY.

Обратите внимание, что этот модуль не подхватывает типичные параметры прокси из среды (например, HTTP_PROXY).

END_OF_DOCUMENT_MARKER

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.

Варианты:

  • false
  • true

Примечания

Примечание

  • Чтобы избежать ошибок проверки SSL-сертификатов, когда validate_certs имеет значение True, полная цепочка сертификатов API-сервера должна быть предоставлена через ca_cert или в файле kubeconfig.

Примеры

# Run deleting older completed and failed builds and also including
# all builds whose associated BuildConfig no longer exists
- name: Run delete orphan Builds
  community.okd.openshift_adm_prune_builds:
    orphans: true

# Run deleting older completed and failed builds keep younger than 2hours
- name: Run delete builds, keep younger than 2h
  community.okd.openshift_adm_prune_builds:
    keep_younger_than: 120

# Run deleting builds from specific namespace
- name: Run delete builds from namespace
  community.okd.openshift_adm_prune_builds:
    namespace: testing_namespace

Значения возврата

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

Ключ

Описание

builds

сложный

Удаленные сборки

Возвращается при: успех

api_version

строка

Версионированная схема представления объекта.

Возвращается при: успех

kind

строка

Представляет REST-ресурс, который представляет этот объект.

Возвращается при: успех

metadata

словарь

Стандартные метаданные объекта. Включает имя, пространство имен, аннотации, метки и т. д.

Возвращается при: успех

spec

словарь

Уникальные атрибуты объекта. Зависит от api_version и kind.

Возвращается при: успех

status

словарь

Текущие детали состояния объекта.

Возвращается при: успех

Авторы

  • 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/community/okd/openshift_adm_prune_builds_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API