google.cloud.gcp_pubsub_topic_info – Сбор информации о теме GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.1).
Для установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_pubsub_topic_info.
Описание
- Сбор информации о теме GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
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. - для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использованы только в том случае, если значения в книге задач не заданы.
- Параметры service_account_email и service_account_file являются взаимоисключающими.
Примеры
- name: get info on a topic
gcp_pubsub_topic_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
|
resources
сложный
|
всегда |
Список ресурсов
|
||
|
kmsKeyName
строка
|
успех |
Имя ресурса Cloud KMS CryptoKey, используемого для защиты доступа к публикуемым сообщениям в этой теме. Учетная запись сервиса проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) должна обладать ролью `roles/cloudkms.cryptoKeyEncrypterDecrypter`, чтобы использовать эту функцию.
Ожидаемый формат: `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
|
||
|
labels
словарь
|
успех |
Набор пар ключ/значение меток, которые нужно назначить этой теме.
|
||
|
messageStoragePolicy
сложный
|
успех |
Политика, ограничивающая набор регионов Google Cloud Platform, в которых могут храниться сообщения, опубликованные в теме. Если не указано, никаких ограничений не существует.
|
||
|
allowedPersistenceRegions
список / элементы=строка
|
успех |
Список идентификаторов регионов GCP, в которых сообщения, опубликованные в теме, могут храниться в хранилище. Сообщения, опубликованные издателями, работающими в недопустимых регионах GCP (или работающими вне GCP), будут перенаправлены для хранения в одном из разрешенных регионов. Пустой список означает, что регионы не разрешены, и такая конфигурация недействительна.
|
||
|
name
строка
|
успех |
Имя темы.
|
||
Авторы
- 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_pubsub_topic_info_module.html
