gcp_cloudbuild_trigger_info – Сбор информации о триггере GCP
Новая версия 2.8.
Описание
- Сбор информации о триггере GCP
- Этот модуль назывался
gcp_cloudbuild_trigger_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_cloudbuild_trigger_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это лишь изменяет строку User Agent для всех API-запросов. | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(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 взаимоисключающие.
Примеры
- name: get info on a trigger
gcp_cloudbuild_trigger_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Значения возврата
Общие значения возврата описаны в документации. Ниже приведены поля, уникальные для этого модуля:
| Ключевые значения | Возвращаемое значение | Описание | ||||
|---|---|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | ||||
| build complex | успех | Содержимое шаблона сборки. Должно быть указано либо имя файла, либо шаблон сборки. | ||||
| images list | успех | Список изображений, которые будут загружены после успешного выполнения всех шагов сборки. Изображения загружаются с использованием учетных данных сервисного аккаунта билдера. Хэши загруженных изображений будут сохранены в поле результата ресурса Сборки. Если любое из изображений не удалось загрузить, статус сборки устанавливается в СООБЩЕНИЕ О НЕУДАЧЕ. | ||||
| steps complex | успех | Операции, которые необходимо выполнить в рабочей области. | ||||
| args list | успех | Список аргументов, которые будут переданы шагу при его запуске. Если у изображения, используемого для запуска контейнера шага, есть точка входа, args используются как аргументы к этой точке входа. Если изображение не определяет точку входа, первый элемент в args используется в качестве точки входа, а остальные – как аргументы. | ||||
| dir string | успех | Рабочий каталог, который необходимо использовать при запуске контейнера этого шага. Если это относительный путь, он относит к рабочему каталогу сборки. Если это абсолютный путь, он может находиться вне рабочего каталога сборки, в этом случае содержимое пути может не сохраняться между запусками шагов сборки, если не указан `volume` для этого пути. Если сборка определяет `RepoSource` с `dir`, а шаг с `dir`, который определяет абсолютный путь, `RepoSource` `dir` игнорируется для выполнения шага. | ||||
| entrypoint string | успех | Точка входа, которая будет использоваться вместо значения по умолчанию для изображения шага сборки. Если не установлено, используется значение по умолчанию для изображения. | ||||
| env list | успех | Список определений переменных окружения, которые необходимо использовать при выполнении шага. Элементы имеют вид "KEY=VALUE", где переменной "KEY" присваивается значение "VALUE". | ||||
| id string | успех | Уникальный идентификатор для этого шага сборки, используемый в `wait_for` для ссылки на этот шаг сборки в качестве зависимости. | ||||
| name string | успех | Имя контейнерного изображения, которое будет запускать этот конкретный шаг сборки. Если изображение доступно в кэше демона Docker хоста, оно будет запущено напрямую. В противном случае хост попытается загрузить изображение в первую очередь, используя учетные данные сервисного аккаунта билдера при необходимости. В кэше демона Docker уже есть самые последние версии всех официально поддерживаемых шагов сборки (https://github.com/GoogleCloudPlatform/cloud-builders). Демон Docker также кэширует многие слои для некоторых популярных изображений, таких как "ubuntu", "debian", но они будут обновлены в момент попытки их использования. Если вы создали изображение на предыдущем шаге сборки, оно будет сохранено в кэше демона Docker хоста и доступно для использования на последующем шаге сборки. | ||||
| secretEnv list | успех | Список переменных окружения, которые зашифрованы с помощью криптоключа сервиса управления ключами Cloud. | ||||
| timeout string | успех | Срок выполнения для выполнения этого шага сборки. Если не определен, шаг не имеет ограничения по времени и будет выполняться до завершения или истечения срока действия сборки. | ||||
| timing string | успех | Только для вывода. Содержит сведения о времени выполнения этого шага сборки. | ||||
| volumes complex | успех | Список томов для монтирования в шаг сборки. Каждый том создается как пустой том перед выполнением шага сборки. По завершении сборки тома и их содержимое удаляются. Использование именованного тома только в одном шаге не является допустимым, так как это указывает на запрос сборки с неправильной конфигурацией. | ||||
| name string | успех | Имя монтируемого тома. Имена томов должны быть уникальными для каждого шага сборки и должны быть допустимыми именами томов Docker. Каждый именованный том должен использоваться как минимум двумя шагами сборки. | ||||
| path string | успех | Путь, по которому следует смонтировать том. Пути должны быть абсолютными и не могут конфликтовать с другими путями томов в том же шаге сборки или с определенными резервированными путями томов. | ||||
| waitFor list | успех | Идентификатор(ы) шага(ов), от которых зависит этот шаг сборки. Этот шаг сборки не будет запущен, пока все шаги сборки в `wait_for` не будут успешно выполнены. Если `wait_for` пустой, этот шаг сборки начнется после успешного завершения всех предыдущих шагов сборки в списке `Build.Steps`. | ||||
| tags list | успех | Теги для аннотаций Сборки. Это не теги Docker. | ||||
| createTime string | успех | Время создания триггера. | ||||
| description string | успех | Описание триггера, понятное для человека. | ||||
| disabled boolean | успех | Триггер отключен или нет. Если значение true, триггер никогда не приведет к сборке. | ||||
| filename string | успех | Путь к файлу (от корня исходного кода), содержимое которого используется для шаблона. Должно быть указано либо имя файла, либо шаблон сборки. | ||||
| id string | успех | Уникальный идентификатор триггера. | ||||
| ignoredFiles list | успех | ignoredFiles и includedFiles – это совпадения шаблонов файлов, использующие http://godoc/pkg/path/filepath#Match с расширением поддержки `**`. Если ignoredFiles и измененные файлы пустые, то они не используются для определения того, нужно ли запускать сборку. Если ignoredFiles не пустой, то любые файлы, которые соответствуют любому из шаблонов ignored_file, игнорируются. Если изменения не содержат файлов, которые не попадают под шаблоны ignoredFiles, сборка не запускается. | ||||
| includedFiles список | success | ignoredFiles и includedFiles — это соответствия шаблонам имен файлов, использующие http://godoc/pkg/path/filepath#Match, расширенные поддержкой `**`. Если какие-либо из изменённых файлов в коммите проходят фильтр ignoredFiles, а includedFiles пустой, то по этому фильтру мы должны запустить сборку. Если какие-либо из изменённых файлов в коммите проходят фильтр ignoredFiles, а includedFiles не пустой, то мы проверяем, что хотя бы один из этих файлов соответствует одному из шаблонов includedFiles. Если нет, сборка не запускается. | ||||
| substitutions словарь | success | Данные подстановки для ресурса Build. | ||||
| triggerTemplate сложный | success | Шаблон, описывающий типы изменений исходного кода для запуска сборки. Имена ветвей и тегов в шаблонах триггеров интерпретируются как регулярные выражения. Любое изменение ветви или тега, соответствующее этому регулярному выражению, вызовет запуск сборки. | ||||
| branchName строка | success | Имя ветви для сборки. Необходимо указать ровно одно из имени ветви, тега или SHA коммита. | ||||
| commitSha строка | success | Явное значение SHA коммита для сборки. Необходимо указать ровно одно из имени ветви, тега или SHA коммита. | ||||
| dir строка | success | Директория, относительно корня исходного кода, в которой нужно запустить сборку. Это должен быть относительный путь. Если для шага указан dir, являющийся абсолютным путем, это значение игнорируется для выполнения этого шага. | ||||
| projectId строка | success | ID проекта, которому принадлежит Cloud Source Repository. Если опущено, используется ID проекта, запрашивающего сборку. | ||||
| repoName строка | success | Имя Cloud Source Repository. Если опущено, используется имя "default". | ||||
| tagName строка | success | Имя тега для сборки. Необходимо указать ровно одно из имени ветви, тега или SHA коммита. | ||||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/gcp_cloudbuild_trigger_info_module.html
