google.cloud.gcp_pubsub_subscription_info – Сбор информации о подписке GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_pubsub_subscription_info.
Обзор
- Сбор информации о подписке GCP
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется данный модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется данный модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех API-запросов. | |
| project строка | Проект Google Cloud Platform, который следует использовать. | |
| scopes список / элементы=строка | Массив используемых областей доступа. | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, представленное в словаре или JSON-строке. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран параметр machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить 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: get info on a subscription
gcp_pubsub_subscription_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | |||
| ackDeadlineSeconds целое число | успешно | Это значение — максимальное время после получения сообщения подписчиком, перед тем, как подписчик должен подтвердить сообщение. После доставки сообщения, но до истечения срока подтверждения и до подтверждения сообщения, оно считается ожидающим и не будет повторно доставлено в течение этого времени (на основе принципа наилучших усилий). Для подписок на основе pull это значение используется в качестве начального значения срока подтверждения. Чтобы переопределить это значение для данного сообщения, вызовите subscriptions.modifyAckDeadline с соответствующим ackId, если используется pull. Минимальный настраиваемый срок — 10 секунд. Максимальный настраиваемый срок — 600 секунд (10 минут). Если этот параметр равен 0, используется значение по умолчанию — 10 секунд. Для доставки push это значение также используется для установки таймаута запроса для вызова push-точки. Если подписчик никогда не подтверждает сообщение, система Pub/Sub в конечном итоге повторно доставит его. | |||
| deadLetterPolicy complex | успешно | Политика, определяющая условия для отправки сообщений в мертвую почту в этой подписке. Если dead_letter_policy не задано, отправка в мертвую почту отключена. Учётная запись сервиса Google Cloud Pub/Sub, связанная с родительским проектом этой подписки (например, service-{номер_проекта}@gcp-sa-pubsub.iam.gserviceaccount.com), должна иметь разрешение Acknowledge() сообщений для этой подписки. | |||
| deadLetterTopic строка | успешно | Имя темы, в которую должны публиковаться сообщения мертвой почты. Формат: `projects/{project}/topics/{topic}`. Учётная запись сервиса Google Cloud Pub/Sub, связанная с родительским проектом содержащей подписки (например, service-{номер_проекта}@gcp-sa-pubsub.iam.gserviceaccount.com), должна иметь разрешение Publish() в эту тему. Операция завершится ошибкой, если тема не существует. Пользователи должны убедиться, что к этой теме прикреплена подписка, так как сообщения, опубликованные в теме без подписок, теряются. | |||
| maxDeliveryAttempts целое число | успешно | Максимальное количество попыток доставки любого сообщения. Значение должно быть между 5 и 100. Количество попыток доставки определяется как 1 + (сумма числа NACK и числа раз, когда истекал срок подтверждения сообщения). NACK — это любой вызов ModifyAckDeadline со сроком подтверждения 0. Обратите внимание, что клиентские библиотеки могут автоматически продлевать ack_deadlines. Этот параметр будет выполнен с наилучшими усилиями. Если этот параметр равен 0, используется значение по умолчанию — 5. | |||
| enableMessageOrdering логическое значение | успешно | Если `true`, сообщения, опубликованные с одинаковым orderingKey в PubsubMessage, будут доставлены подписчикам в порядке их получения системой Pub/Sub. В противном случае они могут быть доставлены в любом порядке. | |||
| expirationPolicy complex | успешно | Политика, определяющая условия истечения срока действия этой подписки. Подписка считается активной, пока любой подключенный подписчик успешно потребляет сообщения из подписки или выполняет операции с подпиской. Если expirationPolicy не задано, будет использоваться политика по умолчанию со сроком действия 31 день. Если она задана, но ttl пуста, ресурс никогда не истекает. Минимальное допустимое значение для expirationPolicy.ttl — 1 день. | |||
| ttl строка | успешно | Указывает продолжительность «срока жизни» для связанного ресурса. Ресурс истекает, если он не активен в течение указанного периода ttl. Если ttl не задано, связанный ресурс никогда не истекает. Продолжительность в секундах с точностью до девяти десятичных знаков, завершающаяся «s». Пример — «3,5s». | |||
| filter строка | успешно | Подписка доставляет только сообщения, которые соответствуют фильтру. Pub/Sub автоматически подтверждает сообщения, которые не соответствуют фильтру. Вы можете фильтровать сообщения по их атрибутам. Максимальная длина фильтра — 256 байт. После создания подписки вы не можете изменить фильтр. | |||
| labels словарь | успешно | Набор пар ключ/значение меток для назначения этой подписки. | |||
| messageRetentionDuration строка | успешно | Сколько времени сохранять неподтвержденные сообщения в очереди подписки с момента публикации сообщения. Если retainAckedMessages равно true, это также настраивает сохранение подтвержденных сообщений, и таким образом настраивает, насколько далеко в прошлое можно выполнить subscriptions.seek. По умолчанию 7 дней. Не может быть больше 7 дней («604800s») или меньше 10 минут («600s»). Продолжительность в секундах с точностью до девяти десятичных знаков, завершающаяся «s». Пример: «600,5s». | |||
| name строка | успешно | Имя подписки. | |||
| pushConfig complex | успешно | Если используется доставка push с этой подпиской, это поле используется для ее настройки. Пустая pushConfig означает, что подписчик будет получать и подтверждать сообщения с помощью методов API. | |||
| attributes словарь | успешно | Атрибуты конфигурации конечной точки. У каждой конечной точки есть набор поддерживаемых API атрибутов, которые могут использоваться для управления различными аспектами доставки сообщений. В настоящее время поддерживаемый атрибут — x-goog-version, который можно использовать для изменения формата отправляемого сообщения. Этот атрибут указывает версию данных, ожидаемых конечной точкой. Это управляет формой отправляемого сообщения (т. е. его полями и метаданными). Версия конечной точки основана на версии API Pub/Sub. Если он отсутствует при вызове subscriptions.create, он будет по умолчанию равен версии API, используемой для такого вызова. Если он отсутствует при вызове subscriptions.modifyPushConfig, его значение не будет изменено. Вызовы subscriptions.get всегда будут возвращать допустимую версию, даже если подписка была создана без этого атрибута. Возможные значения для этого атрибута: - v1beta1: использует формат push, определенный в API Pub/Sub v1beta1. - v1 или v1beta2: использует формат push, определенный в API Pub/Sub v1. | |||
| oidcToken complex | успешно | Если указано, Pub/Sub сгенерирует и прикрепит токен OIDC JWT в качестве заголовка Authorization в HTTP-запросе для каждого отправляемого сообщения. | |||
| audience строка | успешно | Аудитория, которая будет использоваться при генерации токена OIDC. Поле аудитории в токена JWT идентифицирует получателей, для которых предназначен JWT. Значение аудитории — строка, не чувствительная к регистру. Не поддерживается использование нескольких значений (массива) для поля audience. Более подробная информация о поле audience токена OIDC JWT здесь: https://tools.ietf.org/html/rfc7519#section-4.1.3 Примечание: если не указано, будет использоваться URL-адрес push-точки. | |||
| serviceAccountEmail строка | успешно | Электронный адрес учётной записи сервиса, который будет использоваться для генерации токена OIDC. Вызывающий (для RPC subscriptions.create, subscriptions.patch и subscriptions.modifyPushConfig) должен иметь разрешение iam.serviceAccounts.actAs для учётной записи сервиса. | |||
| pushEndpoint строка | успешно | URL-адрес, указывающий конечную точку, в которую должны отправляться сообщения. Например, веб-хук может использовать "https://example.com/push". | |||
| retainAckedMessages логическое значение | успешно | Указывает, нужно ли сохранять подтвержденные сообщения. Если `true`, сообщения не удаляются из очереди подписки, даже если они подтверждены, пока они не выйдут за рамки окна messageRetentionDuration. | |||
| retryPolicy complex | успешно | Политика, определяющая, как Pub/Sub повторяет доставку сообщений для этой подписки. Если не задано, применяется политика повторных попыток по умолчанию. Это обычно означает, что сообщения будут повторно передаваться как можно скорее для здоровых подписчиков. Политика повторных попыток будет активирована при событиях NACK или истечении срока подтверждения для данного сообщения. | |||
| maximumBackoff строка | успешно | Максимальная задержка между последовательными передачами данного сообщения. Значение должно быть между 0 и 600 секундами. По умолчанию 600 секунд. Продолжительность в секундах с точностью до девяти десятичных знаков, завершающаяся «s». Пример: «3,5s». | |||
| minimumBackoff строка | успешно | Минимальная задержка между последовательными передачами данного сообщения. Значение должно быть между 0 и 600 секундами. По умолчанию 10 секунд. Продолжительность в секундах с точностью до девяти десятичных знаков, завершающаяся «s». Пример: «3,5s». | |||
| тема словарь | успех | Ссылка на ресурс темы. | |||
Авторы
- 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_subscription_info_module.html
