google.cloud.gcp_cloudscheduler_job_info – Сбор информации о задании GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_cloudscheduler_job_info
Обзор
- Сбор информации о задании GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это следует указывать только в том случае, если вы знаете, что делаете. Это изменяет только строку User Agent для всех запросов API. | |
| project строка | Проект Google Cloud Platform для использования. | |
| region строка / обязательно | Регион, в котором находится задача планировщика. | |
| 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 job
gcp_cloudscheduler_job_info:
region: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключевые параметры | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| resources сложное | всегда | Список ресурсов | |||
| appEngineHttpTarget сложное | успех | Целевой App Engine HTTP. Если задание предоставляет целевой App Engine HTTP, то кронирование отправит запрос на экземпляр службы. | |||
| appEngineRouting сложное | успех | Настройка маршрутизации App Engine для задания. | |||
| instance строка | успех | Экземпляр приложения. По умолчанию задание отправляется на доступный экземпляр при попытке его выполнения. | |||
| service строка | успех | Служба приложения. По умолчанию задание отправляется на службу по умолчанию при попытке его выполнения. | |||
| version строка | успех | Версия приложения. По умолчанию задание отправляется на версию по умолчанию при попытке его выполнения. | |||
| body строка | успех | Тело HTTP-запроса. Тело запроса разрешено только в том случае, если HTTP-метод POST или PUT. Установка тела задания с несовместимым HttpMethod приведет к ошибке аргумента. | |||
| headers словарь | успех | Заголовки HTTP-запроса. Этот словарь содержит имена и значения заголовков. Заголовки могут быть установлены при создании задания. | |||
| httpMethod строка | успех | Какой HTTP-метод использовать для запроса. | |||
| relativeUri строка | успех | Относительный URI. | |||
| attemptDeadline строка | успех | Срок выполнения попыток задания. Если обработчик запроса не отвечает в этот срок, запрос отменяется, а попытка отмечается как ошибка DEADLINE_EXCEEDED. Неуспешную попытку можно просмотреть в журналах выполнения. Cloud Scheduler повторит задание в соответствии с настройками RetryConfig. Допустимая продолжительность для этого срока: * Для HTTP-целей — от 15 секунд до 30 минут. * Для App Engine HTTP-целей — от 15 секунд до 24 часов. * **Примечание**: Для PubSub-целей это поле игнорируется — установка его приведет к неразрешимой разнице. Продолжительность в секундах с точностью до девяти десятичных знаков, заканчивающаяся на 's'. Пример: "3.5s". | |||
| description строка | успех | Описание задания для пользователя. Длина этой строки не должна превышать 500 символов. | |||
| httpTarget сложное | успех | HTTP-цель. Если задание предоставляет http_target, кронирование отправит запрос на указанный URL. | |||
| body строка | успех | Тело HTTP-запроса. Тело запроса разрешено только в том случае, если HTTP-метод POST, PUT или PATCH. Установка тела для задания с несовместимым HttpMethod является ошибкой. | |||
| headers словарь | успех | Этот словарь содержит имена и значения заголовков. Повторные заголовки не поддерживаются, но значение заголовка может содержать запятые. | |||
| httpMethod строка | успех | Какой HTTP-метод использовать для запроса. | |||
| oauthToken сложное | успех | Содержит информацию, необходимую для генерации токена OAuth. Этот тип авторизации следует использовать при отправке запросов на конечную точку GCP. | |||
| scope строка | успех | OAuth-объем, используемый для генерации токена доступа OAuth. Если не указан, будет использоваться "https://www.googleapis.com/auth/cloud-platform". | |||
| serviceAccountEmail строка | успех | Электронная почта учетной записи службы, используемая для генерации токена OAuth. Учетная запись службы должна находиться в том же проекте, что и задание. | |||
| oidcToken сложное | успех | Содержит информацию, необходимую для генерации токена OpenID Connect. Этот тип авторизации следует использовать при отправке запросов на сторонние конечные точки или Cloud Run. | |||
| audience строка | успех | Аудитория, используемая при генерации токена OIDC. Если не указана, используется URI, указанный в целевом параметре. | |||
| serviceAccountEmail строка | успех | Электронная почта учетной записи службы, используемая для генерации токена OAuth. Учетная запись службы должна находиться в том же проекте, что и задание. | |||
| uri строка | успех | Полный URI-путь, на который будет отправлен запрос. | |||
| name строка | успех | Имя задания. | |||
| pubsubTarget сложное | успех | Целевая Pub/Sub. Если задание предоставляет целевой Pub/Sub, кронирование опубликует сообщение в указанную тему. | |||
| attributes словарь | успех | Атрибуты для PubsubMessage. Сообщение Pubsub должно содержать либо непустые данные, либо хотя бы один атрибут. | |||
| data строка | успех | Загрузка сообщения для PubsubMessage. Сообщение Pubsub должно содержать либо непустые данные, либо хотя бы один атрибут. | |||
| topicName строка | успех | Полное имя ресурса темы Cloud Pub/Sub, в которую будут публиковаться сообщения при доставке задания. ~>**ПРИМЕЧАНИЕ**: Имя темы должно соответствовать формату, требуемому для PublishRequest.name в PubSub, например, `projects/my-project/topics/my-topic`. | |||
| region строка | успех | Регион, в котором находится задание планировщика. | |||
| retryConfig сложное | успех | По умолчанию, если задание не выполняется успешно, то есть подтверждение не получено от обработчика, оно будет повторно выполняться с экспоненциальной задержкой в соответствии с настройками. | |||
| maxBackoffDuration строка | успех | Максимальное время ожидания перед повторной попыткой выполнения задания после неудачи. Продолжительность в секундах с точностью до девяти десятичных знаков, заканчивающаяся на 's'. | |||
| maxDoublings целое число | успех | Интервал времени между повторными попытками будет удваиваться maxDoublings раз. Интервал повторной попытки задания начинается с minBackoffDuration, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторяется с интервалами maxBackoffDuration до retryCount раз. | |||
| maxRetryDuration строка | успех | Предельное время для повторных попыток выполнения задания, начиная с момента первой попытки выполнения. При указании retryCount задание будет выполняться повторно до тех пор, пока оба ограничения не будут достигнуты. Продолжительность в секундах с точностью до девяти десятичных знаков, заканчивающаяся на 's'. | |||
| minBackoffDuration строка | успех | Минимальное время ожидания перед повторной попыткой выполнения задания после неудачи. Продолжительность в секундах с точностью до девяти десятичных знаков, заканчивающаяся на 's'. | |||
| retryCount integer | success | Количество попыток, которые система предпримет для выполнения задачи, используя процедуру экспоненциальной задержки, описанную в maxDoublings. Значения больше 5 и отрицательные значения недопустимы. | |||
| schedule string | success | Описывает график, по которому будет выполняться задача. | |||
| timeZone string | success | Указывает часовой пояс, используемый при интерпретации графика. Значение этого поля должно быть названием часового пояса из базы данных tz. | |||
Авторы
- 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_cloudscheduler_job_info_module.html
