Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_cloudtasks_queue – Создаёт очередь GCP

Примечание

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

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

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

Для использования в книге задач, укажите: google.cloud.gcp_cloudtasks_queue.

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

Описание

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

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

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

app_engine_routing_override

словарь

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

instance

строка

Инстанс приложения.

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

service

строка

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

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

version

строка

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

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

auth_kind

строка / обязательно

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

Варианты:

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

env_type

строка

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

Не устанавливайте это значение, если вы не знаете, что делаете.

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

location

строка / обязательно

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

name

строка

Имя очереди.

project

строка

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

rate_limits

словарь

Лимиты скорости для отправки задач.

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

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

max_concurrent_dispatches

целое число

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

max_dispatches_per_second

строка

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

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

retry_config

словарь

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

max_attempts

целое число

Количество попыток на задачу.

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

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

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

max_backoff

строка

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

max_doublings

целое число

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

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

max_retry_duration

строка

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

Если ноль, то возраст задачи не ограничен.

min_backoff

строка

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

scopes

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

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

service_account_contents

jsonarg

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

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

сложный

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

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

host

строка

Хост, к которому отправляется задача.

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

instance

строка

Инстанс приложения.

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

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

service

строка

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

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

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

version

строка

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

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

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

location

строка

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

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

name

строка

Имя очереди.

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

rateLimits

сложный

Пределы скорости для отправки задач.

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

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

maxBurstSize

целое число

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

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

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

maxConcurrentDispatches

целое число

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

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

maxDispatchesPerSecond

строка

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

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

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

retryConfig

сложный

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

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

maxAttempts

целое число

Количество попыток на задачу.

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

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

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

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

maxBackoff

строка

Задача будет запланирована на повторную попытку через интервал от minBackoff до maxBackoff, если конфигурация повторной попытки очереди определяет, что задача должна быть повторно отправлена.

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

maxDoublings

целое число

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

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

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

maxRetryDuration

строка

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

Если равно нулю, время существования задачи неограничено.

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

minBackoff

строка

Задача будет запланирована на повторную попытку через интервал от minBackoff до maxBackoff, если конфигурация повторной попытки очереди определяет, что задача должна быть повторно отправлена.

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

purgeTime

строка

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

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

stackdriverLoggingConfig

complex

Параметры конфигурации для записи логов в Stackdriver Logging.

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

samplingRatio

string

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

Это поле может содержать любое значение от 0,0 до 1,0 включительно. Значение 0,0 является значением по умолчанию и означает, что операции не будут регистрироваться.

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

status

string

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

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

Авторы

  • 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_cloudtasks_queue_module.html

Spec-Zone.ru

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