google.cloud.gcp_cloudscheduler_job_info – Сбор информации о задании GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: 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 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. Установка тела в задании с несовместимым HttpMethod приведет к ошибке аргумента. Строка в кодировке Base64. | |||
| headers dictionary | успех | Заголовки HTTP-запроса. Этот массив содержит имена и значения заголовков. Заголовки можно установить при создании задания. | |||
| httpMethod string | успех | Какой HTTP-метод использовать для запроса. | |||
| relativeUri string | успех | Относительный URI. | |||
| attemptDeadline string | успех | Срок выполнения попытки задания. Если обработчик запроса не ответит в этот срок, запрос будет отменён, а попытка отмечена как ошибка DEADLINE_EXCEEDED. Ошибка попытки будет отображена в логах выполнения. Cloud Scheduler повторит выполнение задания в соответствии с параметрами RetryConfig. Разрешённый интервал для этого срока составляет: * Для HTTP-целей - от 15 секунд до 30 минут. * Для целей App Engine HTTP - от 15 секунд до 24 часов. * **Примечание**: Для целей PubSub этот параметр игнорируется — его установка приведёт к неразрешимой разнице. Продолжительность в секундах с максимально девятью десятичными знаками, заканчивающимися на 's'. Пример: "3.5s". | |||
| description string | успех | Описание задания, понятное человеку. Эта строка не должна содержать более 500 символов. | |||
| httpTarget complex | успех | Целевой ресурс HTTP. Если задание предоставляет целевой ресурс HTTP, планировщик заданий отправит запрос на указанный URL. | |||
| body string | успех | Тело HTTP-запроса. Тело запроса разрешено только в том случае, если HTTP-метод является POST, PUT или PATCH. Установка тела в задании с несовместимым HttpMethod — ошибка. Строка в кодировке Base64. | |||
| 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 должно содержать либо непустые данные, либо хотя бы один атрибут. Строка в кодировке Base64. | |||
| topicName string | успех | Полное имя ресурса темы Cloud Pub/Sub, в которую будут публиковаться сообщения при выполнении задания. ~>**ПРИМЕЧАНИЕ**: Имя темы должно соответствовать формату, требуемому для параметра PublishRequest.name в PubSub, например, `projects/my-project/topics/my-topic`. | |||
| region string | успех | Регион, в котором находится задание планировщика. | |||
| retryConfig complex | успех | По умолчанию, если задание не завершилось успешно (т. е. не получено подтверждение от обработчика), оно будет повторно выполнено с экспоненциальной задержкой в соответствии с настройками. | |||
| maxBackoffDuration string | успех | Максимальное время ожидания перед повторной попыткой выполнения задания после неудачи. Продолжительность в секундах с максимально девятью десятичными знаками, заканчивающимися на 's'. | |||
| maxDoublings integer | успех | Количество раз, на которое будет удваиваться интервал между повторными попытками. Интервал повторных попыток задания начинается с minBackoffDuration, затем удваивается maxDoublings раз, затем увеличивается линейно и, наконец, повторяется через интервалы maxBackoffDuration до retryCount раз. | |||
| maxRetryDuration string | успех | Лимит времени для повторного выполнения неисправного задания, измеряемого с момента первой попытки выполнения. При указании retryCount, задание будет выполняться до тех пор, пока не будут достигнуты оба ограничения. Продолжительность в секундах с максимально девятью десятичными знаками, заканчивающимися на 's'. | |||
| minBackoffDuration string | успех | Минимальное время ожидания перед повторной попыткой выполнения задания после неудачи. Продолжительность в секундах с максимально девятью десятичными знаками, заканчивающимися на 's'. | |||
| retryCount integer | success | Количество попыток, которые система предпримет для выполнения задачи, используя процедуру экспоненциальной задержки, описанную в maxDoublings. Значения больше 5 и отрицательные значения недопустимы. | |||
| schedule string | success | Описывает график, по которому будет выполняться задача. | |||
| timeZone string | success | Указывает часовой пояс, используемый при интерпретации графика. Значение этого поля должно быть названием часового пояса из базы данных tz. | |||
Авторы
- 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_cloudscheduler_job_info_module.html
