google.cloud.gcp_compute_backend_bucket_info – Сбор информации о GCP BackendBucket
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_compute_backend_bucket_info.
Обзор
- Сбор информации о GCP BackendBucket
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это поле не нужно устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. | |
| filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 и filter2). | |
| 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. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a backend bucket
gcp_compute_backend_bucket_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| resources сложное | всегда | Список ресурсов | ||
| bucketName строка | успех | Имя хранилища Cloud Storage. | ||
| cdnPolicy сложное | успех | Настройка Cloud CDN для этого Backend Bucket. | ||
| signedUrlCacheMaxAgeSec целое число | успех | Максимальное количество секунд, в течение которых ответ на запрос к подписанной ссылке будет считаться свежим. По истечении этого периода ответ будет перепроверен перед выдачей. При обслуживании ответов на запросы к подписанным URL-адресам Cloud CDN будет внутренне вести себя так, как будто все ответы от этого бэкенда имели заголовок "Cache-Control: public, max-age=[TTL]", независимо от наличия существующего заголовка Cache-Control. Фактические заголовки, отображаемые в ответах, не будут изменены. | ||
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. | ||
| description строка | успех | Необязательное текстовое описание ресурса; предоставляется клиентом при создании ресурса. | ||
| enableCdn булево | успех | Если true, включить Cloud CDN для этого BackendBucket. | ||
| id целое число | успех | Уникальный идентификатор ресурса. | ||
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_backend_bucket_info_module.html