gcp_cloudscheduler_job_info – Сбор информации о задании GCP
Новая версия 2.9.
Описание
- Сбор информации о задании 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, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры 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 complex | всегда | Список ресурсов | |||
| appEngineHttpTarget complex | успех | Целевой ресурс App Engine HTTP. Если поставщик задач предоставляет целевой ресурс App Engine HTTP, планировщик отправит запрос на экземпляр сервиса. | |||
| appEngineRouting complex | успех | Настройка маршрутизации App Engine для задачи. | |||
| instance string | успех | Экземпляр приложения. По умолчанию задача отправляется на доступный экземпляр при попытке выполнения задачи. | |||
| service string | успех | Сервис приложения. По умолчанию задача отправляется на заданный сервис по умолчанию при попытке выполнения задачи. | |||
| version string | успех | Версия приложения. По умолчанию задача отправляется на версию по умолчанию при попытке выполнения задачи. | |||
| body string | успех | Тело HTTP-запроса. Тело запроса разрешено только для методов HTTP POST или PUT. Установка тела для задачи с несовместимым методом HTTP приведет к ошибке неверных аргументов. | |||
| headers dictionary | успех | Заголовки HTTP-запроса. Этот словарь содержит имена и значения заголовков. Заголовки можно задать при создании задачи. | |||
| httpMethod string | успех | Метод HTTP, используемый для запроса. | |||
| relativeUri string | успех | Относительный URI. | |||
| description string | успех | Описание задачи для человека. Длина этой строки не должна превышать 500 символов. | |||
| httpTarget complex | успех | Целевой HTTP-ресурс. Если задача предоставляет http_target, планировщик отправит запрос по указанному URL. | |||
| body string | успех | Тело HTTP-запроса. Тело запроса разрешено только для методов HTTP POST, PUT или PATCH. Установка тела для задачи с несовместимым методом HTTP является ошибкой. | |||
| headers dictionary | успех | Этот словарь содержит имена и значения заголовков. Повторные заголовки не поддерживаются, но значение заголовка может содержать запятые. | |||
| httpMethod string | успех | Метод HTTP, используемый для запроса. | |||
| oauthToken complex | успех | Содержит информацию, необходимую для генерации маркера OAuth. Этот тип авторизации следует использовать при отправке запросов на конечную точку GCP. | |||
| scope string | успех | Диапазон OAuth, используемый для генерации маркера доступа OAuth. Если не указано, будет использоваться «https://www.googleapis.com/auth/cloud-platform". | |||
| serviceAccountEmail string | успех | Электронный адрес учетной записи сервиса, используемый для генерации маркера OAuth. Учетная запись сервиса должна принадлежать тому же проекту, что и задача. | |||
| oidcToken complex | успех | Содержит информацию, необходимую для генерации токена OpenID Connect. Этот тип авторизации следует использовать при отправке запросов на конечные точки сторонних поставщиков или Cloud Run. | |||
| audience string | успех | Аудитория, используемая при генерации токена OIDC. Если не указано, будет использоваться URI, указанный в целевом параметре. | |||
| serviceAccountEmail string | успех | Электронный адрес учетной записи сервиса, используемый для генерации маркера OAuth. Учетная запись сервиса должна принадлежать тому же проекту, что и задача. | |||
| uri string | успех | Полный URI-путь, по которому будет отправлен запрос. | |||
| name string | успех | Название задачи. | |||
| pubsubTarget complex | успех | Целевой ресурс Pub/Sub. Если задача предоставляет целевой ресурс Pub/Sub, планировщик опубликует сообщение в указанную тему. | |||
| attributes dictionary | успех | Атрибуты для PubsubMessage. Сообщение Pubsub должно содержать либо непустые данные, либо хотя бы один атрибут. | |||
| data string | успех | Данные сообщения для PubsubMessage. Сообщение Pubsub должно содержать либо непустые данные, либо хотя бы один атрибут. | |||
| topicName string | успех | Имя темы Cloud Pub/Sub, в которую будут публиковаться сообщения при доставке задачи. Имя темы должно соответствовать формату, требуемому для параметра PublishRequest.name в PubSub, например projects/PROJECT_ID/topics/TOPIC_ID. | |||
| region string | успех | Регион, в котором находится задача планировщика. | |||
| retryConfig complex | успех | По умолчанию, если задача не завершается успешно (то есть не получено подтверждение от обработчика), она будет повторно выполняться с экспоненциальным отложенным выполнением в соответствии с настройками. | |||
| maxBackoffDuration string | успех | Максимальное время ожидания перед повторной попыткой выполнения задачи после ее сбоя. Продолжительность в секундах с точностью до девяти десятичных знаков, завершающаяся символом 's'. | |||
| maxDoublings integer | успех | Интервал между повторными попытками будет удваиваться maxDoublings раз. Интервал повторной попытки задачи начинается с minBackoffDuration, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторяется с интервалами maxBackoffDuration до retryCount раз. | |||
| максСрокПовторногоВыполнения строка | успех | Предельное время для повторного выполнения задачи, отсчитываемое с момента первой попытки выполнения. Если задано retryCount, задача будет повторно выполняться до тех пор, пока оба ограничения не будут достигнуты. Продолжительность в секундах с точностью до девяти знаков после запятой, заканчивающаяся символом 's'. | |||
| минВремяОжидания строка | успех | Минимальное время ожидания перед повторным выполнением задачи после ее неудачи. Продолжительность в секундах с точностью до девяти знаков после запятой, заканчивающаяся символом 's'. | |||
| повторПопыток целое число | успех | Количество попыток, которые система предпримет для выполнения задачи с помощью процедуры экспоненциального отката, описанной в maxDoublings. Значения больше 5 и отрицательные значения не допускаются. | |||
| расписание строка | успех | Описывает расписание, по которому будет выполняться задача. | |||
| часовойПояс строка | успех | Указывает часовой пояс, который будет использоваться при интерпретации расписания. Значение этого поля должно быть именем часового пояса из базы данных tz. | |||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/gcp_cloudscheduler_job_info_module.html
