Модуль google.cloud.gcp_sourcerepo_repository_info — Сбор информации о репозитории 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_info.
Описание
- Сбор информации о репозитории GCP
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип аутентификации accesstoken. |
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 с помощью переменной окружения
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: get info on a repository
gcp_sourcerepo_repository_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources сложное | Список ресурсов Возвращается: всегда |
|
name строка |
Имя ресурса репозитория в формате projects/{{project}}/repos/{{repo}}. Имя репозитория может содержать косые черты. Например, projects/myproject/repos/name/with/slash . Возвращается: успешно |
|
size целое число |
Занятое место репозитория в байтах. Возвращается: успешно |
|
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_info_module.html