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

access_token

string

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

auth_kind

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

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

Варианты:

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

env_type

string

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

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

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

location

string

[Регион Cloud Build](https://cloud.google.com/build/docs/locations) для триггера.

Если не указано, используется значение «global».

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

project

string

Проект Google Cloud Platform, который необходимо использовать.

scopes

list / элементы типа string

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

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

resources

complex

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

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

build

complex

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

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

artifacts

complex

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

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

images

list / elements=string

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

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

Дайджесты отправленных образов будут сохранены в поле results ресурса Build.

Если не удастся отправить какой-либо образ, сборка получит статус FAILURE.

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

objects

complex

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

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

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

Если не удастся отправить какой-либо объект, сборка получит статус FAILURE.

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

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

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

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

Дайджесты отправленных образов будут сохранены в поле results ресурса Build.

Если не удастся отправить какой-либо образ, статус сборки будет установлен в FAILURE.

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

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

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

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

logStreamingOption

string

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

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

machineType

string

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

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

requestedVerifyOption

string

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

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

secretEnv

list / elements=string

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

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

sourceProvenanceHash

list / elements=string

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

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

substitutionOption

string

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

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

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

volumes

complex

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

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

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

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

name

string

Имя подключаемого тома.

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

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

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

path

string

Путь, по которому подключается том.

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

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

workerPool

string

Параметр, задающий WorkerPool для сборки. Формат: projects/{project}/workerPools/{workerPool}. Это экспериментальное поле.

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

queueTtl

string

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

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

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

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

secrets

complex

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

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

kmsKeyName

string

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

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

secretEnv

dictionary

Соответствие имен переменных окружения их зашифрованным значениям.

Имена секретных переменных окружения должны быть уникальными среди всех секретов сборки, и как минимум одна из них должна использоваться на этапе сборки. Размер значения не должен превышать 64 КБ. Общее количество секретных значений во всех секретах сборки не должно превышать 100.

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

source

complex

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

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

repoSource

complex

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

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

branchName

string

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

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

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

commitSha

string

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

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

dir

string

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

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

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

invertRegex

boolean

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

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

projectId

string

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

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

repoName

string

Имя Cloud Source Repository.

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

substitutions

dictionary

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

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

tagName

string

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

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

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

storageSource

complex

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

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

bucket

string

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

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

generation

string

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

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

object

string

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

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

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

steps

complex

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

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

args

list / elements=string

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

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

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

dir

string

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

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

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

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

entrypoint

string

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

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

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

env

list / elements=string

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

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

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

id

string

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

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

name

string

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

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

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

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

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

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

secretEnv

list / elements=string

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

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

timeout

string

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

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

timing

string

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

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

volumes

complex

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

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

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

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

name

string

Имя подключаемого тома.

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

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

path

string

Путь, по которому подключается том.

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

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

waitFor

list / elements=string

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

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

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

substitutions

dictionary

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

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

tags

list / elements=string

Теги для аннотирования Build. Это не теги Docker.

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

timeout

string

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

По истечении этого времени выполнение сборки прекратится, а ее статус будет TIMEOUT.

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

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

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

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

createTime

string

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

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

description

string

Понятное для пользователя описание триггера.

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

disabled

boolean

Указывает, отключен ли триггер. Если значение равно true, триггер никогда не приведет к запуску сборки.

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

filename

string

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

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

github

complex

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

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

name

string

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

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

owner

string

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

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

pullRequest

complex

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

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

branch

string

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

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

commentControl

string

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

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

invertRegex

boolean

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

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

push

complex

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

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

branch

string

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

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

invertRegex

boolean

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

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

tag

string

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

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

id

string

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

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

ignoredFiles

list / elements=string

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

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

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

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

includedFiles

list / elements=string

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

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

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

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

name

string

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

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

pubsubConfig

complex

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

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

service_account_email

string

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

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

state

string

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

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

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

subscription

string

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

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

topic

string

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

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

substitutions

dictionary

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

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

tags

list / elements=string

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

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

triggerTemplate

complex

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

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

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

branchName

string

Имя ветки для сборки. Необходимо указать ровно одно из следующего: имя ветки, тег или SHA коммита.

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

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

commitSha

string

Явно заданный SHA коммита для сборки. Необходимо указать ровно одно из следующего: имя ветки, тег или SHA коммита.

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

dir

string

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

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

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

invertRegex

boolean

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

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

projectId

string

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

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

repoName

string

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

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

tagName

string

Имя тега для сборки. Необходимо указать ровно одно из следующего: имя ветки, тег или SHA коммита.

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

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

webhookConfig

complex

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

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

secret

string

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

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

state

string

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

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

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