Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_cloudbuild_trigger — Создаёт триггер GCP

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

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

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

Для использования в книге задач укажите: google.cloud.gcp_cloudbuild_trigger.

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

Обзор

  • Настройка автоматизированного построения приложения в ответ на изменения в репозитории исходного кода.

Требования

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

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательно

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

build

словарь

Содержание шаблона сборки. Должен быть указан либо файл, либо шаблон сборки.

artifacts

словарь

Артефакты, созданные в результате сборки, которые должны быть загружены после успешного выполнения всех этапов сборки.

images

список / элементы=строка

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

Изображения будут загружены с помощью учетных данных сервисного аккаунта билдера.

Хэши загруженных изображений будут сохранены в поле результатов ресурса Сборка.

Если какой-либо из изображений не удалось загрузить, статус сборки помечается как ОШИБКА.

objects

словарь

Список объектов, которые нужно загрузить в хранилище Google Cloud Storage после успешного выполнения всех этапов сборки.

Файлы в рабочей области, соответствующие указанным шаблонам путей, будут загружены в местоположение Cloud Storage с использованием учетных данных сервисного аккаунта билдера.

Местоположение и версия загруженных объектов будут сохранены в поле результатов ресурса Сборка.

Если какие-либо объекты не удалось загрузить, статус сборки помечается как ОШИБКА.

location

строка

Ведро Cloud Storage и необязательный путь к объекту в формате «gs://bucket/path/to/somewhere/».

Файлы в рабочей области, соответствующие любому шаблону пути, будут загружены в Cloud Storage с этим местоположением в качестве префикса.

paths

список / элементы=строка

Шаблоны путей, используемые для сопоставления файлов в рабочей области сборки.

images

список / элементы=строка

Список изображений, которые нужно загрузить после успешного выполнения всех этапов сборки.

Изображения загружаются с помощью учетных данных сервисного аккаунта билдера.

Хэши загруженных изображений будут сохранены в поле результатов ресурса Сборка.

Если какой-либо из изображений не удалось загрузить, статус сборки помечается как ОШИБКА.

logs_bucket

строка

Ведро Google Cloud Storage, в котором должны быть записаны логи. Имена файлов логов будут иметь формат ${logsBucket}/log-${build_id}.txt.

options

словарь

Специальные параметры для этой сборки.

disk_size_gb

целое число

Запрошенный размер диска для виртуальной машины, на которой выполняется сборка. Обратите внимание, что это НЕ «свободный размер диска»; часть пространства будет использована операционной системой и утилитами сборки.

Также обратите внимание, что это минимальный размер диска, который будет выделен для сборки — сборка может выполняться с диском большего размера, чем запрошенный. В настоящее время максимальный размер диска составляет 1000 ГБ; запросы, превышающие максимальный размер, отклоняются с ошибкой.

dynamic_substitutions

булево

Параметр, определяющий, применять ли операции с строками в стиле bash к подстановкам.

ОБРАТИТЕ ВНИМАНИЕ, что это всегда включено для триггерных сборок и не может быть переопределено в файле конфигурации сборки.

Варианты:

  • false
  • true

env

список / элементы=строка

Список глобальных определений переменных среды, которые будут существовать для всех этапов сборки в этой сборке. Если переменная определена как глобально, так и на этапе сборки, будет использоваться значение этапа сборки.

Элементы имеют вид «KEY=VALUE» для переменной среды «KEY» со значением «VALUE».

log_streaming_option

строка

Параметр для определения поведения потоковой передачи логов сборки в Google Cloud Storage.

Некоторые допустимые значения: «STREAM_DEFAULT», «STREAM_ON», «STREAM_OFF»

logging

строка

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

Некоторые допустимые значения: «LOGGING_UNSPECIFIED», «LEGACY», «GCS_ONLY», «STACKDRIVER_ONLY», «NONE»

machine_type

строка

Тип виртуальной машины Compute Engine, на которой должна выполняться сборка.

Некоторые допустимые значения: «UNSPECIFIED», «N1_HIGHCPU_8», «N1_HIGHCPU_32», «E2_HIGHCPU_8», «E2_HIGHCPU_32»

requested_verify_option

строка

Запрошенные варианты проверки.

Некоторые допустимые значения: «NOT_VERIFIED», «VERIFIED»

secret_env

список / элементы=строка

Список глобальных переменных среды, которые зашифрованы с помощью криптоключа Cloud Key Management Service. Эти значения должны быть указаны в секрете сборки. Эти переменные будут доступны всем этапам сборки в этой сборке.

source_provenance_hash

list / elements=string

Запрашиваемый хэш для SourceProvenance.

substitution_option

string

Параметр для указания поведения при ошибке в проверках подстановки.

ПРИМЕЧАНИЕ: это всегда установлено в ALLOW_LOOSE для триггерных сборок и не может быть переопределено в файле конфигурации сборки.

Некоторые допустимые варианты: “MUST_MATCH”, “ALLOW_LOOSE”

volumes

list / elements=dictionary

