gcp_pubsub_subscription – Создаёт GCP Подписку
Новое в версии 2.6.
Описание
- Именованный ресурс, представляющий собой поток сообщений из одного определенного топика, который будет доставляться подписывающемуся приложению.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ack_deadline_seconds - | Это максимальное время после получения сообщения подписчиком, прежде чем подписчик должен подтвердить его. После доставки сообщения, но до истечения срока подтверждения и до подтверждения сообщения, оно является ожидающим и не будет повторно доставлено в течение этого времени (на основе наилучшего усилия). Для подписок pull это значение используется как начальное значение для срока подтверждения. Чтобы переопределить это значение для данного сообщения, вызовите subscriptions.modifyAckDeadline с соответствующим ackId, если используется pull. Минимальный настраиваемый срок составляет 10 секунд. Максимальный настраиваемый срок составляет 600 секунд (10 минут). Если этот параметр равен 0, используется значение по умолчанию 10 секунд. Для доставки push это значение также используется для установки тайм-аута запроса для вызова push-точки входа. Если подписчик никогда не подтверждает сообщение, система Pub/Sub в конечном итоге повторно доставит его. | ||
| auth_kind - / обязательно |
| Тип используемых учетных данных. | |
| name - | Имя подписки. | ||
| project - | По умолчанию: null | Проект Google Cloud Platform, который будет использоваться. | |
| push_config - | Если для этой подписки используется доставка push, это поле используется для её настройки. Пустой pushConfig означает, что подписчик будет получать и подтверждать сообщения с использованием API-методов. | ||
| push_endpoint - | URL, указывающий на точку входа, в которую должны отправляться сообщения. Например, веб-хук-точка входа может использовать "https://example.com/push".
| ||
| scopes - | Массив используемых областей. | ||
| service_account_email - | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file - | Путь к файлу JSON учетной записи службы, если тип выбран как serviceaccount. | ||
| state - |
| Указывает, должен ли данный объект существовать в GCP | |
| topic - | Ссылка на ресурс топика. | ||
Примечания
Примечание
- Для аутентификации вы можете установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации вы можете установить 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
gcp_pubsub_topic:
name: "topic-subscription"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: topic
- name: create a subscription
gcp_pubsub_subscription:
name: "test_object"
topic: "{{ topic }}"
push_config:
push_endpoint: https://myapp.graphite.cloudnativeapp.com/webhook/sub1
ack_deadline_seconds: 300
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| ack_deadline_seconds целое число | успех | Это максимальное время после получения сообщения подписчиком, прежде чем подписчик должен подтвердить его. После доставки сообщения, но до истечения срока подтверждения и до подтверждения сообщения, оно является ожидающим и не будет повторно доставлено в течение этого времени (на основе наилучшего усилия). Для подписок pull это значение используется как начальное значение для срока подтверждения. Чтобы переопределить это значение для данного сообщения, вызовите subscriptions.modifyAckDeadline с соответствующим ackId, если используется pull. Минимальный настраиваемый срок составляет 10 секунд. Максимальный настраиваемый срок составляет 600 секунд (10 минут). Если этот параметр равен 0, используется значение по умолчанию 10 секунд. Для доставки push это значение также используется для установки тайм-аута запроса для вызова push-точки входа. Если подписчик никогда не подтверждает сообщение, система Pub/Sub в конечном итоге повторно доставит его. | |
| name строка | успех | Имя подписки. | |
| push_config сложное | успех | Если для этой подписки используется доставка push, это поле используется для её настройки. Пустой pushConfig означает, что подписчик будет получать и подтверждать сообщения с использованием API-методов. | |
| push_endpoint строка | успех | URL, указывающий на точку входа, в которую должны отправляться сообщения. Например, веб-хук-точка входа может использовать "https://example.com/push".
| |
| topic словарь | успех | Ссылка на ресурс топика. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/gcp_pubsub_subscription_module.html
