google.cloud.gcp_cloudbuild_trigger – Создаёт триггер GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в плейбуке укажите: google.cloud.gcp_cloudbuild_trigger.
Обзор
- Настройка автоматизированного сборки в ответ на изменения в репозитории исходного кода.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |||
| build словарь | Содержание шаблона сборки. Должен быть указан либо файл, либо шаблон сборки. | ||||
| artifacts словарь | Артефакты, созданные в ходе сборки и которые должны быть загружены по успешному выполнению всех шагов сборки. | ||||
| images список / элементы=строка | Список изображений, которые должны быть опубликованы после успешного выполнения всех шагов сборки. Изображения будут опубликованы с использованием учетных данных сервисного аккаунта билдера. Хэши опубликованных изображений будут сохранены в поле результатов ресурса Сборка. Если какое-либо из изображений не удастся опубликовать, статус сборки будет отмечен как ОШИБКА. | ||||
| objects словарь | Список объектов, которые должны быть загружены в хранилище 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 к подстановкам. ПРИМЕЧАНИЕ: для триггерных сборок это всегда включено и не может быть переопределено в файле конфигурации сборки. | |||
| 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" | ||||
| requested_verify_option строка | Запрашиваемые параметры проверки. Некоторые допустимые значения: "NOT_VERIFIED", "VERIFIED" | ||||
| secret_env список / элементы=строка | Список глобальных переменных среды, которые зашифрованы с использованием службы Cloud Key Management Service. Эти значения должны быть указаны в секрете сборки. Эти переменные будут доступны всем шагам сборки в этой сборке. | ||||
| source_provenance_hash список / элементы=строка | Запрашиваемый хэш для SourceProvenance. | ||||
| substitution_option строка | Параметр, определяющий поведение при возникновении ошибки в проверках подстановки. ПРИМЕЧАНИЕ: для триггерных сборок это всегда устанавливается в ALLOW_LOOSE и не может быть переопределено в файле конфигурации сборки. Некоторые допустимые значения: "MUST_MATCH", "ALLOW_LOOSE" | ||||
| volumes список / элементы=словарь | Глобальный список томов для монтирования для ВСЕХ шагов сборки. Каждый том создается как пустой том перед началом процесса сборки. По завершении сборки тома и их содержимое удаляются. Глобальные имена и пути томов не должны конфликтовать с томами, определенными в шаге сборки. Использование глобального тома в сборке с только одним шагом недействительно, так как это указывает на запрос сборки с неправильной конфигурацией. | ||||
| name строка | Имя монтируемого тома. Имена томов должны быть уникальными для каждого шага сборки и должны быть допустимыми именами для томов Docker. Каждый именованный том должен использоваться как минимум двумя шагами сборки. | ||||
| path строка | Путь для монтирования тома. Пути должны быть абсолютными и не должны конфликтовать с другими путями томов в том же шаге сборки или с определенными резервированными путями томов. | ||||
| worker_pool строка | Параметр для указания пула WorkerPool для сборки. Формат projects/{project}/workerPools/{workerPool}. Это экспериментальное поле. | ||||
| queue_ttl строка | Срок действия в очереди для этой сборки. Если задано и сборка находится в очереди дольше этого значения, сборка истекает, а статус сборки становится ИСТЕКЛА. Срок действия начинает отсчет с createTime. Длительность в секундах с максимум девятью дробными цифрами, заканчивающимися на 's'. Пример: "3.5s". | ||||
| secrets список / элементы=словарь | Секреты для расшифровки с помощью Cloud Key Management Service. | ||||
| kms_key_name строка / обязательно | Имя ключа Cloud KMS для расшифровки этих переменных среды. | ||||
| secret_env словарь | Карта имени переменной среды ее зашифрованному значению. Секретные переменные среды должны быть уникальными для всех секретов сборки и должны использоваться как минимум одним шагом сборки. Значения могут быть не больше 64 КБ. Может быть не более 100 секретных значений для всех секретов сборки. | ||||
| source словарь | Расположение исходных файлов для сборки. | ||||
| repo_source словарь | Расположение исходного кода в Google Cloud Source Repository. | ||||
| branch_name строка | Регулярное выражение, сопоставляющее ветви для сборки. Должен быть указан ровно один из имени ветви, тега или SHA коммита. Синтаксис поддерживаемых регулярных выражений соответствует синтаксису RE2 и описан на странице https://github.com/google/re2/wiki/Syntax . | ||||
| commit_sha строка | Явное значение SHA коммита для сборки. Должен быть указан ровно один из имени ветви, тега или SHA коммита. | ||||
| dir строка | Директория, относительно корня исходного кода, в которой будет выполняться сборка. Должен быть относительный путь. Если для шага указан абсолютный путь в dir, это значение игнорируется для выполнения данного шага. | ||||
| invert_regex булево |
| Вызывать сборку только в том случае, если регулярное выражение для ревизии НЕ соответствует регулярному выражению ревизии. | |||
| project_id строка | Идентификатор проекта, которому принадлежит Cloud Source Repository. Если опущено, предполагается использование идентификатора проекта, запрашивающего сборку. | ||||
| repo_name строка / обязательно | Имя Cloud Source Repository. | ||||
| substitutions словарь | Подстановки для использования в триггерной сборке. Должны использоваться только с триггерами.run. | ||||
| tag_name строка | Регулярное выражение, сопоставляющее теги для сборки. Должен быть указан ровно один из имени ветви, тега или SHA коммита. Синтаксис поддерживаемых регулярных выражений соответствует синтаксису RE2 и описан на странице https://github.com/google/re2/wiki/Syntax . | ||||
| storage_source словарь | Расположение исходного кода в файле архива в Google Cloud Storage. | ||||
| bucket строка / обязательно | Ведро Google Cloud Storage, содержащее исходный код. | ||||
| generation строка | Номер генерации объекта в Google Cloud Storage. Если номер генерации не указан, будет использоваться последняя генерация. | ||||
| object строка / обязательно | Объект Google Cloud Storage, содержащий исходный код. Этот объект должен быть сжатым архивом (.tar.gz), содержащим исходный код для сборки. | ||||
| steps список / элементы=словарь / обязательно | Операции, которые будут выполнены в рабочей области. | ||||
| args список / элементы=строка | Список аргументов, которые будут переданы шагу при его запуске. Если образ, используемый для выполнения контейнера шага, имеет точку входа, аргументы используются в качестве аргументов для этой точки входа. Если образ не определяет точку входа, первый элемент в args используется как точка входа, а остальные — как аргументы. | ||||
| dir строка | Рабочая директория для использования при выполнении контейнера этого шага. Если это относительный путь, он относится к рабочей директории сборки. Если это абсолютный путь, он может находиться за пределами рабочей директории сборки, в этом случае содержимое пути может не сохраниться между выполнениями шагов сборки, если не указан `volume` для этого пути. Если сборка указывает `RepoSource` с `dir` и шаг с `dir`, который указывает абсолютный путь, `RepoSource` `dir` игнорируется для выполнения шага. | ||||
| entrypoint строка | Точка входа, которая будет использоваться вместо точки входа по умолчанию образа шага сборки. Если не задано, используется точка входа по умолчанию образа. | ||||
| env список / элементы=строка | Список определений переменных среды, которые будут использоваться при запуске шага. Элементы имеют вид "KEY=VALUE", где переменной "KEY" присваивается значение "VALUE". | ||||
| id строка | Уникальный идентификатор для этого шага сборки, используемый в `wait_for` для ссылки на этот шаг сборки в качестве зависимости. | ||||
| name строка / обязательно | Имя образа контейнера, который будет выполняться на этом конкретном шаге сборки. Если образ доступен в кэше демона Docker хоста, он будет запущен непосредственно. Если нет, хост попытается сначала скачать образ, используя учетные данные сервисного аккаунта билдера при необходимости. В кэше демона Docker уже будут доступны последние версии всех официально поддерживаемых шагов сборки (см. https://github.com/GoogleCloudPlatform/cloud-builders для получения изображений и примеров). Деммон Docker также будет кэшировать многие слои для некоторых популярных образов, таких как "ubuntu", "debian", но они будут обновляться в момент попытки их использования. Если вы создали образ на предыдущем шаге сборки, он будет сохранён в кэше демона Docker хоста и будет доступен для использования на последующем шаге сборки. | ||||
| secret_env список / элементы=строка | Список переменных среды, которые шифруются с использованием ключа шифрования Cloud Key Management Service. Эти значения должны быть указаны в `Secret` сборки. | ||||
| timeout строка | Предельное время выполнения данного шага сборки. Если не определено, у шага нет лимита времени и он будет выполняться до завершения либо до истечения времени ожидания самой сборки. | ||||
| timing строка | Только для вывода. Хранит информацию о времени выполнения этого шага сборки. | ||||
| volumes список / элементы=словарь | Список томов для подключения к шагу сборки. Каждый том создается как пустой том до начала выполнения шага сборки. После завершения сборки тома и их содержимое удаляются. Использование именованного тома только в одном шаге неверно, так как это указывает на запрос сборки с неправильной конфигурацией. | ||||
| name строка / обязательно | Имя тома для подключения. Имена томов должны быть уникальными для каждого шага сборки и должны быть допустимыми именами для томов Docker. Каждый именованный том должен использоваться как минимум двумя шагами сборки. | ||||
| path строка / обязательно | Путь для подключения тома. Пути должны быть абсолютными и не должны конфликтовать с другими путями томов в том же шаге сборки или с некоторыми зарезервированными путями томов. | ||||
| wait_for список / элементы=строка | Идентификатор(ы) шага(ов), от которого зависит этот шаг сборки. Этот шаг сборки не начнется, пока все шаги сборки в `wait_for` не будут выполнены успешно. Если `wait_for` пустой, этот шаг сборки начнется, когда все предыдущие шаги сборки в списке `Build.Steps` будут выполнены успешно. | ||||
| substitutions словарь | Данные подстановок для ресурса Build. | ||||
| tags список / элементы=строка | Теги для аннотации Build. Это не теги Docker. | ||||
| timeout string | Default: "600s" | Время выполнения этой сборки в секундах. Если это время истечёт, работа над сборкой прекратится, и статус сборки будет TIMEOUT. Это время ожидания должно быть равно или больше суммы времени ожидания для шагов сборки внутри сборки. Ожидаемый формат — количество секунд, за которым следует s. По умолчанию время составляет десять минут (600s). | |||
| description string | Описание триггера для чтения человеком. | ||||
| disabled boolean |
| Отключен ли триггер. Если значение true, триггер никогда не приведёт к сборке. | |||
| env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Это поле не следует устанавливать, если вы не знаете, что делаете. Это поле изменяет только строку User Agent для всех запросов API. | ||||
| filename string | Путь к файлу от корня исходного кода, содержимое которого используется для шаблона. Должен быть указан либо файл, либо шаблон сборки. | ||||
| github dictionary | Описывает конфигурацию триггера, который создаёт сборку при получении события GitHub. | ||||
| name string | Имя репозитория. Например: имя для https://github.com/googlecloudplatform/cloud-builders — "cloud-builders". | ||||
| owner string | Владелец репозитория. Например: владелец для https://github.com/googlecloudplatform/cloud-builders — "googlecloudplatform". | ||||
| pull_request dictionary | Фильтр для сопоставления изменений в запросах на добавление. Укажите только одно из полей pullRequest или push. | ||||
| branch string / required | Регулярное выражение для сопоставления веток. | ||||
| comment_control string | Блокировать ли сборки по комментарию "/gcbrun" от владельца или участника репозитория. Некоторые допустимые значения: "COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY" | ||||
| invert_regex boolean |
| Если значение true, ветки, НЕ соответствующие git_ref, запускают сборку. | |||
| push dictionary | Фильтр для сопоставления изменений в разделах, таких как ветки или теги. Укажите только одно из полей pullRequest или push. | ||||
| branch string | Регулярное выражение для сопоставления веток. Укажите только одно из полей branch или tag. | ||||
| invert_regex boolean |
| Если значение true, сборка запускается только в том случае, если выражение соответствия пересмотра НЕ совпадает с выражением соответствия git_ref. | |||
| tag string | Регулярное выражение для сопоставления тегов. Укажите только одно из полей branch или tag. | ||||
| id string | Уникальный идентификатор триггера. | ||||
| ignored_files list / elements=string | ignoredFiles и includedFiles — соответствия шаблонам файлов, использующие https://golang.org/pkg/path/filepath/#Match, расширенные с поддержкой `**`. Если ignoredFiles и changed files оба пусты, то они не используются для определения запуска сборки. Если ignoredFiles не пустой, то мы игнорируем все файлы, которые соответствуют любому из шаблонов ignored_file. Если у изменения нет файлов, которые находятся за пределами шаблонов ignoredFiles, то мы не запускаем сборку. | ||||
| included_files list / elements=string | ignoredFiles и includedFiles — соответствия шаблонам файлов, использующие https://golang.org/pkg/path/filepath/#Match, расширенные с поддержкой `**`. Если любые из файлов, изменённых в коммите, проходят фильтр ignoredFiles, и includedFiles пустой, то, что касается этого фильтра, мы должны запустить сборку. Если любые из файлов, изменённых в коммите, проходят фильтр ignoredFiles, и includedFiles не пустой, то мы проверяем, что хотя бы один из этих файлов соответствует шаблону includedFiles. Если нет, то мы не запускаем сборку. | ||||
| name string | Имя триггера. Должно быть уникальным в проекте. | ||||
| project string | Используемый проект Google Cloud Platform. | ||||
| scopes list / elements=string | Массив используемых областей. | ||||
| service_account_contents jsonarg | Содержимое файла JSON учётной записи службы, либо в словаре, либо в виде строки JSON, представляющей его. | ||||
| service_account_email string | Необязательный адрес электронной почты учётной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | ||||
| service_account_file path | Путь к файлу JSON учётной записи службы, если тип serviceaccount выбран как тип. | ||||
| state string |
| Существует ли данный объект в GCP | |||
| substitutions dictionary | Данные подстановок для ресурса Build. | ||||
| tags list / elements=string | Теги для аннотации BuildTrigger. | ||||
| trigger_template dictionary | Шаблон, описывающий типы изменений источника для запуска сборки. Имена веток и тегов в шаблонах триггеров интерпретируются как регулярные выражения. Любое изменение ветки или тега, соответствующее этому регулярному выражению, запускает сборку. | ||||
| branch_name string | Имя ветки для сборки. Должен быть указан один из следующих параметров: имя ветки, имя тега или SHA коммита. Это поле — регулярное выражение. | ||||
| commit_sha string | Явный SHA коммита для сборки. Должен быть указан один из следующих параметров: имя ветки, имя тега или SHA коммита. | ||||
| dir string | Директория, относительная к корню источника, в которой выполняется сборка. Это должен быть относительный путь. Если для шага указан абсолютный путь, это значение игнорируется для выполнения этого шага. | ||||
| invert_regex boolean |
| Запустить сборку только в том случае, если выражение соответствия пересмотра не соответствует выражению соответствия пересмотра. | |||
| project_id string | ID проекта, который владеет репозиторием Cloud Source. Если опущен, предполагается ID проекта, запрашивающего сборку. | ||||
| repo_name string | Default: "default" | Имя репозитория Cloud Source. Если опущен, предполагается имя "default". | |||
| tag_name string | Имя тега для сборки. Должен быть указан один из следующих параметров: имя ветки, имя тега или SHA коммита. Это поле — регулярное выражение. | ||||
Примечания
Примечание
- Ссылка на 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. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных окружения будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
- Идентификатор этого ресурса создается API после первого создания ресурса. Если вы хотите управлять этим ресурсом после создания, вам необходимо скопировать сгенерированный идентификатор в playbook. В противном случае новые триггеры будут создаваться при последующих запусках.
Примеры
- 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 | success | Список изображений, которые должны быть загружены при успешном выполнении всех этапов сборки. Изображения будут загружены с помощью учетных данных сервисного аккаунта билдера. Хеши загруженных изображений будут сохранены в поле результатов ресурса сборки. Если какое-либо из изображений не удается загрузить, сборка помечается как ОШИБКА. | ||||
| objects complex | success | Список объектов, которые должны быть загружены в Cloud Storage при успешном выполнении всех этапов сборки. Файлы в рабочем пространстве, соответствующие указанным шаблонам путей, будут загружены в местоположение Cloud Storage с использованием учетных данных сервисного аккаунта билдера. Местоположение и информация о созданных объектах будут сохранены в поле результатов ресурса сборки. Если какой-либо объект не удается загрузить, сборка помечается как ОШИБКА. | ||||
| location string | success | Ведро Cloud Storage и необязательный путь к объекту в формате "gs://bucket/path/to/somewhere/". Файлы в рабочем пространстве, соответствующие любому шаблону пути, будут загружены в Cloud Storage с этим местоположением в качестве префикса. | ||||
| paths list / elements=string | success | Шаблоны путей, используемые для сопоставления файлов в рабочем пространстве сборки. | ||||
| timing complex | success | Только для вывода. Хранит информацию о времени загрузки всех артефактов. | ||||
| endTime string | success | Конец временного интервала. Отметка времени в формате RFC3339 UTC "Zulu", с разрешением до наносекунд и до девяти десятичных знаков. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z". | ||||
| startTime string | success | Начало временного интервала. Отметка времени в формате RFC3339 UTC "Zulu", с разрешением до наносекунд и до девяти десятичных знаков. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z". | ||||
| images list / elements=string | success | Список изображений, которые должны быть загружены при успешном выполнении всех этапов сборки. Изображения загружаются с использованием учетных данных сервисного аккаунта билдера. Хеши загруженных изображений будут сохранены в поле результатов ресурса сборки. Если какое-либо из изображений не удаётся загрузить, статус сборки помечается как ОШИБКА. | ||||
| logsBucket string | success | Ведро Google Cloud Storage, в котором должны быть записаны журналы. Имена файлов журналов будут иметь формат ${logsBucket}/log-${build_id}.txt. | ||||
| options complex | success | Специальные параметры для этой сборки. | ||||
| diskSizeGb integer | success | Запрашиваемый размер диска для виртуальной машины, на которой выполняется сборка. Обратите внимание, что это НЕ «свободное пространство на диске»; часть пространства будет использоваться операционной системой и утилитами сборки. Также обратите внимание, что это минимальный размер диска, который будет выделен для сборки — сборка может выполняться с диском большего размера, чем запрошенный. В настоящее время максимальный размер диска составляет 1000 ГБ; сборки, запрашивающие размер больше максимального, отклоняются с ошибкой. | ||||
| dynamicSubstitutions boolean | success | Параметр, указывающий, следует ли применять операции с строками в стиле bash к подстановкам. ПРИМЕЧАНИЕ. Это всегда включено для триггерных сборок и не может быть переопределено в файле конфигурации сборки. | ||||
| env list / elements=string | success | Список глобальных определений переменных среды, которые будут существовать для всех этапов сборки в этой сборке. Если переменная определена как глобально, так и на этапе сборки, переменная будет использовать значение этапа сборки. Элементы имеют вид "KEY=VALUE", где переменной "KEY" присвоено значение "VALUE". | ||||
| logging string | success | Параметр для задания режима ведения журналов, который определяет, сохраняются ли и где хранятся журналы сборки. | ||||
| logStreamingOption string | success | Параметр для определения поведения потоковой передачи журналов сборки в Google Cloud Storage. | ||||
| machineType string | success | Тип виртуальной машины Compute Engine, на которой будет выполняться сборка. | ||||
| requestedVerifyOption string | success | Запрашиваемые параметры проверки. | ||||
| secretEnv list / elements=string | success | Список глобальных переменных среды, которые зашифрованы с помощью криптоключа Cloud Key Management Service. Эти значения должны быть указаны в секрете сборки. Эти переменные будут доступны для всех этапов сборки в этой сборке. | ||||
| sourceProvenanceHash list / elements=string | success | Запрошенный хеш для SourceProvenance. | ||||
| substitutionOption string | success | Параметр для задания поведения при возникновении ошибки в проверках подстановок. ПРИМЕЧАНИЕ. Для триггерных сборок он всегда установлен в значение ALLOW_LOOSE и не может быть переопределён в файле конфигурации сборки. | ||||
| volumes complex | success | Глобальный список томов для монтирования для ВСЕХ этапов сборки. Каждый том создается как пустой том перед началом процесса сборки. После завершения сборки тома и их содержимое удаляются. Имена и пути глобальных томов не могут конфликтовать с томами, определенными на этапе сборки. Использование глобального тома в сборке только с одним этапом недействительно, так как это указывает на запрос сборки с неправильной конфигурацией. | ||||
| name string | success | Имя тома для монтирования. Имена томов должны быть уникальными для каждого этапа сборки и должны быть допустимыми именами для томов Docker. Каждое именованное тома должно использоваться как минимум двумя этапами сборки. | ||||
| path string | success | Путь для монтирования тома. Пути должны быть абсолютными и не могут конфликтовать с другими путями томов на том же этапе сборки или с определенными зарезервированными путями томов. | ||||
| workerPool string | success | Параметр для задания пула WorkerPool для сборки. Формат projects/{project}/workerPools/{workerPool}. Это экспериментальное поле. | ||||
| queueTtl string | success | Срок хранения в очереди для данной сборки. Если указан и сборка находится в очереди дольше этого значения, сборка истечет, и статус сборки будет ИСТЕКШЕЕ. Срок хранения начинает отсчет с createTime. Продолжительность в секундах с точностью до девяти десятичных знаков, завершенная символом «s». Пример: «3,5s». | ||||
| secrets complex | success | Секреты для расшифровки с помощью Cloud Key Management Service. | ||||
| kmsKeyName string | success | Имя ключа Cloud KMS, используемого для расшифровки этих переменных среды. | ||||
| secretEnv словарь | success | Карта имени переменной окружения к её зашифрованному значению. Переменные окружения типа secret должны быть уникальными для всех секретов сборки и использоваться по крайней мере одним шагом сборки. Значения могут быть не более 64 КБ. Максимальное количество секретных значений во всех секретах сборки — 100. | ||||
| source сложный | success | Расположение исходных файлов для сборки. | ||||
| repoSource сложный | success | Расположение исходного кода в хранилище Google Cloud Source. | ||||
| branchName строка | success | Регулярное выражение, сопоставляющее ветви для сборки. Должна быть указана ровно одна из ветви, тега или хэша коммита. Синтаксис поддерживаемых регулярных выражений соответствует синтаксису RE2, описанному на https://github.com/google/re2/wiki/Syntax. | ||||
| commitSha строка | success | Явное значение хэша коммита для сборки. Должна быть указана ровно одна из ветви, тега или хэша коммита. | ||||
| dir строка | success | Директория, относительная к корню исходного кода, в которой следует выполнить сборку. Это должен быть относительный путь. Если для шага указан `dir` в абсолютном пути, это значение игнорируется для выполнения этого шага. | ||||
| invertRegex логическое | success | Запускать сборку только в том случае, если регулярное выражение для ревизии не соответствует регулярному выражению для ревизии. | ||||
| projectId строка | success | Идентификатор проекта, владеющего хранилищем Cloud Source. Если опущено, используется идентификатор проекта, запрашивающего сборку. | ||||
| repoName строка | success | Имя хранилища Cloud Source. | ||||
| substitutions словарь | success | Подстановки для использования в сборке, запущенной по триггеру. Должны использоваться только с `triggers.run`. | ||||
| tagName строка | success | Регулярное выражение, сопоставляющее теги для сборки. Должна быть указана ровно одна из ветви, тега или хэша коммита. Синтаксис поддерживаемых регулярных выражений соответствует синтаксису RE2, описанному на https://github.com/google/re2/wiki/Syntax. | ||||
| storageSource сложный | success | Расположение исходного кода в архивном файле в Google Cloud Storage. | ||||
| bucket строка | success | Ведро Google Cloud Storage, содержащее исходный код. | ||||
| generation строка | success | Поколение Google Cloud Storage для объекта. Если поколение опущено, используется последнее поколение. | ||||
| object строка | success | Объект Google Cloud Storage, содержащий исходный код. Этот объект должен быть сжатым архивным файлом (.tar.gz), содержащим исходный код для сборки. | ||||
| steps сложный | success | Операции, которые необходимо выполнить в рабочей области. | ||||
| args список / элементы=строка | success | Список аргументов, которые будут переданы шагу при его запуске. Если для запуска шага используется образ, у которого есть точка входа, `args` используется в качестве аргументов для этой точки входа. Если образ не определяет точку входа, первый элемент в `args` используется в качестве точки входа, а остальные — как аргументы. | ||||
| dir строка | success | Рабочая директория, которая используется при запуске контейнера этого шага. Если это значение — относительный путь, оно относительно корня рабочей директории сборки. Если это абсолютный путь, он может лежать за пределами рабочей директории сборки, в таком случае содержимое пути может не сохраняться между выполнениями шагов сборки, если для этого пути не указан `volume`. Если сборка указывает `RepoSource` с `dir` и шаг с `dir`, который указывает абсолютный путь, `dir` `RepoSource` игнорируется для выполнения шага. | ||||
| entrypoint строка | success | Точка входа, которая используется вместо точки входа по умолчанию для образа шага сборки. Если не задано, используется точка входа по умолчанию образа. | ||||
| env список / элементы=строка | success | Список определений переменных окружения, которые будут использоваться при запуске шага. Элементы имеют вид "KEY=VALUE", где переменной "KEY" присваивается значение "VALUE". | ||||
| id строка | success | Уникальный идентификатор этого шага сборки, используемый в `wait_for` для ссылки на этот шаг сборки в качестве зависимости. | ||||
| name строка | success | Имя образа контейнера, который будет выполнять этот конкретный шаг сборки. Если образ доступен в кэше демона Docker хоста, он будет запущен напрямую. Если нет, хост попытается сначала извлечь образ, используя учетные данные службы сборки, если это необходимо. Кэш демона Docker уже содержит последние версии всех официально поддерживаемых шагов сборки (см. https://github.com/GoogleCloudPlatform/cloud-builders для образов и примеров). Дэмон Docker также кэширует многие слои для некоторых популярных образов, таких как "ubuntu", "debian", но они будут обновляться в момент попытки их использования. Если вы создали образ в предыдущем шаге сборки, он будет сохранён в кэше демона Docker хоста и доступен для использования в последующих шагах сборки. | ||||
| secretEnv список / элементы=строка | success | Список переменных окружения, которые шифруются с помощью ключа криптографии Cloud Key Management Service. Эти значения должны быть указаны в `Secret` сборки. | ||||
| timeout строка | success | Срок выполнения этого шага сборки. Если не определено, у шага нет ограничения по времени и ему разрешается продолжать выполнение до завершения или истечения срока действия сборки. | ||||
| timing строка | success | Только для вывода. Хранит информацию о времени выполнения этого шага сборки. | ||||
| volumes сложный | success | Список томов, которые следует смонтировать в шаг сборки. Каждый том создается как пустой том до выполнения шага сборки. После завершения сборки тома и их содержимое удаляются. Использование именованного тома только в одном шаге недопустимо, так как это указывает на запрос сборки с неправильной конфигурацией. | ||||
| name строка | success | Имя монтируемого тома. Имена томов должны быть уникальными для каждого шага сборки и должны быть допустимыми именами томов Docker. Каждый именованный том должен использоваться по крайней мере двумя шагами сборки. | ||||
| path строка | success | Путь, по которому монтируется том. Пути должны быть абсолютными и не должны конфликтовать с другими путями томов в том же шаге сборки или с определенными резервированными путями томов. | ||||
| waitFor list / elements=string | success | Идентификатор(ы) шага(ов), от которого зависит этот шаг сборки. Этот шаг сборки не начнется, пока все шаги сборки в `wait_for` не завершатся успешно. Если `wait_for` пусто, этот шаг сборки начнется, когда все предыдущие шаги сборки в списке `Build.Steps` завершатся успешно. | ||||
| substitutions dictionary | success | Данные подстановки для ресурса Build. | ||||
| tags list / elements=string | success | Теги для аннотации Build. Это не теги Docker. | ||||
| timeout string | success | Время, в секундах, в течение которого должна выполняться сборка. Если это время истечёт, работа над сборкой прекратится, и статус сборки будет TIMEOUT. Это время ожидания должно быть равно или больше суммы времени ожидания для шагов сборки в рамках сборки. Ожидаемый формат - количество секунд, за которым следует s. По умолчанию время составляет десять минут (600s). | ||||
| createTime string | success | Время создания триггера. | ||||
| description string | success | Описание триггера, понятное для человека. | ||||
| disabled boolean | success | Включён или выключен триггер. Если true, триггер никогда не приведёт к созданию сборки. | ||||
| filename string | success | Путь, от корневой директории источника, к файлу, содержимое которого используется для шаблона. Должен быть указан либо файл, либо шаблон сборки. | ||||
| github complex | success | Описание конфигурации триггера, который создаёт сборку всякий раз, когда получено событие GitHub. | ||||
| name string | success | Название репозитория. Например: Имя для https://github.com/googlecloudplatform/cloud-builders это "cloud-builders". | ||||
| owner string | success | Владелец репозитория. Например: Владелец для https://github.com/googlecloudplatform/cloud-builders это "googlecloudplatform". | ||||
| pullRequest complex | success | Фильтр для соответствия изменениям в запросах на вытягивание. Укажите только один из pullRequest или push. | ||||
| branch string | success | Регулярное выражение для соответствия ветвям. | ||||
| commentControl string | success | Блокировать сборки по комментарию "/gcbrun" от владельца репозитория или сотрудника. | ||||
| invertRegex boolean | success | Если true, ветви, которые НЕ соответствуют git_ref, будут запускать сборку. | ||||
| push complex | success | Фильтр для соответствия изменениям в refs, таких как ветви или теги. Укажите только один из pullRequest или push. | ||||
| branch string | success | Регулярное выражение для соответствия ветвям. Укажите только один из branch или tag. | ||||
| invertRegex boolean | success | Если true, сборка запускается только если регулярное выражение для ревизии НЕ совпадает с регулярным выражением git_ref. | ||||
| tag string | success | Регулярное выражение для соответствия тегам. Укажите только один из branch или tag. | ||||
| id string | success | Уникальный идентификатор триггера. | ||||
| ignoredFiles list / elements=string | success | ignoredFiles и includedFiles - соответствия шаблонам файлов с использованием https://golang.org/pkg/path/filepath/#Match, расширенные поддержкой `**`. Если ignoredFiles и изменённые файлы оба пусты, то они не используются для определения того, запускать ли сборку. Если ignoredFiles не пусто, то мы игнорируем любые файлы, которые соответствуют любому из шаблонов ignored_file. Если у изменения нет файлов, которые находятся за пределами шаблонов ignoredFiles, тогда мы не запускаем сборку. | ||||
| includedFiles list / elements=string | success | ignoredFiles и includedFiles - соответствия шаблонам файлов с использованием https://golang.org/pkg/path/filepath/#Match, расширенные поддержкой `**`. Если какие-либо из файлов, изменённых в коммите, проходят фильтр ignoredFiles и includedFiles пусто, тогда по отношению к этому фильтру мы должны запустить сборку. Если какие-либо из файлов, изменённых в коммите, проходят фильтр ignoredFiles и includedFiles не пусто, тогда мы убеждаемся, что по крайней мере один из этих файлов соответствует шаблону includedFiles. Если нет, то мы не запускаем сборку. | ||||
| name string | success | Имя триггера. Должно быть уникальным в рамках проекта. | ||||
| substitutions dictionary | success | Данные подстановки для ресурса Build. | ||||
| tags list / elements=string | success | Теги для аннотации BuildTrigger. | ||||
| triggerTemplate complex | success | Шаблон, описывающий типы изменений в источнике, которые запускают сборку. Имена ветвей и тегов в шаблонах триггеров интерпретируются как регулярные выражения. Любые изменения ветвей или тегов, которые соответствуют этому регулярному выражению, запустят сборку. | ||||
| branchName string | success | Имя ветви для сборки. Должен быть указан только один из имени ветки, тега или SHA коммита. Это поле - регулярное выражение. | ||||
| commitSha string | success | Явный SHA коммита для сборки. Должен быть указан только один из имени ветки, тега или SHA коммита. | ||||
| dir string | success | Директория, относительная к корневой директории источника, в которой нужно запустить сборку. Это должен быть относительный путь. Если для шага указан dir и это абсолютный путь, это значение игнорируется для выполнения этого шага. | ||||
| invertRegex boolean | success | Запустить сборку только если регулярное выражение ревизии НЕ соответствует регулярному выражению ревизии. | ||||
| projectId string | success | ID проекта, владеющего Cloud Source Repository. Если опущено, предполагается использование ID проекта, запрашивающего сборку. | ||||
| repoName string | success | Имя Cloud Source Repository. Если опущено, предполагается имя "default". | ||||
| tagName string | success | Имя тега для сборки. Должен быть указан только один из имени ветки, тега или SHA коммита. Это поле - регулярное выражение. | ||||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_cloudbuild_trigger_module.html