Глобальный список томов для монтирования для ВСЕХ этапов сборки. Каждый том создается как пустой том перед началом процесса сборки.

После завершения сборки тома и их содержимое удаляются. Глобальные имена и пути томов не могут конфликтовать с томами, определенными на этапе сборки.

Использование глобального тома в сборке с одним шагом недействительно, так как это свидетельствует о запросе сборки с неправильной конфигурацией.

name

string

Имя монтируемого тома.

Имена томов должны быть уникальными для каждого этапа сборки и должны быть допустимыми именами для томов Docker.

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

path

string

Путь, по которому необходимо смонтировать том.

Пути должны быть абсолютными и не могут конфликтовать с другими путями томов на одном этапе сборки или с некоторыми зарезервированными путями томов.

worker_pool

string

Параметр для указания пула рабочих (WorkerPool) для сборки. Формат projects/{project}/workerPools/{workerPool} Это поле экспериментальное.

queue_ttl

string

Время жизни (TTL) в очереди для этой сборки. Если указано и сборка находится в очереди дольше этого значения, сборка истечет, и статус сборки будет EXPIRED.

Обратный отсчет TTL начинается с createTime.

Длительность в секундах с точностью до девяти дробных знаков, заканчивающаяся на «s». Пример: «3.5s».

secrets

list / elements=dictionary

Секреты для расшифровки с помощью Cloud Key Management Service.

kms_key_name

string / required

Имя ключа Cloud KMS для использования при расшифровке этих переменных среды.

secret_env

dictionary

Сопоставление имени переменной среды с её зашифрованным значением.

Секретные переменные среды должны быть уникальными для всех секретов сборки и должны использоваться как минимум одним этапом сборки. Значения могут иметь размер не более 64 КБ. Может быть не более 100 секретных значений для всех секретов сборки.

source

dictionary

Расположение исходных файлов для сборки.

repo_source

dictionary

Расположение источника в репозитории Google Cloud Source Repository.

branch_name

string

Регулярное выражение, соответствующее веткам для сборки. Должно быть указано ровно одно из имени ветки, тега или SHA-хеша коммита.

Синтаксис принимаемых регулярных выражений — это синтаксис, принимаемый RE2 и описанный по адресу https://github.com/google/re2/wiki/Syntax.

commit_sha

string

Явный SHA-хеш коммита для сборки. Должно быть указано ровно одно из имени ветки, тега или SHA-хеша коммита.

dir

string

Каталог, относительно корня источника, в котором нужно выполнить сборку.

Это должен быть относительный путь. Если указан каталог шага и это абсолютный путь, это значение игнорируется для выполнения этого шага.

invert_regex

boolean

Запускать сборку только если регулярное выражение ревизии НЕ соответствует регулярному выражению ревизии.

Варианты:

  • false
  • true

project_id

string

Идентификатор проекта, которому принадлежит репозиторий Cloud Source Repository. Если пропущено, предполагается идентификатор проекта, запрашивающего сборку.

repo_name

string / required

Имя репозитория Cloud Source Repository.

substitutions

dictionary

Подстановки для использования в триггерной сборке. Должны использоваться только с triggers.run.

tag_name

string

Регулярное выражение, соответствующее тегам для сборки. Должно быть указано ровно одно из имени ветки, тега или SHA-хеша коммита.

Синтаксис принимаемых регулярных выражений — это синтаксис, принимаемый RE2 и описанный по адресу https://github.com/google/re2/wiki/Syntax.

storage_source

dictionary

Расположение источника в архивном файле в Google Cloud Storage.

bucket

string / required

Корзина Google Cloud Storage, содержащая источник.

generation

string

Поколение объекта Google Cloud Storage. Если поколение не указано, будет использоваться последнее поколение.

object

string / required

Объект Google Cloud Storage, содержащий источник.

Этот объект должен быть сжатым архивным файлом (.tar.gz), содержащим исходный код для сборки.

steps

list / elements=dictionary / required

Операции, которые должны быть выполнены в рабочем пространстве.

args

list / elements=string

Список аргументов, которые будут предоставлены шагу при его запуске.

Если образ, используемый для запуска контейнера шага, имеет точку входа, аргументы используются как аргументы для этой точки входа. Если образ не определяет точку входа, первый элемент в args используется как точка входа, а остальные будут использоваться как аргументы.

dir

string

Рабочий каталог, который нужно использовать при запуске контейнера этого шага.

Если это значение является относительным путем, оно относительно рабочего каталога сборки. Если это значение является абсолютным, оно может находиться за пределами рабочего каталога сборки, в этом случае содержимое пути может не сохраняться между выполнениями шагов сборки, если не указан `volume` для этого пути.

Если сборка указывает `RepoSource` с `dir` и шаг с `dir`, который указывает абсолютный путь, `RepoSource` `dir` игнорируется для выполнения шага.

entrypoint

string

Точка входа, которая будет использоваться вместо точки входа по умолчанию образа шага сборки.

Если не установлено, используется точка входа по умолчанию образа.

env

list / elements=string

