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 | Проект Google Cloud Platform, который нужно использовать. | ||
| push_config | Если для этой подписки используется доставка push, это поле используется для ее настройки. Пустой pushConfig означает, что подписчик будет получать и подтверждать сообщения с использованием методов API. | ||
| push_endpoint | URL, указывающий на точку, в которую должны отправляться сообщения. Например, точка Webhook может использовать "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 }}"
scopes:
- https://www.googleapis.com/auth/pubsub
state: present
register: topic
- name: create a subscription
gcp_pubsub_subscription:
name: testObject
topic: "{{ topic }}"
push_config:
push_endpoint: 'https://myapp.graphite.cloudnativeapp.com/webhook/sub1'
ack_deadline_seconds: 300
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/pubsub
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| ack_deadline_seconds int | success | Это максимальное время после получения сообщения подписчиком, до которого подписчик должен подтвердить получение сообщения. После доставки сообщения, но до истечения срока подтверждения и до подтверждения сообщения, оно является ожидающим и не будет повторно доставлено в течение этого времени (с максимальной эффективностью). Для подписок pull это значение используется в качестве начального значения срока подтверждения. Чтобы переопределить это значение для конкретного сообщения, вызовите subscriptions.modifyAckDeadline с соответствующим ackId, если используется pull. Минимальный настраиваемый срок составляет 10 секунд. Максимальный настраиваемый срок составляет 600 секунд (10 минут). Если этот параметр равен 0, используется значение по умолчанию 10 секунд. Для доставки push это значение также используется для установки таймаута запроса для вызова на push-точку. Если подписчик никогда не подтверждает получение сообщения, система Pub/Sub в конечном итоге повторно отправит сообщение. | |
| name str | success | Имя подписки. | |
| push_config complex | success | Если для этой подписки используется доставка push, это поле используется для ее настройки. Пустой pushConfig означает, что подписчик будет получать и подтверждать сообщения с использованием методов API. | |
| push_endpoint str | success | URL, указывающий на точку, в которую должны отправляться сообщения. Например, точка Webhook может использовать "https://example.com/push".
| |
| topic dict | success | Ссылка на ресурс топика. | |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Для получения дополнительной информации см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/gcp_pubsub_subscription_module.html
