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

Примечание

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

Для его установки используйте: 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 complex			всегда	Список ресурсов
	appEngineRoutingOverride complex		успех	Переопределения для маршрутизации приложений на уровне задач. Эти настройки применяются только к задачам 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	успех	Задача будет запланирована на повторную попытку через период времени между minBackoff и maxBackoff после ее неудачи, если в конфигурации повторных попыток очереди указано, что задача должна быть повторно выполнена.
		maxDoublings integer	успех	Время между повторными попытками будет удваиваться maxDoublings раз. Интервал повторной попытки задачи начинается с minBackoff, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторяет повторные попытки с интервалами maxBackoff до maxAttempts раз.
		maxRetryDuration string	успех	Если положительно, maxRetryDuration задает временной предел для повторных попыток выполнения задачи, измеряемый с момента первой попытки выполнения задачи. После того, как время maxRetryDuration истечет и задача будет выполнена maxAttempts раз, больше попыток не будет сделано, и задача будет удалена. Если равно нулю, то срок службы задачи неограничен.
		minBackoff string	успех	Задача будет запланирована на повторную попытку через период времени между 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_cloudtasks_queue_info_module.html