gcp_pubsub_topic – Создаёт GCP Тему
Новая версия с 2.6.
Синопсис
- Именованный ресурс, в который издатели отправляют сообщения.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
auth_kind
строка / обязательно
|
|
Тип используемых учетных данных.
|
|
labels
-
добавлен в 2.8
|
Набор пар ключ/значение меток, которые необходимо присвоить этой теме.
|
|
|
name
- / обязательно
|
Имя темы.
|
|
|
project
строка
|
Проект Google Cloud Platform, который необходимо использовать.
|
|
|
scopes
список
|
Массив используемых областей.
|
|
|
service_account_contents
строка
|
Строка, представляющая содержимое файла JSON учетной записи службы.
Этот параметр не должен передаваться в виде словаря, а в виде строки, содержащей точное содержимое файла json учетной записи службы (валидный JSON).
|
|
|
service_account_email
строка
|
Дополнительный адрес электронной почты учетной записи службы, если выбран параметр machineaccount и пользователь не хочет использовать адрес по умолчанию.
|
|
|
service_account_file
путь
|
Путь к файлу JSON учетной записи службы, если в качестве типа выбрана учетная запись службы.
|
|
|
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_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключают друг друга.
Примеры
- name: create a topic
gcp_pubsub_topic:
name: test-topic1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращено | Описание |
|---|---|---|
|
labels
словарь
|
success |
Набор пар ключ/значение меток, которые необходимо присвоить этой теме.
|
|
name
строка
|
success |
Имя темы.
|
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/gcp_pubsub_topic_module.html
