Модуль google.cloud.gcp_sourcerepo_repository – Создает репозиторий GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, подробности см. в разделе Требования.
Для использования в playbook, укажите: google.cloud.gcp_sourcerepo_repository.
Краткое описание
- Репозиторий (или репо) — это репозиторий Git, хранящий версионируемый исходный код.
Требования
Указанные ниже требования необходимы на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / required | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API. |
name string / required | Имя ресурса репозитория в формате projects/{{project}}/repos/{{repo}}. Имя репозитория может содержать слеши. Например, projects/myproject/repos/name/with/slash. |
project string | Используемый проект Google Cloud Platform. |
scopes list / elements=string | Массив используемых областей |
service_account_contents jsonarg | Содержимое файла Service Account JSON, либо в виде словаря, либо в виде представляющей его JSON-строки. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к файлу Service Account JSON, если в качестве типа выбран serviceaccount. |
state string | Должен ли данный объект существовать в GCP Варианты:
|
Примечания
Примечание
- API Reference: 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. - Для аутентификации можно установить access_token с помощью переменной окружения
GCP_ACCESS_TOKEN. - Для аутентификации можно установить auth_kind с помощью переменной окружения
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной окружения
GCP_SCOPES. - Значения переменных окружения будут использоваться только в том случае, если значения playbook не установлены.
- Параметры 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 string | Имя ресурса репозитория в формате projects/{{project}}/repos/{{repo}}. Имя репозитория может содержать слеши. Например, projects/myproject/repos/name/with/slash. Возвращается: успех |
size integer | Использование дискового пространства репозитория в байтах. Возвращается: успех |
url string | URL для клонирования репозитория из Google Cloud Source Repositories. Возвращается: успех |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_sourcerepo_repository_module.html
