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