google.cloud.gcp_cloudtasks_queue – Создаёт очередь GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.1).
Для его установки используйте: 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 продолжительностью после неудачи, если в настройках повторных попыток очереди указано, что задача должна быть повторена. | ||
| max_doublings целое число | Время между повторными попытками удваивается maxDoublings раз. Интервал повторных попыток задачи начинается с minBackoff, затем удваивается maxDoublings раз, а затем увеличивается линейно и, наконец, повторяется с интервалами maxBackoff до maxAttempts раз. | ||
| max_retry_duration строка | Если положительное, maxRetryDuration задает временной предел для повторных попыток неудачной задачи, отсчитываемый со времени первой попытки выполнения задачи. После того, как истечёт время maxRetryDuration, и задача была предпринята maxAttempts раз, дальнейшие попытки не будут предприняты, и задача будет удалена. Если ноль, то возраст задачи не ограничен. | ||
| min_backoff строка | Задача будет запланирована на повторную попытку между minBackoff и maxBackoff продолжительностью после неудачи, если в настройках повторных попыток очереди указано, что задача должна быть повторена. | ||
| scopes список / элементы=строка | Массив используемых областей | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, его представляющей. | ||
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбрано serviceaccount. | ||
| 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, если в настройках повторной обработки очереди указано, что задача должна быть повторно обработана. | |
| maxDoublings integer | success | Интервал между попытками повторной обработки будет удваиваться maxDoublings раз. Интервал повторной попытки задачи начинается с minBackoff, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторяет попытки через интервалы maxBackoff до maxAttempts раз. | |
| maxRetryDuration string | success | Если положительное, maxRetryDuration задает временной лимит для повторной обработки завершившейся неудачей задачи, измеренный с момента первой попытки выполнения задачи. После того, как прошло время maxRetryDuration, и задача была выполнена maxAttempts раз, дальнейшие попытки не будут предприниматься, и задача будет удалена. Если равно нулю, срок действия задачи не ограничен. | |
| minBackoff string | success | Если задача завершится неудачно, она будет запланирована на повторную попытку в промежутке между minBackoff и maxBackoff, если в настройках повторной обработки очереди указано, что задача должна быть повторно обработана. | |
| purgeTime string | success | Последний момент времени, когда эта очередь была очищена. | |
| status string | success | Текущее состояние очереди. | |
Авторы
- 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_module.html
