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

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_cloudtasks_queue_info.

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

Обзор

Сбор информации об очереди 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 с помощью переменной среды 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 queue
  gcp_cloudtasks_queue_info:
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

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

Авторы

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.10/collections/google/cloud/gcp_cloudtasks_queue_info_module.html