Модуль google.cloud.gcp_cloudbuild_trigger_info — Сбор информации о триггере GCP

resources

complex

Список ресурсов

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

build

complex

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

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

artifacts

complex

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

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

images

list / elements=string

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

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

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

Если отправка любого из образов завершится неудачей, сборка помечается как НЕУДАЧНАЯ.

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

objects

complex

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

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

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

Если загрузка любых объектов завершится неудачей, сборка помечается как НЕУДАЧНАЯ.

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

location

string

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

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

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

paths

list / elements=string

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

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

timing

complex

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

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

endTime

string

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

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

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

startTime

string

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

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

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

images

list / elements=string

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

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

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

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

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

logsBucket

string

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

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

options

complex

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

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

diskSizeGb

integer

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

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

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

dynamicSubstitutions

boolean

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

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

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

env

list / elements=string

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

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

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

logging

string

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

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

logStreamingOption

string

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

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

machineType

string

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

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

requestedVerifyOption

string

Запрошенные параметры проверяемости.

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

secretEnv

list / elements=string

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

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

sourceProvenanceHash

list / elements=string

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

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

substitutionOption

string

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

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

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

volumes

complex

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

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

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

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

name

string

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

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

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

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

path

string

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

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

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

workerPool

string

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

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

queueTtl

string

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

Время жизни начинается с createTime.

Продолжительность в секундах с точностью до девяти дробных знаков, завершающаяся ‘s’. Пример: “3.5s”.

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

secrets

complex

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

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

kmsKeyName

string

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

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

secretEnv

dictionary

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

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

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

source

complex

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

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

repoSource

complex

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

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

branchName

string

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

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

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

commitSha

string

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

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

dir

string

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

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

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

invertRegex

boolean

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

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

projectId

string

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

Возвращено: 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

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

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

Возвращено: 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 Key Management Service. Эти значения должны быть указаны в `Secret` сборки.

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

timeout

string

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

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

timing

string

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

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

volumes

complex

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

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

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

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

name

string

Имя тома для монтирования.

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

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

path

string

Путь для монтирования тома.

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

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

waitFor

list / elements=string

Идентификатор(ы) шага(ов), от которых зависит данный шаг сборки.

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

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

substitutions

dictionary

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

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

tags

list / elements=string

Теги для аннотации ресурса Build. Это не теги 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

string

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

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

pullRequest

complex

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

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

branch

string

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

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

commentControl

string

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

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

invertRegex

boolean

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

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

push

complex

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

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

branch

string

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

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

invertRegex

boolean

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

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

tag

string

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

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

id

string

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

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

ignoredFiles

list / elements=string

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

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

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

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

includedFiles

list / elements=string

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

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

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

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

name

string

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

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

pubsubConfig

complex

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

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

service_account_email

string

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

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

state

string

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

Заполняется только в запросах get.

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

subscription

string

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

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

topic

string

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

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

substitutions

dictionary

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

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

tags

list / elements=string

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

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

triggerTemplate

complex

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

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

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

branchName

string

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

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

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

commitSha

string

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

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

dir

string

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

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

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

invertRegex

boolean

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

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

projectId

string

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

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

repoName

string

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

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

tagName

string

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

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

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

webhookConfig

complex

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

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

secret

string

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

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

state

string

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

Заполняется только в запросах get.

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