gcp_cloudtasks_queue_info – Сбор информации о очереди GCP

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

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

Описание

Сбор информации о очереди GCP

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible вы выполняете этот модуль. Это не нужно устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API.
location строка / обязательно		Расположение очереди.
project строка		Проект Google Cloud Platform, который нужно использовать.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, его представляющей.
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если как тип выбран serviceaccount.

Примечания

Примечание

для аутентификации можно установить 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: get info on a queue
  gcp_cloudtasks_queue_info:
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое значение	Описание
resources complex			всегда	Список ресурсов
	appEngineRoutingOverride complex		успех	Переопределения для маршрутизации App Engine на уровне задач. Эти настройки применяются только к задачам App Engine в этой очереди.
		host string	успех	Хост, на который отправляется задача.
		instance string	успех	Прикладной экземпляр. По умолчанию задача отправляется на доступный экземпляр при попытке выполнить задачу.
		service string	успех	Прикладная служба. По умолчанию задача отправляется на службу по умолчанию при попытке выполнить задачу.
		version string	успех	Версия приложения. По умолчанию задача отправляется на версию по умолчанию при попытке выполнения задачи.
	location string		успех	Расположение очереди.
	name string		успех	Имя очереди.
	rateLimits complex		успех	Лимиты скорости для отправки задач. Фактическая скорость отправки задач в очереди является результатом: * Количества задач в очереди * Установленных пользователем ограничений: rateLimits, retryConfig и состояния очереди. * Системных ограничений, вызванных ответами 429 (Слишком много запросов) или 503 (Сервис недоступен) от исполнителя, высокой скоростью ошибок или сглаживанием резких скачков большого трафика.
		maxBurstSize integer	успех	Максимальный размер всплеска. Максимальный размер всплеска ограничивает скорость обработки задач в очереди, когда в очереди много задач и скорость высокая. Это поле позволяет очереди иметь высокую скорость, чтобы обработка началась вскоре после добавления задачи в очередь, но при этом ограничивает использование ресурсов, когда в очередь добавляется много задач за короткий промежуток времени.
		maxConcurrentDispatches integer	успех	Максимальное количество одновременных задач, которые Cloud Tasks разрешает отправлять для этой очереди. После достижения этого порога Cloud Tasks приостанавливает отправку задач до тех пор, пока количество одновременных запросов не уменьшится.
		maxDispatchesPerSecond integer	успех	Максимальная скорость отправки задач из этой очереди. Если значение не указано при создании очереди, Cloud Tasks выберет значение по умолчанию.
	retryConfig complex		успех	Настройки, определяющие поведение повторных попыток.
		maxAttempts integer	успех	Количество попыток на задачу. Cloud Tasks будет пытаться выполнить задачу maxAttempts раз (то есть, если первая попытка завершится неудачно, то будет maxAttempts - 1 попыток повторной отправки). Должно быть >= -1. Если значение не указано при создании очереди, Cloud Tasks выберет значение по умолчанию. -1 означает неограниченное количество попыток.
		maxBackoff string	успех	Если задача завершится неудачно, она будет запланирована на повторную попытку через промежуток времени между minBackoff и maxBackoff, если в настройках очереди retryConfig указано, что задачу следует перепробовать.
		maxDoublings integer	успех	Время между повторными попытками удваивается maxDoublings раз. Интервал повторной попытки задачи начинается с minBackoff, затем удваивается maxDoublings раз, затем увеличивается линейно, и, наконец, повторяет повторные попытки с интервалами maxBackoff до maxAttempts раз.
		maxRetryDuration string	успех	Если положительно, maxRetryDuration указывает временной лимит для повторной попытки завершившейся неудачей задачи, отсчитываемый с момента первой попытки выполнения задачи. После истечения maxRetryDuration и попытки выполнения задачи maxAttempts раз, дальнейшие попытки не будут предприниматься, и задача будет удалена. Если ноль, то возраст задачи не ограничен.
		minBackoff string	успех	Если задача завершится неудачно, она будет запланирована на повторную попытку через промежуток времени между minBackoff и maxBackoff, если в настройках очереди retryConfig указано, что задачу следует перепробовать.
		purgeTime string	успех	Последний раз, когда эта очередь была очищена.
	status string		успех	Текущее состояние очереди.

Статус

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