Список определений переменных среды, которые будут использоваться при запуске шага.

Элементы имеют вид «KEY=VALUE» для переменной среды «KEY», которой присваивается значение «VALUE».

id

string

Уникальный идентификатор этого шага сборки, используемый в `wait_for` для ссылки на этот шаг сборки как зависимость.

name

string / required

Имя образа контейнера, который будет запущен на этом конкретном шаге сборки.

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

Кэш демона Docker уже будет содержать последние версии всех официально поддерживаемых шагов сборки (см. https://github.com/GoogleCloudPlatform/cloud-builders для образов и примеров).

Демон Docker также будет содержать кэшированные многие слои для некоторых популярных образов, таких как «ubuntu», «debian», но они будут обновлены в тот момент, когда вы попытаетесь их использовать.

Если вы создали образ на предыдущем шаге сборки, он будет сохранен в кэше демона Docker хоста и доступен для использования в качестве имени для последующего шага сборки.

secret_env

list / elements=string

Список переменных среды, которые зашифрованы с помощью криптографического ключа службы управления ключами Cloud. Эти значения должны быть указаны в `Secret` сборки.

timeout

string

Тайм-лимит для выполнения этого шага сборки. Если не определено, шаг не имеет ограничения по времени и ему будет разрешено продолжать работу до тех пор, пока он не завершится или не истечет время ожидания самой сборки.

timing

string

Только для вывода. Сохраняет информацию о времени выполнения этого шага сборки.

volumes

list / elements=dictionary

Список томов для монтирования в шаг сборки.

Каждый том создается как пустой том до выполнения шага сборки. После завершения сборки тома и их содержимое удаляются.

Использование именованного тома только на одном шаге неверно, так как это указывает на запрос сборки с неправильной конфигурацией.

name

string / required

Имя монтируемого тома.

Имена томов должны быть уникальными для каждого шага сборки и должны быть допустимыми именами для томов Docker. Каждый именованный том должен использоваться как минимум двумя шагами сборки.

path

string / required

Путь, по которому нужно смонтировать том.

Пути должны быть абсолютными и не могут конфликтовать с другими путями томов на одном шаге сборки или с некоторыми зарезервированными путями томов.

wait_for

list / elements=string

ID шага(ов), от которого(ых) зависит этот шаг сборки.

Этот шаг сборки не начнется, пока все шаги сборки в `wait_for` не завершатся успешно. Если `wait_for` пуст, этот шаг сборки начнется, когда все предыдущие шаги сборки в списке `Build.Steps` завершатся успешно.

подстановки

словарь

Данные подстановок для ресурса Build.

метки

список / элементы=строка

Метки для аннотации Build. Это не теги Docker.

таймаут

строка

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

Если это время истечёт, работа над сборкой прекратится, и статус сборки будет TIMEOUT.

Этот таймаут должен быть равен или больше суммы таймаутов шагов сборки внутри сборки.

Ожидаемый формат — число секунд, за которым следует s.

По умолчанию установлено десять минут (600s).

По умолчанию: "600s"

описание

строка

Описание триггера, понятное человеку.

отключен

логическое

Отключён ли триггер. Если true, триггер никогда не приведёт к сборке.

Варианты:

  • false
  • true

тип_среды

строка

Указывает, в какой среде Ansible выполняется данный модуль.

Не следует устанавливать, если вы не знаете, что делаете.

Это влияет только на строку User Agent для всех запросов API.

имя_файла

строка

Путь к файлу, начиная с корня источника, содержащий шаблон. Нужно указать либо имя файла, либо шаблон сборки.

github

словарь

Описание конфигурации триггера, запускающего сборку при получении события GitHub.

имя

строка

Имя репозитория. Например: имя для https://github.com/googlecloudplatform/cloud-builders — “cloud-builders”.

владелец

строка

Владелец репозитория. Например: владелец для https://github.com/googlecloudplatform/cloud-builders — “googlecloudplatform”.

запрос_на_слияние

словарь

Фильтр для соответствия изменениям в запросах на слияние. Укажите только один из pullRequest или push.

ветвь

строка / обязательно

Регулярное выражение для соответствия ветвям.

управление_комментариями

строка

Блокировать ли сборки по комментарию “/gcbrun” от владельца или участника репозитория.

Некоторые допустимые значения: “COMMENTS_DISABLED”, “COMMENTS_ENABLED”, “COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY”

обратное_регулярное_выражение

логическое

Если true, ветви, НЕ соответствующие git_ref, будут запускать сборку.

Варианты:

  • false
  • true

push

словарь

Фильтр для соответствия изменениям в ссылках, таких как ветви или теги. Укажите только один из pullRequest или push.

ветвь

строка

Регулярное выражение для соответствия ветвям. Укажите только одну из branch или tag.

обратное_регулярное_выражение

логическое

Если true, сборка запускается только в том случае, если выражение регулярного соответствия для ревизии НЕ соответствует выражению регулярного соответствия для git_ref.

Варианты:

  • false
  • true

тег

строка

Регулярное выражение для соответствия тегам. Укажите только одну из branch или tag.

идентификатор

строка

Уникальный идентификатор триггера.

проигнорированные_файлы

список / элементы=строка

ignoredFiles и includedFiles — соответствия шаблонам файлов, использующие https://golang.org/pkg/path/filepath/#Match, расширенные поддержкой `**`.

Если ignoredFiles и изменённые файлы пусты, они не используются для определения того, запускать ли сборку.

Если ignoredFiles не пусто, любые файлы, соответствующие одному из шаблонов ignored_file, игнорируются. Если в изменениях нет файлов, выходящих за рамки шаблонов ignoredFiles, сборка не запускается.

included_files

список / элементы=строка

ignoredFiles и includedFiles — это шаблоны соответствия файлам, использующие https://golang.org/pkg/path/filepath/#Match, расширенные поддержкой `**`.

Если какой-либо из изменённых файлов в коммите проходит фильтр ignoredFiles, а includedFiles пустой, то с точки зрения этого фильтра должен быть запущен сборка.

Если какой-либо из изменённых файлов в коммите проходит фильтр ignoredFiles, а includedFiles не пустой, то мы убеждаемся, что хотя бы один из этих файлов соответствует шаблону includedFiles. Если нет, то сборка не запускается.

name

строка

Имя триггера. Должно быть уникальным в рамках проекта.

project

строка

Используемый проект Google Cloud Platform.

pubsub_config

словарь

PubsubConfig описывает конфигурацию триггера, который запускает сборку при публикации сообщения в Pub/Sub.

service_account_email

строка

Учётная запись сервиса, которая отправит запрос.

topic

строка / обязательно

Имя темы, из которой эта подписка получает сообщения.

scopes

список / элементы=строка

Массив используемых областей

service_account_contents

jsonarg

Содержимое файла JSON учётной записи сервиса, либо в виде словаря, либо в виде JSON-строки, его представляющей.

service_account_email

строка

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

service_account_file

путь

Путь к файлу JSON учётной записи сервиса, если тип serviceaccount выбран.

state

строка

Нужно ли, чтобы данный объект существовал в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

substitutions

словарь

Данные подстановки для ресурса Build.

tags

список / элементы=строка

Теги для аннотации BuildTrigger.

trigger_template

словарь

Шаблон, описывающий типы изменений исходного кода, которые запускают сборку.

Имена ветвей и тегов в шаблонах триггеров интерпретируются как регулярные выражения. Любое изменение ветви или тега, соответствующее этому регулярному выражению, запустит сборку.

branch_name

строка

Имя ветви для сборки. Должно быть предоставлено ровно одно из имени ветви, тега или SHA коммита.

Это поле является регулярным выражением.

commit_sha

строка

Явное значение SHA коммита для сборки. Должно быть предоставлено ровно одно из имени ветви, тега или SHA коммита.

dir

строка

Директория, относительная к корню исходного кода, в которой будет выполняться сборка.

Это должен быть относительный путь. Если для шага указан абсолютный путь, это значение игнорируется для выполнения этого шага.

invert_regex

булево

Запустить сборку только если версия не соответствует регулярному выражению.

Варианты:

  • false
  • true

project_id

строка

Идентификатор проекта, которому принадлежит Cloud Source Repository. Если опущено, предполагается идентификатор проекта, запрашивающего сборку.

repo_name

строка

Имя Cloud Source Repository. Если опущено, предполагается имя «default».

По умолчанию: "default"

tag_name

строка

Имя тега для сборки. Должно быть предоставлено ровно одно из имени ветви, тега или SHA коммита.

Это поле является регулярным выражением.

webhook_config

словарь

WebhookConfig описывает конфигурацию триггера, который запускает сборку при отправке веб-хука на URL триггера.

secret

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

Имя ресурса секрета, необходимого в качестве параметра URL.

Примечания

Примечание

  • Ссылка на API: https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers
  • Автоматизация сборки с помощью триггеров сборки: https://cloud.google.com/cloud-build/docs/running-builds/automate-builds
  • для аутентификации можно установить service_account_file используя переменную среды GCP_SERVICE_ACCOUNT_FILE.
  • для аутентификации можно установить service_account_contents используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • Для аутентификации можно установить service_account_email используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
  • Для аутентификации можно установить access_token используя переменную среды GCP_ACCESS_TOKEN.
  • Для аутентификации можно установить auth_kind используя переменную среды GCP_AUTH_KIND.
  • Для аутентификации можно установить scopes используя переменную среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
  • Параметры service_account_email и service_account_file являются взаимоисключающими.
  • Идентификатор этого ресурса создается API после первого создания ресурса. Если вы хотите управлять этим ресурсом после создания, вам нужно скопировать сгенерированный идентификатор в плейбук. В противном случае новые триггеры будут создаваться при последующих запусках.

Примеры

- name: create a repository
  google.cloud.gcp_sourcerepo_repository:
    name: projects/{{ gcp_project }}/repos/{{ resource_name }}
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present

- name: create a trigger
  google.cloud.gcp_cloudbuild_trigger:
    trigger_template:
      branch_name: master
      project_id: test_project
      repo_name: test_object
    filename: cloudbuild.yaml
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ

Описание

build

complex

Содержимое шаблона сборки. Необходимо указать либо имя файла, либо шаблон сборки.

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

artifacts

complex

Артефакты, созданные сборкой, которые должны быть загружены после успешного завершения всех этапов сборки.

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

images

list / elements=string

Список образов, которые будут отправлены после успешного завершения всех этапов сборки.

Образы будут отправлены с использованием учетных данных учетной записи обслуживания сборщика.

Хеши отправленных образов будут сохранены в поле результатов ресурса сборки.

Если отправка любого из образов завершится неудачей, сборка помечается как FAILURE.

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

objects

complex

Список объектов, которые будут загружены в Cloud Storage после успешного завершения всех этапов сборки.

Файлы в рабочей области, соответствующие указанным шаблонам путей, будут загружены в местоположение Cloud Storage с использованием учетных данных учетной записи обслуживания сборщика.

Местоположение и поколение загруженных объектов будут сохранены в поле результатов ресурса сборки.

Если загрузка любого из объектов завершится неудачей, сборка помечается как FAILURE.

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

location

string

Корзина Cloud Storage и необязательный путь к объекту в формате “gs://bucket/path/to/somewhere/”.

Файлы в рабочей области, соответствующие любому шаблону пути, будут загружены в Cloud Storage с этим местоположением в качестве префикса.

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

paths

list / elements=string

Шаблоны путей, используемые для сопоставления файлов в рабочей области сборки.

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

timing

complex

Только для вывода. Сохраняет информацию о времени для отправки всех объектов артефактов.

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

endTime

string

Конец временного интервала.

Метка времени в формате RFC3339 UTC “Zulu” с разрешением в наносекунды и до девяти дробных знаков. Примеры: “2014-10-02T15:01:23Z” и “2014-10-02T15:01:23.045123456Z”.

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

startTime

string

Начало временного интервала.

Метка времени в формате RFC3339 UTC “Zulu” с разрешением в наносекунды и до девяти дробных знаков. Примеры: “2014-10-02T15:01:23Z” и “2014-10-02T15:01:23.045123456Z”.

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

images

list / elements=string

Список образов, которые будут отправлены после успешного завершения всех этапов сборки.

Образы отправляются с использованием учетных данных учетной записи обслуживания сборщика.

Хеши отправленных образов будут сохранены в поле результатов ресурса сборки.

Если отправка любого из образов завершится неудачей, статус сборки помечается как FAILURE.

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

logsBucket

string

Корзина Google Cloud Storage, куда должны записываться журналы. Имена файлов журналов будут иметь формат ${logsBucket}/log-${build_id}.txt.

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

options

complex

Специальные параметры для этой сборки.

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

diskSizeGb

integer

Запрошенный размер диска для виртуальной машины, на которой выполняется сборка. Обратите внимание, что это НЕ «свободное место на диске»; часть пространства будет использоваться операционной системой и служебными программами сборки.

Также обратите внимание, что это минимальный размер диска, который будет выделен для сборки — сборка может выполняться с диском большего размера, чем запрошено. В настоящее время максимальный размер диска составляет 1000 ГБ; сборки, запрашивающие больше, чем максимум, отклоняются с ошибкой.

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

dynamicSubstitutions

boolean

Параметр для указания того, следует ли применять операции со строками в стиле bash к подстановкам.

ПРИМЕЧАНИЕ. Это всегда включено для триггерных сборок и не может быть переопределено в файле конфигурации сборки.

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

env

list / elements=string

Список глобальных определений переменных среды, которые будут существовать для всех этапов сборки в этой сборке. Если переменная определена как глобально, так и на этапе сборки, переменная будет использовать значение этапа сборки.

Элементы имеют вид “KEY=VALUE” для переменной среды “KEY”, которой присваивается значение “VALUE”.

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

logging

string

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

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

logStreamingOption

string

Параметр для определения поведения потоковой передачи логов сборки в Google Cloud Storage.

Returned: success

machineType

string

Тип машины Compute Engine, на которой будет выполняться сборка.

Returned: success

requestedVerifyOption

string

Запрошенные параметры верифицируемости.

Returned: success

secretEnv

list / elements=string

Список глобальных переменных среды, которые шифруются с помощью криптографического ключа Cloud Key Management Service. Эти значения должны быть указаны в секрете сборки. Эти переменные будут доступны всем шагам сборки в этой сборке.

Returned: success

sourceProvenanceHash

list / elements=string

Запрошенный хэш для SourceProvenance.

Returned: success

substitutionOption

string

Параметр для указания поведения при ошибке в проверках подстановки.

ПРИМЕЧАНИЕ. Это значение всегда устанавливается в ALLOW_LOOSE для запущенных сборок и не может быть переопределено в файле конфигурации сборки.

Returned: success

volumes

complex

Глобальный список томов для монтирования для ВСЕХ шагов сборки. Каждый том создается как пустой том перед началом процесса сборки.

После завершения сборки тома и их содержимое удаляются. Глобальные имена и пути томов не могут конфликтовать с томами, определенными в шаге сборки.

Использование глобального тома в сборке с одним шагом недействительно, так как это указывает на запрос сборки с неправильной конфигурацией.

Returned: success

name

string

Имя монтируемого тома.

Имена томов должны быть уникальными для каждого шага сборки и должны быть допустимыми именами для томов Docker.

Каждый именованный том должен использоваться как минимум двумя шагами сборки.

Returned: success

path

string

Путь, по которому будет смонтирован том.

Пути должны быть абсолютными и не могут конфликтовать с другими путями томов на том же шаге сборки или с определенными зарезервированными путями томов.

Returned: success

workerPool

string

Параметр для указания пула рабочих (WorkerPool) для сборки. Формат projects/{project}/workerPools/{workerPool} Это поле является экспериментальным.

Returned: success

queueTtl

string

Время жизни (TTL) в очереди для этой сборки. Если указано и сборка находится в очереди дольше этого значения, сборка истечет, и статус сборки будет EXPIRED.

Обратный отсчет TTL начинается с createTime.

Продолжительность в секундах с точностью до девяти знаков после запятой, заканчивающаяся на «s». Пример: «3.5s».

Returned: success

secrets

complex

Секреты для расшифровки с помощью Cloud Key Management Service.

Returned: success

kmsKeyName

string

Имя ключа Cloud KMS, используемого для расшифровки этих переменных среды.

Returned: success

secretEnv

dictionary

Сопоставление имени переменной среды с её зашифрованным значением.

Секретные переменные среды должны быть уникальными во всех секретах сборки и должны использоваться как минимум одним шагом сборки. Значения могут иметь размер не более 64 КБ. Может быть не более 100 секретных значений во всех секретах сборки.

Returned: success

source

complex

Расположение исходных файлов для сборки.

Returned: success

repoSource

complex

Расположение источника в репозитории Google Cloud Source Repository.

Returned: success

branchName

string

Регулярное выражение, соответствующее веткам для сборки. Должно быть предоставлено ровно одно из имени ветки, тега или SHA-хеша коммита.

Синтаксис принимаемых регулярных выражений — это синтаксис, принимаемый RE2 и описанный по адресу https://github.com/google/re2/wiki/Syntax.

Returned: success

commitSha

string

Явный SHA-хеш коммита для сборки. Должно быть предоставлено ровно одно из имени ветки, тега или SHA-хеша коммита.

Returned: success

dir

string

Директория, относительная к корню источника, в которой необходимо выполнить сборку.

Это должен быть относительный путь. Если для шага указан параметр dir, и он представляет собой абсолютный путь, то это значение игнорируется для выполнения этого шага.

Возвращаемое значение: success

invertRegex

boolean

Выполнять сборку только в том случае, если выражение регулярного выражения для ревизии НЕ совпадает с выражением регулярного выражения.

Возвращаемое значение: success

projectId

string

Идентификатор проекта, которому принадлежит Cloud Source Repository. Если опущен, предполагается, что идентификатор проекта запрашивает сборку.

Возвращаемое значение: success

repoName

string

Имя Cloud Source Repository.

Возвращаемое значение: success

substitutions

dictionary

Замены, используемые в триггерной сборке. Следует использовать только с triggers.run.

Возвращаемое значение: success

tagName

string

Выражение регулярного выражения, соответствующее тегам для сборки. Должен быть указан ровно один из параметров: имя ветки, тег или SHA коммита.

Синтаксис допустимых регулярных выражений соответствует синтаксису RE2 и описан на https://github.com/google/re2/wiki/Syntax.

Возвращаемое значение: success

storageSource

complex

Расположение источника в архивном файле в Google Cloud Storage.

Возвращаемое значение: success

bucket

string

Ведро Google Cloud Storage, содержащее исходный код.

Возвращаемое значение: success

generation

string

Генерация Google Cloud Storage для объекта. Если генерация опущена, будет использована последняя генерация.

Возвращаемое значение: success

object

string

Объект Google Cloud Storage, содержащий исходный код.

Этот объект должен быть сжатым архивным файлом (.tar.gz), содержащим исходный код для сборки.

Возвращаемое значение: success

steps

complex

Операции, которые необходимо выполнить в рабочей области.

Возвращаемое значение: success

args

list / elements=string

Список аргументов, которые будут переданы шагу при его запуске.

Если для изображения, используемого для запуска контейнера шага, определён entrypoint, то args используются как аргументы к этому entrypoint. Если в изображении не определён entrypoint, то первый элемент в args используется как entrypoint, а остальные – как аргументы.

Возвращаемое значение: success

dir

string

Рабочая директория, используемая при запуске контейнера этого шага.

Если это значение – относительный путь, оно относительно рабочей директории сборки. Если это значение – абсолютный путь, оно может быть вне рабочей директории сборки, в этом случае содержимое пути может не сохраняться между запусками шагов сборки, если для этого пути не указан `volume`.

Если сборка указывает `RepoSource` с `dir` и шаг со `dir`, который определяет абсолютный путь, то `RepoSource` `dir` игнорируется для выполнения шага.

Возвращаемое значение: success

entrypoint

string

Точка входа, используемая вместо точки входа по умолчанию изображения шага сборки.

Если не задано, используется точка входа по умолчанию изображения.

Возвращаемое значение: success

env

list / elements=string

Список определений переменных среды, которые необходимо использовать при выполнении шага.

Элементы имеют вид «KEY=VALUE» для переменной среды «KEY», которой присваивается значение «VALUE».

Возвращаемое значение: success

id

string

Уникальный идентификатор для этого шага сборки, используемый в `wait_for` для ссылки на этот шаг сборки в качестве зависимости.

Возвращаемое значение: success

name

string

Имя контейнерного образа, который будет запущен на этом этапе сборки.

Если образ доступен в кэше демона Docker хоста, он будет запущен напрямую. В противном случае хост попытается сначала получить образ, используя при необходимости учетные данные службы сборки.

Кэш демона Docker уже будет содержать последние версии всех официально поддерживаемых этапов сборки (см. https://github.com/GoogleCloudPlatform/cloud-builders для образов и примеров).

Демон Docker также будет содержать в кэше многие слои для некоторых популярных образов, таких как «ubuntu», «debian», но они будут обновлены в момент попытки их использования.

Если вы создали образ на предыдущем этапе сборки, он будет сохранен в кэше демона Docker хоста и доступен для использования в качестве имени для последующего этапа сборки.

Возвращено: success

secretEnv

list / elements=string

Список переменных среды, зашифрованных с помощью криптографического ключа службы управления ключами Cloud KMS. Эти значения должны быть указаны в разделе `Secret` сборки.

Возвращено: success

timeout

string

Тайм-лимит для выполнения этого этапа сборки. Если не определено, этап не имеет ограничения по времени и может выполняться до тех пор, пока не завершится или не истечет время ожидания самой сборки.

Возвращено: success

timing

string

Только для вывода. Сохраняет информацию о времени выполнения этого этапа сборки.

Возвращено: success

volumes

complex

Список томов для монтирования на этапе сборки.

Каждый том создается как пустой том до выполнения этапа сборки. После завершения сборки тома и их содержимое удаляются.

Использование именованного тома только на одном этапе недопустимо, поскольку это указывает на запрос сборки с неправильной конфигурацией.

Возвращено: success

name

string

Имя монтируемого тома.

Имена томов должны быть уникальными для каждого этапа сборки и должны быть допустимыми именами для томов Docker. Каждый именованный том должен использоваться как минимум двумя этапами сборки.

Возвращено: success

path

string

Путь, по которому будет смонтирован том.

Пути должны быть абсолютными и не должны конфликтовать с другими путями томов на одном этапе сборки или с некоторыми зарезервированными путями томов.

Возвращено: success

waitFor

list / elements=string

ID этапа(ов), от которого(ых) зависит этот этап сборки.

Этот этап сборки не начнётся, пока все этапы сборки в `wait_for` не будут успешно завершены. Если `wait_for` пуст, этот этап сборки начнётся, когда все предыдущие этапы сборки в списке `Build.Steps` будут успешно завершены.

Возвращено: success

substitutions

dictionary

Данные подстановок для ресурса сборки.

Возвращено: success

tags

list / elements=string

Теги для аннотации сборки. Это не теги Docker.

Возвращено: success

timeout

string

Количество времени, в течение которого эта сборка должна выполняться с точностью до секунды.

Если это время истечёт, работа над сборкой прекратится, а статус сборки будет TIMEOUT.

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

Ожидаемый формат — количество секунд с последующей буквой s.

Время по умолчанию — десять минут (600s).

Возвращено: success

createTime

string

Время создания триггера.

Возвращено: success

description

string

Чёткие описание триггера.

Возвращено: success

disabled

boolean

Отключен ли триггер или нет. Если true, триггер никогда не приведёт к сборке.

Возвращено: success

filename

string

Путь от корня источника к файлу, содержимое которого используется для шаблона. Необходимо указать либо имя файла, либо шаблон сборки.

Возвращено: success

github

complex

Описывает конфигурацию триггера, который создает сборку при получении события GitHub.

Возвращено: success

name

string

Имя репозитория. Например: Имя для https://github.com/googlecloudplatform/cloud-builders — «cloud-builders».

Возвращено: success

owner

строка

Владелец репозитория. Например: Владелец для https://github.com/googlecloudplatform/cloud-builders — “googlecloudplatform”.

Возвращаемое значение: успех

pullRequest

сложная

Фильтр для сопоставления изменений в запросах на вытягивание. Укажите только одно из pullRequest или push.

Возвращаемое значение: успех

branch

строка

Регулярное выражение для сопоставления ветвей.

Возвращаемое значение: успех

commentControl

строка

Блокировать ли сборку при комментарии “/gcbrun” от владельца репозитория или сотрудника.

Возвращаемое значение: успех

invertRegex

логический

Если true, ветви, которые НЕ соответствуют git_ref, будут запускать сборку.

Возвращаемое значение: успех

push

сложная

Фильтр для сопоставления изменений в refs, таких как ветви или теги. Укажите только одно из pullRequest или push.

Возвращаемое значение: успех

branch

строка

Регулярное выражение для сопоставления ветвей. Укажите только одно из branch или tag.

Возвращаемое значение: успех

invertRegex

логический

При значении true, сборка запускается только если регулярное выражение для ревизии НЕ соответствует регулярному выражению для git_ref.

Возвращаемое значение: успех

tag

строка

Регулярное выражение для сопоставления тегов. Укажите только одно из branch или tag.

Возвращаемое значение: успех

id

строка

Уникальный идентификатор триггера.

Возвращаемое значение: успех

ignoredFiles

список / элементы=строка

ignoredFiles и includedFiles — соответствия шаблонам файлов с использованием https://golang.org/pkg/path/filepath/#Match, расширенные поддержкой `**`.

Если ignoredFiles и изменённые файлы оба пустые, то они не используются для определения необходимости запуска сборки.

Если ignoredFiles не пустой, то любые файлы, соответствующие любому из игнорируемых шаблонов файлов, игнорируются. Если изменение не содержит файлов, находящихся вне игнорируемых файлов, сборка не запускается.

Возвращаемое значение: успех

includedFiles

список / элементы=строка

ignoredFiles и includedFiles — соответствия шаблонам файлов с использованием https://golang.org/pkg/path/filepath/#Match, расширенные поддержкой `**`.

Если какие-либо из файлов, изменённых в коммите, проходят фильтр ignoredFiles, а includedFiles пуст, то, с точки зрения этого фильтра, сборка должна быть запущена.

Если какие-либо из файлов, изменённых в коммите, проходят фильтр ignoredFiles, а includedFiles не пуст, то проверяется, соответствует ли хотя бы один из этих файлов шаблону includedFiles. Если нет, сборка не запускается.

Возвращаемое значение: успех

name

строка

Имя триггера. Должно быть уникальным в проекте.

Возвращаемое значение: успех

pubsubConfig

сложная

PubsubConfig описывает конфигурацию триггера, запускающего сборку при публикации сообщения Pub/Sub.

Возвращаемое значение: успех

service_account_email

строка

Учётная запись службы, которая будет выполнять запрос на отправку.

Возвращаемое значение: успех

state

строка

Возможные проблемы с конфигурацией базовой подписки Pub/Sub.

Заполняется только при запросах получения.

Возвращаемое значение: успех

subscription

строка

Только для вывода. Имя подписки.

Возвращаемое значение: успех

topic

строка

Имя темы, из которой эта подписка получает сообщения.

Возвращаемое значение: успех

substitutions

словарь

Данные подстановок для ресурса сборки.

Возвращаемое значение: успех

тэги

список / элементы=строка

Тэги для аннотации триггера сборки.

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

шаблонТриггера

сложный

Шаблон, описывающий типы изменений источника, которые запускают сборку.

Имена ветвей и тегов в шаблонах триггеров интерпретируются как регулярные выражения. Любое изменение ветви или тега, соответствующее этому регулярному выражению, запустит сборку.

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

имяВетви

строка

Имя ветви для сборки. Должно быть указано ровно одно из имени ветви, тега или SHA коммита.

Это поле является регулярным выражением.

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

commitSha

строка

Явный SHA коммита для сборки. Должно быть указано ровно одно из имени ветви, тега или SHA коммита.

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

dir

строка

Директория, относительно корня источника, в которой выполняется сборка.

Это должен быть относительный путь. Если для шага указан dir и это абсолютный путь, это значение игнорируется для выполнения этого шага.

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

инвертироватьRegex

булево

Запустить сборку только если регулярное выражение ревизии НЕ совпадает с регулярным выражением ревизии.

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

projectId

строка

ID проекта, которому принадлежит Cloud Source Repository. Если опущено, предполагается, что это ID проекта, запрашивающего сборку.

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

имяРепозитория

строка

Имя Cloud Source Repository. Если опущено, предполагается имя «default».

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

имяТега

строка

Имя тега для сборки. Должно быть указано ровно одно из имени ветви, тега или SHA коммита.

Это поле является регулярным выражением.

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

конфигурацияWebhook

сложный

WebhookConfig описывает конфигурацию триггера, который создает сборку всякий раз, когда вебхук отправляется в URL вебхука триггера.

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

секрет

строка

Имя ресурса секрета, требуемого в качестве параметра URL.

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

состояние

строка

Возможные проблемы с конфигурацией подписки Pub/Sub.

Заполняется только при запросах получения.

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

Авторы

  • Google Inc. (@googlecloudplatform)

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

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (исходный код)

© 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/google/cloud/gcp_cloudbuild_trigger_module.html

Spec-Zone.ru

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