Spec-Zone.ru › Ansible

Модуль community.okd.openshift_adm_prune_builds — очистка старых завершённых и неудачных сборок

Примечание

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

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

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

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

Добавлено в community.okd 2.3.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 3.6
  • kubernetes >= 12.0.0

Параметры

Параметр

Комментарии

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 / элементы=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, удалить все сборки, для которых больше не существует соответствующего BuildConfig и статус которых — complete, failed, error или cancelled.

Варианты:

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

password

string

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

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

persist_config

boolean

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

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

По умолчанию — 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.

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

Примечания

Примечание

  • Чтобы избежать ошибок проверки 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

complex

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

Возвращается: при успешном выполнении

api_version

string

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

Возвращается: при успешном выполнении

kind

string

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

Возвращается: при успешном выполнении

metadata

dictionary

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

Возвращается: при успешном выполнении

spec

dictionary

Специфичные атрибуты объекта. Их набор зависит от значений api_version и kind.

Возвращается: при успешном выполнении

status

dictionary

Сведения о текущем состоянии объекта.

Возвращается: при успешном выполнении

Авторы

  • Aubin Bikouo (@abikouo)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/okd/openshift_adm_prune_builds_module.html

Spec-Zone.ru

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