gcp_cloudtasks_queue – Создание очереди GCP

Новая версия с 2.9.

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

Описание

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

Требования

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
app_engine_routing_override словарь			Переопределения для appEngineRouting на уровне задачи. Эти настройки применяются только к задачам App Engine в этой очереди.
	instance строка		Экземпляр приложения. По умолчанию задача отправляется на доступный экземпляр при попытке выполнения.
	service строка		Сервис приложения. По умолчанию задача отправляется на сервис по умолчанию при попытке выполнения.
	version строка		Версия приложения. По умолчанию задача отправляется на версию по умолчанию при попытке выполнения.
auth_kind строка / обязательно		Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка			Указывает, в какой среде Ansible выполняется этот модуль. Этого не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API.
location строка / обязательно			Расположение очереди.
name строка			Имя очереди.
project строка			Используемый проект Google Cloud Platform.
rate_limits словарь			Пределы скорости для отправки задач. Фактическая скорость отправки задач в очереди определяется: * Количество задач в очереди * Пользовательская регулировка: rateLimits, retryConfig и состояние очереди. * Системная регулировка из-за ответов 429 (Слишком много запросов) или 503 (Сервис недоступен) от исполнителя, высокой скорости ошибок или для сглаживания резких скачков большого трафика.
	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 строка		Если задача завершилась неудачно, Cloud Tasks запланирует повторное выполнение задачи через интервал от minBackoff до maxBackoff, если в RetryConfig очереди указано повторное выполнение задачи.
	max_doublings целое число		Интервал между повторными попытками удваивается maxDoublings раз. Интервал повторной попытки задачи начинается с minBackoff, затем удваивается maxDoublings раз, затем увеличивается линейно, а затем повторные попытки выполняются через интервалы maxBackoff до maxAttempts раз.
	max_retry_duration строка		Если положительное, maxRetryDuration указывает предельное время повторной попытки завершившейся неудачей задачи, отсчитываемое от момента первой попытки выполнения. После того, как время maxRetryDuration прошло и задача была предпринята maxAttempts раз, дальнейшие попытки не будут предприниматься, и задача будет удалена. Если ноль, то возраст задачи не ограничен.
	min_backoff строка		Если задача завершилась неудачно, Cloud Tasks запланирует повторное выполнение задачи через интервал от minBackoff до maxBackoff, если в RetryConfig очереди указано повторное выполнение задачи.
scopes список			Массив используемых областей.
service_account_contents jsonarg			Содержимое файла JSON учетной записи службы, представленное либо в словаре, либо как JSON-строка, представляющая его.
service_account_email строка			Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь			Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.
state строка		Варианты: present ← absent	Указывает, должен ли заданный объект существовать в GCP
status строка			Текущее состояние очереди. Некоторые допустимые значения включают: «RUNNING», «PAUSED», «DISABLED»

Примечания

Примечание

для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents, используя переменную среды c(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: create a queue
  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		success	Переопределения для маршрутизации заданий уровня appEngineRouting. Эти настройки применяются только к заданиям App Engine в этой очереди.
	host string	success	Хост, которому отправляется задание.
	instance string	success	Прикладной экземпляр. По умолчанию задание отправляется на экземпляр, доступный при попытке выполнить задание.
	service string	success	Прикладная служба. По умолчанию задание отправляется на службу, являющуюся службой по умолчанию при попытке выполнить задание.
	version string	success	Версия приложения. По умолчанию задание отправляется на версию, являющуюся версией по умолчанию при попытке выполнить задание.
location string		success	Расположение очереди.
name string		success	Имя очереди.
rateLimits complex		success	Пределы скорости для отправки заданий. Фактическая скорость отправки заданий из очереди является результатом: * Количества заданий в очереди * Пользовательской регулировки (rateLimits, retryConfig и состояние очереди) * Системной регулировки из-за ответов 429 (Too Many Requests) или 503 (Service Unavailable) от исполнителя, высокой скорости ошибок или для сглаживания внезапных больших всплесков трафика.
	maxBurstSize integer	success	Максимальный размер всплеска. Максимальный размер всплеска ограничивает скорость обработки заданий в очереди, когда в очереди много заданий и скорость высокая. Это поле позволяет очереди иметь высокую скорость, так что обработка начинается вскоре после помещения задания в очередь, но при этом ограничивает использование ресурсов, когда много заданий помещаются в очередь за короткий промежуток времени.
	maxConcurrentDispatches integer	success	Максимальное количество одновременных заданий, которые Cloud Tasks разрешает отправлять для этой очереди. После достижения этого порога Cloud Tasks прекращает отправку заданий до тех пор, пока количество одновременных запросов не уменьшится.
	maxDispatchesPerSecond integer	success	Максимальная скорость отправки заданий из этой очереди. Если не указано при создании очереди, Cloud Tasks выберет значение по умолчанию.
retryConfig complex		success	Настройки, определяющие поведение повторной попытки.
	maxAttempts integer	success	Число попыток на задание. Cloud Tasks будет пытаться выполнить задание maxAttempts раз (то есть, если первая попытка завершится неудачей, то будет maxAttempts - 1 попыток повторной обработки). Должно быть >= -1. Если не указано при создании очереди, Cloud Tasks выберет значение по умолчанию. -1 означает неограниченное число попыток.
	maxBackoff string	success	Задание будет запланировано на повторную попытку в промежутке времени от minBackoff до maxBackoff после неудачи, если RetryConfig очереди указывает, что задание должно быть повторно обработано.
	maxDoublings integer	success	Время между повторными попытками будет удваиваться maxDoublings раз. Интервал повторной попытки задания начинается с minBackoff, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторные попытки производятся через интервалы maxBackoff до maxAttempts раз.
	maxRetryDuration string	success	Если положительное, maxRetryDuration задаёт предельное время для повторной обработки неисправного задания, измеряемое с момента первой попытки. После того, как прошло maxRetryDuration времени, и задание было предпринято maxAttempts раз, дальнейшие попытки не будут производиться, и задание будет удалено. Если ноль, то возраст задания не ограничен.
	minBackoff string	success	Задание будет запланировано на повторную попытку в промежутке времени от minBackoff до maxBackoff после неудачи, если RetryConfig очереди указывает, что задание должно быть повторно обработано.
	purgeTime string	success	Последний момент времени, когда была очищена эта очередь.
status string		success	Текущее состояние очереди.

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается сообществом 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.9/modules/gcp_cloudtasks_queue_module.html