Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_pubsub_topic – Создает тему GCP

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: google.cloud.gcp_pubsub_topic.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Именованный ресурс, в который издатели отправляют сообщения.

Требования

Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

string / required

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

env_type

string

Указывает, в какой среде Ansible вы запускаете этот модуль.

Это не должно устанавливаться, если вы не знаете, что делаете.

Это только изменяет строку User Agent для любых запросов API.

kms_key_name

string

Имя ресурса ключа шифрования Cloud KMS, который будет использоваться для защиты доступа к сообщениям, опубликованным в этой теме. Учетная запись службы PubSub вашего проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) должен иметь `roles/cloudkms.cryptoKeyEncrypterDecrypter` для использования этой функции.

Ожидаемый формат: `projects/*/locations/*/keyRings/*/cryptoKeys/*`.

labels

dictionary

Набор пар «ключ/значение» меток, которые нужно назначить этой теме.

message_storage_policy

dictionary

Политика, ограничивающая набор регионов Google Cloud Platform, где могут храниться сообщения, опубликованные в теме. Если отсутствует, то никаких ограничений не действует.

allowed_persistence_regions

list / elements=string / required

Список идентификаторов регионов GCP, где сообщения, опубликованные в теме, могут храниться. Сообщения, опубликованные издателями, работающими в недопустимых регионах GCP (или работающими за пределами GCP), будут направлены для хранения в один из допустимых регионов. Пустой список означает, что регионы не разрешены, и это неверная конфигурация.

name

string / required

Имя темы.

project

string

Проект Google Cloud Platform для использования.

schema_settings

dictionary

Параметры для проверки сообщений, опубликованных в соответствии со схемой.

encoding

string

Кодировка сообщений, проверяемых по схеме.

Некоторые допустимые варианты: «ENCODING_UNSPECIFIED», «JSON», «BINARY»

По умолчанию: "ENCODING_UNSPECIFIED"

schema

string / required

Имя схемы, в соответствии с которой должны проверяться опубликованные сообщения. Формат — projects/{project}/schemas/{schema}.

Значение этого поля будет _deleted-schema_, если схема была удалена.

scopes

list / elements=string

Массив областей, которые будут использоваться.

service_account_contents

jsonarg

Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, которая его представляет.

service_account_email

string

Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.

service_account_file

path

Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.

state

string

Должен ли данный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Примечания

Примечание

  • Ссылка на 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.
  • Для аутентификации можно установить access_token, используя переменную среды GCP_ACCESS_TOKEN.
  • Для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
  • Для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
  • Параметры 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, используемого для защиты доступа к сообщениям, опубликованным в этой теме. Учетной записи службы Pub/Sub вашего проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) необходимо предоставить роль `roles/cloudkms.cryptoKeyEncrypterDecrypter` для использования этой функции.

Ожидаемый формат: `projects/*/locations/*/keyRings/*/cryptoKeys/*` .

Возвращаемое значение: успех

метки

словарь

Набор пар ключ/значение меток для назначения этой теме.

Возвращаемое значение: успех

messageStoragePolicy

сложный

Политика, ограничивающая набор регионов Google Cloud Platform, в которых могут храниться сообщения, опубликованные в теме. Если отсутствует, ограничений нет.

Возвращаемое значение: успех

allowedPersistenceRegions

список / элементы=строка

Список идентификаторов регионов GCP, где сообщения, опубликованные в теме, могут храниться в хранилище. Сообщения, опубликованные издателями, работающими в недопустимых регионах GCP (или за пределами GCP), будут маршрутизированы для хранения в одном из разрешенных регионов. Пустой список означает, что регионы не разрешены, и это не допустимая конфигурация.

Возвращаемое значение: успех

имя

строка

Имя темы.

Возвращаемое значение: успех

schemaSettings

сложный

Настройки для проверки сообщений, опубликованных по схеме.

Возвращаемое значение: успех

кодирование

строка

Кодирование сообщений, проверяемых по схеме.

Возвращаемое значение: успех

схема

строка

Имя схемы, по которой должны проверяться опубликованные сообщения. Формат проектов/{project}/schemas/{схема}.

Значение этого поля будет _deleted-schema_, если схема была удалена.

Возвращаемое значение: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекции

  • Отслеживание ошибок
  • Главная страница
  • Репозиторий (источники)

© 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_pubsub_topic_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API