google.cloud.gcp_cloudtasks_queue – Создаёт очередь GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud
Для использования в плейбуке укажите: google.cloud.gcp_cloudtasks_queue
Обзор
- Именованный ресурс, в который издатели отправляют сообщения.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| app_engine_routing_override словарь | Переопределения для appEngineRouting на уровне задачи. Эти настройки применяются только к задачам App Engine в этой очереди. | ||
| instance строка | Экземпляр приложения. По умолчанию задача отправляется на доступный экземпляр при попытке выполнения. | ||
| service строка | Сервис приложения. По умолчанию задача отправляется на заданный сервис при попытке выполнения. | ||
| version строка | Версия приложения. По умолчанию задача отправляется на заданную версию при попытке выполнения. | ||
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| 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 строка | Задача будет запланирована на повторную попытку через время от minBackoff до maxBackoff после неудачи, если RetryConfig очереди указывает, что задача должна быть повторно отправлена. | ||
| max_doublings целое число | Время между повторными попытками удваивается maxDoublings раз. Интервал повторной попытки задачи начинается с minBackoff, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторяется через интервалы maxBackoff до maxAttempts раз. | ||
| max_retry_duration строка | Если положительно, maxRetryDuration задает предельное время для повторной отправки завершившейся ошибкой задачи, отсчитываемое с момента первой попытки выполнения задачи. По истечении maxRetryDuration и после maxAttempts попыток выполнение задачи не будет производиться и задача будет удалена. Если равно нулю, возраст задачи неограничен. | ||
| min_backoff строка | Задача будет запланирована на повторную попытку через время от minBackoff до maxBackoff после неудачи, если RetryConfig очереди указывает, что задача должна быть повторно отправлена. | ||
| scopes список / элементы=строка | Массив используемых областей. | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи сервиса, либо в словаре, либо как строка JSON, представляющая его. | ||
| service_account_email строка | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. | ||
| stackdriver_logging_config словарь | Настройки для записи логов в Stackdriver Logging. | ||
| sampling_ratio строка / обязательно | Указывает дробь операций, которые будут записаны в Stackdriver Logging. Это поле может содержать любое значение от 0,0 до 1,0 включительно. 0,0 является значением по умолчанию и означает, что операции не регистрируются. | ||
| state строка |
| Существование объекта в GCP | |
| status строка | Текущее состояние очереди. Некоторые допустимые значения включают: "RUNNING", "PAUSED", "DISABLED" | ||
Примеры
- name: create a queue
google.cloud.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 (Слишком много запросов) или 503 (Сервис недоступен) от обработчика, высокой частоты ошибок или для сглаживания резких скачков большого трафика. | |
| maxBurstSize integer | success | Максимальный размер всплеска. Максимальный размер всплеска ограничивает скорость обработки задач в очереди, когда в очереди много задач и скорость высокая. Это поле позволяет очереди иметь высокую скорость, так что обработка начинается вскоре после добавления задачи в очередь, но при этом ограничивает использование ресурсов, когда в очередь добавляется много задач за короткий период времени. | |
| maxConcurrentDispatches integer | success | Максимальное количество одновременных задач, которые Cloud Tasks разрешает отправлять для этой очереди. После достижения этого порога Cloud Tasks прекращает отправку задач до тех пор, пока количество одновременных запросов не уменьшится. | |
| maxDispatchesPerSecond string | 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 | Последнее время очистки этой очереди. | |
| stackdriverLoggingConfig complex | success | Настройки для записи журналов в Stackdriver Logging. | |
| samplingRatio string | success | Указывает долю операций, которые необходимо записать в Stackdriver Logging. Это поле может содержать любое значение от 0,0 до 1,0 включительно. 0,0 является значением по умолчанию и означает, что операции не регистрируются. | |
| status string | success | Текущее состояние очереди. | |
Авторы
- 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_module.html
