google.cloud.gcp_pubsub_topic – Создаёт тему GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач, укажите: google.cloud.gcp_pubsub_topic.
Обзор
- Именованный ресурс, в который издатели отправляют сообщения.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это меняет только строку User Agent для всех запросов API. | ||
| kms_key_name строка | Имя ресурса Cloud KMS CryptoKey, используемого для защиты доступа к сообщениям, опубликованным в этой теме. Учетная запись службы PubSub вашего проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) должна иметь `roles/cloudkms.cryptoKeyEncrypterDecrypter`, чтобы использовать эту функцию. Ожидаемый формат: `projects/*/locations/*/keyRings/*/cryptoKeys/*` . | ||
| labels словарь | Набор пар ключ/значение для назначения этой теме. | ||
| message_storage_policy словарь | Политика, ограничивающая набор регионов Google Cloud Platform, где могут храниться сообщения, опубликованные в этой теме. Если отсутствует, ограничения не действуют. | ||
| allowed_persistence_regions список / элементы=строка / обязательно | Список идентификаторов регионов GCP, в которых могут храниться сообщения, опубликованные в этой теме. Сообщения, опубликованные издателями, работающими в недопустимых регионах GCP (или за пределами GCP), будут направлены для хранения в одном из разрешённых регионов. Пустой список означает, что регионы не разрешены, и это некорректная конфигурация. | ||
| name строка / обязательно | Имя темы. | ||
| 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/pubsub/docs/reference/rest/v1/projects.topics
- Управление темами: https://cloud.google.com/pubsub/docs/admin#managing_topics
- для аутентификации можно установить 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 topic
google.cloud.gcp_pubsub_topic:
name: test-topic1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| kmsKeyName строка | успех | Имя ресурса Cloud KMS CryptoKey, используемого для защиты доступа к сообщениям, опубликованным в этой теме. Учетная запись службы PubSub вашего проекта (`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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_pubsub_topic_module.html
