google.cloud.gcp_cloudscheduler_job module – Creates a GCP Job
Note
This module is part of the google.cloud collection (version 1.4.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install google.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: google.cloud.gcp_cloudscheduler_job
.
Synopsis
A scheduled job that can publish a pubsub message or a http request every X interval of time, using crontab format string.
To use Cloud Scheduler your project must contain an App Engine app that is located in one of the supported regions. If your project does not have an App Engine app, you must create one.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
Parameters
Parameter |
Comments |
---|---|
An OAuth2 access token if credential type is accesstoken. |
|
App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance . |
|
App Engine Routing setting for the job. |
|
App instance. By default, the job is sent to an instance which is available when the job is attempted. |
|
App service. By default, the job is sent to the service which is the default service when the job is attempted. |
|
App version. By default, the job is sent to the version which is the default version when the job is attempted. |
|
HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. A base64-encoded string. |
|
HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. |
|
Which HTTP method to use for the request. |
|
The relative URI. |
|
The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff. A duration in seconds with up to nine fractional digits, terminated by ‘s’. Example: “3.5s” . Default: |
|
The type of credential used. Choices:
|
|
A human-readable description for the job. This string must not contain more than 500 characters. |
|
Specifies which Ansible environment you’re running this module within. This should not be set unless you know what you’re doing. This only alters the User Agent string for any API requests. |
|
HTTP target. If the job providers a http_target the cron will send a request to the targeted url . |
|
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. A base64-encoded string. |
|
This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. |
|
Which HTTP method to use for the request. |
|
Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. |
|
OAuth scope to be used for generating OAuth access token. If not specified, “https://www.googleapis.com/auth/cloud-platform” will be used. |
|
Service account email to be used for generating OAuth token. The service account must be within the same project as the job. |
|
Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. |
|
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. |
|
Service account email to be used for generating OAuth token. The service account must be within the same project as the job. |
|
The full URI path that the request will be sent to. |
|
The name of the job. |
|
The Google Cloud Platform project to use. |
|
Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic . |
|
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. |
|
The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. A base64-encoded string. |
|
The full resource name for the Cloud Pub/Sub topic to which messages will be published when a job is delivered. ~>**NOTE:** The topic name must be in the same format as required by PubSub’s PublishRequest.name, e.g. `projects/my-project/topics/my-topic`. |
|
Region where the scheduler job resides . |
|
By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings . |
|
The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ‘s’. |
|
The time between retries will double maxDoublings times. A job’s retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times. |
|
The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by ‘s’. |
|
The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ‘s’. |
|
The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed. |
|
Describes the schedule on which the job will be executed. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
Whether the given object should exist in GCP Choices:
|
|
Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. Default: |
Notes
Note
API Reference: https://cloud.google.com/scheduler/docs/reference/rest/
Official Documentation: https://cloud.google.com/scheduler/
for authentication, you can set service_account_file using the
GCP_SERVICE_ACCOUNT_FILE
env variable.for authentication, you can set service_account_contents using the
GCP_SERVICE_ACCOUNT_CONTENTS
env variable.For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAIL
env variable.For authentication, you can set access_token using the
GCP_ACCESS_TOKEN
env variable.For authentication, you can set auth_kind using the
GCP_AUTH_KIND
env variable.For authentication, you can set scopes using the
GCP_SCOPES
env variable.Environment variables values will only be used if the playbook values are not set.
The service_account_email and service_account_file options are mutually exclusive.
Examples
- name: create a job
google.cloud.gcp_cloudscheduler_job:
name: job
region: us-central1
schedule: "*/4 * * * *"
description: test app engine job
time_zone: Europe/London
attempt_deadline: 320s
app_engine_http_target:
http_method: POST
app_engine_routing:
service: web
version: prod
instance: my-instance-001
relative_uri: "/ping"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance . Returned: success |
|
App Engine Routing setting for the job. Returned: success |
|
App instance. By default, the job is sent to an instance which is available when the job is attempted. Returned: success |
|
App service. By default, the job is sent to the service which is the default service when the job is attempted. Returned: success |
|
App version. By default, the job is sent to the version which is the default version when the job is attempted. Returned: success |
|
HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. A base64-encoded string. Returned: success |
|
HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Returned: success |
|
Which HTTP method to use for the request. Returned: success |
|
The relative URI. Returned: success |
|
The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff. A duration in seconds with up to nine fractional digits, terminated by ‘s’. Example: “3.5s” . Returned: success |
|
A human-readable description for the job. This string must not contain more than 500 characters. Returned: success |
|
HTTP target. If the job providers a http_target the cron will send a request to the targeted url . Returned: success |
|
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. A base64-encoded string. Returned: success |
|
This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. Returned: success |
|
Which HTTP method to use for the request. Returned: success |
|
Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Returned: success |
|
OAuth scope to be used for generating OAuth access token. If not specified, “https://www.googleapis.com/auth/cloud-platform” will be used. Returned: success |
|
Service account email to be used for generating OAuth token. The service account must be within the same project as the job. Returned: success |
|
Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Returned: success |
|
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. Returned: success |
|
Service account email to be used for generating OAuth token. The service account must be within the same project as the job. Returned: success |
|
The full URI path that the request will be sent to. Returned: success |
|
The name of the job. Returned: success |
|
Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic . Returned: success |
|
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. Returned: success |
|
The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. A base64-encoded string. Returned: success |
|
The full resource name for the Cloud Pub/Sub topic to which messages will be published when a job is delivered. ~>**NOTE:** The topic name must be in the same format as required by PubSub’s PublishRequest.name, e.g. `projects/my-project/topics/my-topic`. Returned: success |
|
Region where the scheduler job resides . Returned: success |
|
By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings . Returned: success |
|
The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ‘s’. Returned: success |
|
The time between retries will double maxDoublings times. A job’s retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times. Returned: success |
|
The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by ‘s’. Returned: success |
|
The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ‘s’. Returned: success |
|
The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed. Returned: success |
|
Describes the schedule on which the job will be executed. Returned: success |
|
Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. Returned: success |