Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_cloudtasks_queue — создание очереди GCP

Примечание

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

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

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

Чтобы использовать модуль в playbook, укажите: google.cloud.gcp_cloudtasks_queue.

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

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

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

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

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

Параметры

Параметр

Комментарии

access_token

string

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

app_engine_routing_override

dictionary

Переопределения для маршрутизации appEngineRouting на уровне задачи. Эти параметры применяются только к задачам App Engine в этой очереди.

instance

string

Экземпляр приложения.

По умолчанию задача отправляется на экземпляр, доступный в момент её выполнения.

service

string

Сервис приложения.

По умолчанию задача отправляется в сервис, являющийся сервисом по умолчанию в момент её выполнения.

version

string

Версия приложения.

По умолчанию задача отправляется на версию, являющуюся версией по умолчанию в момент её выполнения.

auth_kind

string / обязательный

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

Варианты:

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

env_type

string

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

Не задавайте этот параметр, если не знаете, что делаете.

Он изменяет только строку User Agent для запросов к API.

location

string / обязательный

Расположение очереди.

name

string

Имя очереди.

project

string

Проект Google Cloud Platform, который следует использовать.

rate_limits

dictionary

Ограничения частоты отправки задач.

Фактическая скорость отправки задач из очереди определяется следующими факторами: * Количество задач в очереди * Ограничения, заданные пользователем: rateLimits, retryConfig и состояние очереди.

* Системные ограничения из-за ответов 429 (Too Many Requests) или 503 (Service Unavailable) от обработчика, высокой частоты ошибок или необходимости сгладить резкие скачки трафика.

max_concurrent_dispatches

integer

Максимальное количество одновременно выполняемых задач, отправку которых Cloud Tasks разрешает для этой очереди. После достижения этого порога Cloud Tasks прекращает отправку задач, пока количество параллельных запросов не уменьшится.

max_dispatches_per_second

string

Максимальная скорость отправки задач из этой очереди.

Если значение не указано при создании очереди, Cloud Tasks выберет значение по умолчанию.

retry_config

dictionary

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

max_attempts

integer

Количество попыток для каждой задачи.

Cloud Tasks попытается выполнить задачу maxAttempts раз (то есть, если первая попытка завершится неудачей, будет выполнено maxAttempts - 1 повторных попыток). Должно быть >= -1.

Если значение не указано при создании очереди, Cloud Tasks выберет значение по умолчанию.

Значение -1 означает неограниченное количество попыток.

max_backoff

string

Если RetryConfig очереди указывает, что задачу следует повторить, после её неудачного выполнения повторная попытка будет запланирована через интервал между minBackoff и maxBackoff.

max_doublings

integer

Интервал между повторными попытками будет удваиваться maxDoublings раз.

Интервал повторных попыток задачи начинается со значения minBackoff, затем удваивается maxDoublings раз, после чего увеличивается линейно, а затем повторные попытки выполняются с интервалом maxBackoff, но не более maxAttempts раз.

max_retry_duration

string

Если значение положительное, maxRetryDuration задаёт срок повторных попыток для неудачно выполненной задачи, отсчитываемый с момента первой попытки её выполнения. По истечении maxRetryDuration и после maxAttempts попыток дальнейшие попытки выполняться не будут, а задача будет удалена.

Если значение равно нулю, срок хранения задачи не ограничен.

min_backoff

string

Если RetryConfig очереди указывает, что задачу следует повторить, после её неудачного выполнения повторная попытка будет запланирована через интервал между minBackoff и maxBackoff.

scopes

list / elements=string

Массив используемых областей доступа

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

stackdriver_logging_config

dictionary

Параметры настройки записи журналов в Stackdriver Logging.

sampling_ratio

string / обязательный

Задаёт долю операций, сведения о которых будут записываться в Stackdriver Logging.

Поле может содержать любое значение от 0.0 до 1.0 включительно. Значение по умолчанию — 0.0, что означает, что сведения об операциях не записываются.

state

string

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

Варианты:

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

status

string

Текущее состояние очереди.

Допустимые варианты: «RUNNING», «PAUSED», «DISABLED»

Примеры

- name: create a queue
  google.cloud.gcp_cloudtasks_queue:
    name: test_object
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

