Модуль google.cloud.gcp_cloudtasks_queue_info — Сбор информации о очереди GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните команду ansible-galaxy collection list.
Для установки используйте: 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
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательный | Тип учетных данных, используемых для аутентификации. Доступные значения:
|
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. - для аутентификации можно установить access_token, используя переменную среды
GCP_ACCESS_TOKEN. - для аутентификации можно установить 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, если в настройках повторных попыток очереди указано, что задача должна быть повторена. Возвращается: успех |
|
maxDoublings целое число |
Интервал между повторными попытками будет удваиваться maxDoublings раз. Интервал повторной попытки задачи начинается с minBackoff, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторяется с интервалами maxBackoff до maxAttempts раз. Возвращается: успех |
|
maxRetryDuration строка |
Если положительное, maxRetryDuration задаёт временной предел для повторных попыток неудачной задачи, измеряемый с момента первой попытки выполнения задачи. После того, как время maxRetryDuration истечёт, и задача была выполнена maxAttempts раз, дальнейшие попытки не будут предприниматься, и задача будет удалена. Если равно нулю, возраст задачи не ограничен. Возвращается: успех |
|
minBackoff string |
Задача будет запланирована на повторную обработку в течение времени от minBackoff до maxBackoff после ее неудачи, если в настройках очереди RetryConfig указано, что задача должна быть повторно обработана. Возвращаемое значение: success |
|
purgeTime string |
Последнее время очистки этой очереди. Возвращаемое значение: success |
|
stackdriverLoggingConfig complex |
Параметры конфигурации для записи журналов в Stackdriver Logging. Возвращаемое значение: success |
|
samplingRatio string |
Указывает долю операций, которые нужно записать в Stackdriver Logging. Это поле может содержать любое значение от 0,0 до 1,0 включительно. 0,0 является значением по умолчанию и означает, что операции не регистрируются. Возвращаемое значение: success |
|
status string |
Текущее состояние очереди. Возвращаемое значение: success |
Ссылки на коллекцию
© 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_info_module.html
