google.cloud.gcp_cloudbuild_trigger – Создаёт триггер GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в playbook укажите: 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 словарь | Подстановки для использования в триггерной сборке. Должны использоваться только с триггерами triggers.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 список / элементы=строка | Список аргументов, которые будут переданы шагу при его запуске. Если для выполнения шага используется образ с заданным entrypoint, args используются как аргументы для этого entrypoint. Если у образа нет entrypoint, то первый элемент в args используется в качестве entrypoint, а остальные — как аргументы. | ||||
| dir строка | Рабочая директория, используемая при запуске контейнера для этого шага. Если это относительный путь, то он относит к рабочей директории сборки. Если это абсолютный путь, он может находиться вне рабочей директории сборки, в этом случае содержимое пути может не сохраняться между выполнениями шагов сборки, если для этого пути не указан `volume`. Если сборка указывает `RepoSource` с `dir` и шаг с `dir`, который указывает абсолютный путь, то `RepoSource` `dir` игнорируется при выполнении шага. | ||||
| entrypoint строка | 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. Эти значения должны быть указаны в `Secret` сборки. | ||||
| timeout строка | Предельное время выполнения этого шага сборки. Если не определено, для шага нет ограничения по времени, и он будет продолжать выполняться, пока не завершит работу или пока сама сборка не истечёт по времени. | ||||
| timing строка | Только для вывода. Содержит информацию о времени выполнения этого шага сборки. | ||||
| volumes список / элементы=словарь | Список томов, которые необходимо смонтировать в шаг сборки. Каждый том создаётся как пустой том перед выполнением шага сборки. После завершения сборки тома и их содержимое удаляются. Использование именованного тома только в одном шаге является недопустимым, так как это указывает на запрос сборки с неправильной конфигурацией. | ||||
| name строка / обязательно | Имя тома для монтирования. Имена томов должны быть уникальными для каждого шага сборки и должны быть валидными именами для Docker томов. Каждый именованный том должен использоваться как минимум двумя шагами сборки. | ||||
| path строка / обязательно | Путь для монтирования тома. Пути должны быть абсолютными и не должны конфликтовать с другими путями томов в том же шаге сборки или с определёнными зарезервированными путями томов. | ||||
| wait_for список / элементы=строка | Идентификатор(ы) шага(ов), от которого зависит этот шаг сборки. Этот шаг сборки не начнется, пока все шаги сборки в `wait_for` не завершатся успешно. Если `wait_for` пустой, этот шаг сборки начнётся, когда завершатся все предыдущие шаги сборки в списке `Build.Steps`. | ||||
| substitutions словарь | Данные подстановок для ресурса Build. | ||||
| tags список / элементы=строка | Теги для аннотации Build. Это не теги Docker. | ||||
| timeout string | Значение по умолчанию: "600s" | Время, в секундах, которое должно быть выделено для выполнения данного сборки. Если это время истечёт, работа над сборкой будет прекращена, и статус сборки будет TIMEOUT. Данный таймаут должен быть равен или больше суммы таймаутов для шагов сборки в рамках данной сборки. Ожидаемый формат — количество секунд, за которым следует s. По умолчанию время составляет десять минут (600s). | |||
| description string | Описание триггера, понятное для человека. | ||||
| disabled boolean |
| Отключён ли триггер. Если true, триггер никогда не приведёт к запуску сборки. | |||
| env_type string | Указывает, в какой среде Ansible выполняется данный модуль. Это поле следует устанавливать только в том случае, если вы это знаете. Это изменяет только строку User Agent для всех запросов API. | ||||
| filename string | Путь к файлу, начиная с корня источника, содержащему шаблон. Необходимо указать либо имя файла, либо шаблон сборки. | ||||
| 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 | Директория, относительная к корню источника, в которой будет выполняться сборка. Это должен быть относительный путь. Если для шага указан абсолютный путь в dir, это значение будет проигнорировано для выполнения этого шага. | ||||
| invert_regex boolean |
| Запускать сборку только в том случае, если регулярное выражение для ревизии НЕ соответствует регулярному выражению ревизии. | |||
| project_id string | ID проекта, владеющего Cloud Source Repository. Если опущено, используется ID проекта, запрашивающего сборку. | ||||
| repo_name string | Значение по умолчанию: "default" | Имя Cloud Source Repository. Если опущено, используется имя "default". | |||
| tag_name string | Имя тега для сборки. Должно быть указано ровно одно из значений: имя ветви, имя тега или SHA коммита. Это поле является регулярным выражением. | ||||
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/cloud-build/docs/api/reference/rest/
- Автоматизация сборок с помощью триггеров сборок: 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. - Значения переменных среды будут использоваться только в том случае, если значения в данном плейбуке не заданы.
- Параметры 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 | 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 dictionary | success | Карта имени переменной среды к её зашифрованному значению. Секретные переменные среды должны быть уникальными в рамках всех секретов сборки и должны использоваться как минимум одним этапом сборки. Значения могут быть не более 64 КБ в размере. Максимальное количество секретных значений во всех секретах сборки может составлять 100. | ||||
| source complex | success | Расположение исходных файлов для сборки. | ||||
| repoSource complex | success | Расположение исходного кода в репозитории Google Cloud Source. | ||||
| branchName string | success | Регулярное выражение, сопоставляющее ветки для сборки. Должно быть указано ровно одно из имени ветки, тега или SHA коммита. Синтаксис поддерживаемых регулярных выражений соответствует синтаксису RE2, описанному по адресу https://github.com/google/re2/wiki/Syntax . | ||||
| commitSha string | success | Явный SHA коммита для сборки. Должно быть указано ровно одно из имени ветки, тега или SHA коммита. | ||||
| dir string | success | Директория, относительная к корню исходного кода, в которой следует выполнить сборку. Это должен быть относительный путь. Если для шага задан параметр dir и это абсолютный путь, это значение игнорируется для выполнения этого шага. | ||||
| invertRegex boolean | success | Запускать сборку только в том случае, если регулярное выражение для ревизии НЕ совпадает с регулярным выражением для ревизии. | ||||
| projectId string | success | Идентификатор проекта, владеющего репозиторием Cloud Source. Если опущено, используется идентификатор проекта, запрашивающего сборку. | ||||
| repoName string | success | Имя репозитория Cloud Source. | ||||
| substitutions dictionary | success | Замены для использования в сборке по триггеру. Должно использоваться только с `triggers.run`. | ||||
| tagName string | success | Регулярное выражение, сопоставляющее теги для сборки. Должно быть указано ровно одно из имени ветки, тега или SHA коммита. Синтаксис поддерживаемых регулярных выражений соответствует синтаксису RE2, описанному по адресу https://github.com/google/re2/wiki/Syntax . | ||||
| storageSource complex | success | Расположение исходного кода в архиве в Google Cloud Storage. | ||||
| bucket string | success | Ведро Google Cloud Storage, содержащее исходный код. | ||||
| generation string | success | Генерирование Google Cloud Storage для объекта. Если генерирование опущено, будет использоваться последняя генерация. | ||||
| object string | success | Объект Google Cloud Storage, содержащий исходный код. Этот объект должен быть сжатым архивным файлом (.tar.gz), содержащим исходный код для сборки. | ||||
| steps complex | success | Операции, которые должны быть выполнены в рабочей области. | ||||
| args list / elements=string | success | Список аргументов, которые будут переданы шагу при его запуске. Если для запуска контейнера шага используется точка входа изображения, аргументы используются как аргументы для этой точки входа. Если изображение не определяет точку входа, первый элемент в аргументах используется как точка входа, а остальные — как аргументы. | ||||
| dir string | success | Рабочая директория, используемая при запуске контейнера этого шага. Если это значение является относительным путем, оно относительно рабочей директории сборки. Если это значение является абсолютным, оно может находиться вне рабочей директории сборки, в этом случае содержимое пути может не сохраняться между запусками этапов сборки, если для этого пути не указан `volume`. Если сборка указывает `RepoSource` с `dir` и шаг с `dir`, который указывает абсолютный путь, `dir` `RepoSource` игнорируется для выполнения шага. | ||||
| entrypoint string | success | Точка входа, которая должна использоваться вместо стандартной точки входа изображения этапа сборки. Если не задано, используется стандартная точка входа изображения. | ||||
| env list / elements=string | success | Список определений переменных среды, которые должны использоваться при выполнении шага. Элементы имеют вид "KEY=VALUE" для присвоения переменной среды "KEY" значения "VALUE". | ||||
| id string | success | Уникальный идентификатор для этого этапа сборки, используемый в `wait_for` для ссылки на этот этап сборки как на зависимость. | ||||
| name string | success | Имя контейнерного образа, который будет выполнять этот конкретный этап сборки. Если изображение доступно в кэше демона Docker хоста, оно будет запущено непосредственно. В противном случае хост сначала попытается скачать изображение, используя учетные данные сервисного аккаунта билдера при необходимости. В кэше демона Docker уже будут самые последние версии всех официально поддерживаемых этапов сборки (https://github.com/GoogleCloudPlatform/cloud-builders). Демн Docker также кэширует многие слои для некоторых популярных образов, таких как "ubuntu", "debian", но они будут обновляться при попытке их использования. Если вы создали изображение на предыдущем этапе сборки, оно будет храниться в кэше демона Docker хоста и доступно для использования на последующих этапах сборки. | ||||
| secretEnv list / elements=string | success | Список переменных среды, которые зашифрованы с помощью криптоключа Cloud Key Management Service. Эти значения должны быть указаны в `Secret` сборки. | ||||
| timeout string | success | Срок выполнения этого этапа сборки. Если не определен, шаг не имеет временного ограничения и будет выполняться до завершения или выхода из строя самой сборки. | ||||
| timing string | success | Только для вывода. Хранит информацию о времени выполнения этого этапа сборки. | ||||
| volumes complex | success | Список томов для монтирования в этап сборки. Каждый том создаётся как пустой том перед запуском этапа сборки. После завершения сборки тома и их содержимое удаляются. Использование именованного тома только в одном шаге недопустимо, так как это указывает на запрос сборки с неправильной конфигурацией. | ||||
| name string | success | Имя монтируемого тома. Имена томов должны быть уникальными для каждого этапа сборки и должны быть допустимыми именами для томов Docker. Каждый именованный том должен использоваться как минимум двумя этапами сборки. | ||||
| path string | success | Путь для монтирования тома. Пути должны быть абсолютными и не должны конфликтовать с другими путями томов на том же этапе сборки или с определенными резервированными путями томов. | ||||
| waitFor list / elements=string | success | Идентификатор(ы) шага(ов), от которого зависит этот шаг сборки. Этот шаг сборки не начнется, пока все шаги сборки в списке `wait_for` не будут выполнены успешно. Если `wait_for` пустой, этот шаг сборки начнется, когда все предыдущие шаги сборки в списке `Build.Steps` будут выполнены успешно. | ||||
| substitutions dictionary | success | Данные подстановок для ресурса Build. | ||||
| tags list / elements=string | success | Теги для аннотации сборки. Это не теги Docker. | ||||
| timeout string | success | Время, в секундах, которое должно быть разрешено для выполнения этой сборки. Если это время истечёт, работа над сборкой прекратится, и статус сборки будет TIMEOUT. Это время ожидания должно быть равно или больше суммы времени ожидания для шагов сборки в рамках сборки. Ожидаемый формат — количество секунд, после которого следует s. Значение по умолчанию — десять минут (600s). | ||||
| createTime string | success | Время создания триггера. | ||||
| description string | success | Описание триггера, понятное пользователю. | ||||
| disabled boolean | success | Отключен ли триггер. Если true, триггер никогда не приведёт к сборке. | ||||
| filename string | success | Путь к файлу от корня исходного кода, содержимое которого используется для шаблона. Должен быть указан либо файл, либо шаблон сборки. | ||||
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_cloudbuild_trigger_module.html