appEngineRoutingOverride

complex

Переопределения для маршрутизации appEngineRouting на уровне задачи. Эти параметры применяются только к задачам App Engine в этой очереди.

Возвращается: при успехе

host

string

Узел, на который отправляется задача.

Возвращается: при успехе

instance

string

Экземпляр приложения.

По умолчанию задача отправляется на экземпляр, доступный в момент её выполнения.

Возвращается: при успехе

service

string

Сервис приложения.

По умолчанию задача отправляется в сервис, являющийся сервисом по умолчанию в момент её выполнения.

Возвращается: при успехе

version

string

Версия приложения.

По умолчанию задача отправляется на версию, являющуюся версией по умолчанию в момент её выполнения.

Возвращается: при успехе

location

string

Расположение очереди.

Возвращается: при успехе

name

string

Имя очереди.

Возвращается: при успехе

rateLimits

complex

Ограничения частоты отправки задач.

Фактическая скорость отправки задач из очереди определяется следующими факторами: * Количество задач в очереди * Ограничения, заданные пользователем: rateLimits, retryConfig и состояние очереди.

* Системные ограничения из-за ответов 429 (Too Many Requests) или 503 (Service Unavailable) от обработчика, высокой частоты ошибок или необходимости сгладить резкие скачки трафика.

Возвращается: при успехе

maxBurstSize

integer

Максимальный размер пакета.

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

Возвращается: при успехе

maxConcurrentDispatches

integer

Максимальное количество одновременно выполняемых задач, отправку которых Cloud Tasks разрешает для этой очереди. После достижения этого порога Cloud Tasks прекращает отправку задач, пока количество параллельных запросов не уменьшится.

Возвращается: при успехе

maxDispatchesPerSecond

string

Максимальная скорость отправки задач из этой очереди.

Если значение не указано при создании очереди, Cloud Tasks выберет значение по умолчанию.

Возвращается: при успехе

retryConfig

complex

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

Возвращается: при успехе

maxAttempts

integer

Количество попыток для каждой задачи.

Cloud Tasks попытается выполнить задачу maxAttempts раз (то есть, если первая попытка завершится неудачей, будет выполнено maxAttempts - 1 повторных попыток). Должно быть >= -1.

Если значение не указано при создании очереди, Cloud Tasks выберет значение по умолчанию.

Значение -1 означает неограниченное количество попыток.

Возвращается: при успехе

maxBackoff

string

Если RetryConfig очереди указывает, что задачу следует повторить, после её неудачного выполнения повторная попытка будет запланирована через интервал между minBackoff и maxBackoff.

Возвращается: при успехе

maxDoublings

integer

Интервал между повторными попытками будет удваиваться maxDoublings раз.

Интервал повторных попыток задачи начинается со значения minBackoff, затем удваивается maxDoublings раз, после чего увеличивается линейно, а затем повторные попытки выполняются с интервалом maxBackoff, но не более maxAttempts раз.

Возвращается: при успехе

maxRetryDuration

string

Если значение положительное, maxRetryDuration задаёт срок повторных попыток для неудачно выполненной задачи, отсчитываемый с момента первой попытки её выполнения. По истечении maxRetryDuration и после maxAttempts попыток дальнейшие попытки выполняться не будут, а задача будет удалена.

Если значение равно нулю, срок хранения задачи не ограничен.

Возвращается: при успехе

minBackoff

string

Если RetryConfig очереди указывает, что задачу следует повторить, после её неудачного выполнения повторная попытка будет запланирована через интервал между minBackoff и maxBackoff.

Возвращается: при успехе

purgeTime

string

Время последней очистки этой очереди.

Возвращается: при успехе

stackdriverLoggingConfig

complex

Параметры настройки записи журналов в Stackdriver Logging.

Возвращается: при успехе

samplingRatio

string

Задаёт долю операций, сведения о которых будут записываться в Stackdriver Logging.

Поле может содержать любое значение от 0.0 до 1.0 включительно. Значение по умолчанию — 0.0, что означает, что сведения об операциях не записываются.

Возвращается: при успехе

status

string

Текущее состояние очереди.

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_cloudtasks_queue_module.html

Spec-Zone.ru

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