Модуль community.okd.openshift_build — запуск новой сборки или отмена выполняющихся, ожидающих или новых сборок.

Примечание

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

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

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

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

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

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

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

Этот модуль запускает новую сборку на основе указанной конфигурации сборки или имени сборки.
Модуль также отменяет новую, ожидающую или выполняющуюся сборку, запрашивая её корректное завершение. Между запросом на завершение и фактическим прекращением сборки может пройти некоторое время.
Если текущая сборка отменена, модуль также может запустить новую сборку.
Аналогичен oc cancel-build и oc start-build.

Требования

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

python >= 3.6
kubernetes >= 12.0.0

Параметры

Параметр	Комментарии
api_key string	Токен для аутентификации в API. Также можно указать с помощью переменной окружения K8S_AUTH_API_KEY.
build_args list / elements=dictionary	Список пар ключ-значение, передаваемых Docker во время сборки.
name string / обязательный	Имя аргумента docker build.
value string / обязательный	Значение аргумента docker build.
build_config_name string	Имя конфигурации сборки, на основе которой будет запущена новая сборка. Несовместим с параметром build_name.
build_name string	Имя сборки, которую необходимо запустить повторно. Несовместим с параметром build_config_name.
build_phases list / elements=string	Список состояний сборки, при которых её следует отменить. Игнорируется, если `state=started`. Допустимые значения: `"New"` `"Pending"` `"Running"` По умолчанию: `[]`
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.
commit string	Идентификатор коммита исходного кода, который должна использовать сборка; требуется сборка на основе репозитория Git.
context string	Имя контекста из файла конфигурации. Также можно указать с помощью переменной окружения K8S_AUTH_CONTEXT.
env_vars list / elements=dictionary	Список пар ключ-значение для переменных окружения, задаваемых контейнеру сборки.
name string / обязательный	Имя переменной окружения.
value string / обязательный	Значение переменной окружения.
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.
incremental boolean	Переопределяет настройку incremental для сборки со стратегией source; если параметр не указан, он игнорируется. Допустимые значения: `false` `true`
kubeconfig any	Путь к существующему файлу конфигурации Kubernetes. Если путь не указан и не заданы другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно указать с помощью переменной окружения K8S_AUTH_KUBECONFIG. Можно указать несколько файлов конфигурации Kubernetes, используя разделитель ‘;’ в Windows или ‘:’ на других платформах. Конфигурацию Kubernetes можно указать в виде словаря. Для этого необходима версия клиента python kubernetes не ниже 17.17.0. Добавлено в версии 2.2.0.
namespace string / обязательный	Пространство имён сборки или конфигурации сборки.
no_cache boolean	Переопределяет настройку noCache для сборки со стратегией docker; если параметр не указан, он игнорируется. Допустимые значения: `false` `true`
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), библиотека клиента 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.
state string	Определяет, следует ли запустить, отменить или перезапустить сборку. Если задано значение `restarted`, после отмены текущей сборки будет создана новая. Допустимые значения: `"started"` ← (по умолчанию) `"cancelled"` `"restarted"`
username string	Имя пользователя для аутентификации в API. Также можно указать с помощью переменной окружения K8S_AUTH_USERNAME. Обратите внимание: этот параметр работает только с кластерами, настроенными на использование базовой HTTP-аутентификации. Если в кластере используется другой способ аутентификации (например, OAuth2 в OpenShift), параметр не будет работать ожидаемым образом. В таком случае обратитесь к модулю community.okd.k8s_auth — возможно, он решит вашу задачу.
validate_certs псевдонимы: verify_ssl boolean	Проверять ли SSL-сертификаты API-сервера. Также можно указать с помощью переменной окружения K8S_AUTH_VERIFY_SSL. Допустимые значения: `false` `true`
wait boolean	Если задано `state=started`, указывает, нужно ли ожидать завершения сборки и возвращать ненулевой код, если сборка завершилась с ошибкой. При значении state=cancelled указывает, нужно ли ожидать перехода сборки в фазу отмены. Допустимые значения: `false` ← (по умолчанию) `true`
wait_sleep integer	Количество секунд ожидания между проверками. Игнорируется, если `wait=false`. По умолчанию: `5`
wait_timeout integer	Время ожидания завершения сборки в секундах. Игнорируется, если `wait=false`. По умолчанию: `120`

Примечания

Примечание

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

Примеры

# Starts build from build config default/hello-world
- name: Starts build from build config
  community.okd.openshift_build:
    namespace: default
    build_config_name: hello-world

# Starts build from a previous build "default/hello-world-1"
- name: Starts build from a previous build
  community.okd.openshift_build:
    namespace: default
    build_name: hello-world-1

# Cancel the build with the given name
- name: Cancel build from default namespace
  community.okd.openshift_build:
    namespace: "default"
    build_name: ruby-build-1
    state: cancelled

# Cancel the named build and create a new one with the same parameters
- name: Cancel build from default namespace and create a new one
  community.okd.openshift_build:
    namespace: "default"
    build_name: ruby-build-1
    state: restarted

# Cancel all builds created from 'ruby-build' build configuration that are in 'new' state
- name: Cancel build from default namespace and create a new one
  community.okd.openshift_build:
    namespace: "default"
    build_config_name: ruby-build
    build_phases:
      - New
    state: cancelled

Возвращаемые значения

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

Ключ	Описание
builds complex	Запущенные или отменённые сборки. Возвращается: success
api_version string	Версия схемы, описывающей объект. Возвращается: success
kind string	Тип ресурса REST, который представляет этот объект. Возвращается: success
metadata dictionary	Стандартные метаданные объекта. Включают имя, пространство имён, аннотации, метки и т. д. Возвращается: success
spec dictionary	Особые атрибуты сборки. Возвращается: success
status dictionary	Сведения о текущем состоянии объекта. Возвращается: success

Авторы

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_build_module.html