google.cloud.gcp_sourcerepo_repository – Создаёт репозиторий GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_sourcerepo_repository.
Обзор
- Репозиторий (или repo) — это Git-репозиторий, хранящий версионированное содержимое исходного кода.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API. | |
| name строка / обязательно | Имя ресурса репозитория в формате projects/{{project}}/repos/{{repo}}. Имя репозитория может содержать косые черты. Например, projects/myproject/repos/name/with/slash . | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список / элементы=строка | Массив используемых областей | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи сервиса, либо в виде словаря, либо как строка JSON, которая его представляет. | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. | |
| state строка |
| Требуется ли существование данного объекта в GCP |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/source-repositories/docs/reference/rest/v1/projects.repos
- Официальная документация: https://cloud.google.com/source-repositories/
- для аутентификации можно установить 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 взаимоисключающие.
Примеры
- name: create a repository
google.cloud.gcp_sourcerepo_repository:
name: test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, а следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| name строка | success | Имя ресурса репозитория в формате projects/{{project}}/repos/{{repo}}. Имя репозитория может содержать косые черты. Например, projects/myproject/repos/name/with/slash . |
| size целое число | success | Использование дискового пространства репозитория в байтах. |
| url строка | success | Ссылка для клонирования репозитория из Google Cloud Source Repositories. |
Авторы
- 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_sourcerepo_repository_module.html
