Schedule an HTTP Cloud Run function

---

Preview — Cloud Run functions

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

This tutorial shows how to schedule an HTTP Cloud Run function by targeting an HTTP endpoint in Cloud Scheduler. Use an HTTP function when you need your function to have a URL endpoint and respond to HTTP requests, such as for webhooks.

Alternatively, if you created a CloudEvents function, use Eventarc event triggers to schedule your function to respond to events within your project. Eventarc can trigger messages on a Pub/Sub topic, changes in a Cloud Storage bucket, and more. For more information, see Types of Cloud Run functions.

Scheduling the execution of a Cloud Run function is a common use case for Cloud Scheduler. In this tutorial, you will:

1. Create a simple HTTP Cloud Run function.
2. Create a Cloud Scheduler job.
3. Run the Cloud Scheduler job.
4. Verify that the Cloud Scheduler job triggers your Cloud Run function.

Costs

In this document, you use the following billable components of Google Cloud:

• Cloud Run
• Cloud Scheduler

To generate a cost estimate based on your projected usage, use the pricing calculator. New Google Cloud users might be eligible for a free trial.

Before you begin

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Build, Cloud Functions, Cloud Run Admin, Cloud Scheduler APIs.

   Enable the APIs

5. Create a service account:

   1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
   2. Select your project.

   3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

   4. Click Create and continue.

   5. Grant the following roles to the service account: Cloud Run > Cloud Run Invoker, Cloud Run > Cloud Run Builder.

      To grant a role, find the Select a role list, then select the role.

      To grant additional roles, click Add another role and add each additional role.

      Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.
   6. Click Continue.

   7. Click Done to finish creating the service account.

6. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

7. Make sure that billing is enabled for your Google Cloud project.

8. Enable the Cloud Build, Cloud Functions, Cloud Run Admin, Cloud Scheduler APIs.

   Enable the APIs

9. Create a service account:

   1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
   2. Select your project.

   3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

   4. Click Create and continue.

   5. Grant the following roles to the service account: Cloud Run > Cloud Run Invoker, Cloud Run > Cloud Run Builder.

      To grant a role, find the Select a role list, then select the role.

      To grant additional roles, click Add another role and add each additional role.

      Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.
   6. Click Continue.

   7. Click Done to finish creating the service account.

Note that you must grant the Cloud Run Invoker role because in Cloud Run functions, invocation permissions are available by managing the underlying Cloud Run service.

Create an HTTP Cloud Run function

Create an HTTP function that is triggered by Cloud Scheduler.

1. In the Google Cloud console, go to the Cloud Run page.

   Go to Cloud Run

2. Click Write a function.

3. In the Configure section, do the following:

   1. In the Service name field, enter a name for your function.
   2. In the Region list, select a region.
   3. Don't modify the default runtime language.

   4. For authentication, select Require authentication.

      If you are under a domain restriction organization policy restricting unauthenticated invocations for your project, you will need to access your deployed service as described under Testing private services.

      For more information, see Authenticate for invocation.

4. Accept the other defaults and click Create.

5. Copy the HTTP URL for the function.

Create a Cloud Scheduler job

Create a Cloud Scheduler job that triggers an action using HTTP.

1. In the Google Cloud console, go to the Cloud Scheduler page.

   Go to Cloud Scheduler

2. Click Click Create job.

3. Enter a name for your job.

4. In the Region list, select a region.

5. Specify the frequency for your job, using a unix-cron format:

   30 16 * * 7
   

   For more information, see Cron job format and time zone.

6. In the Timezone list, select a time zone.

7. Click Continue.

8. In the Target type list, select HTTP.

9. In the URL field, enter the function's HTTP URL that you previously copied.

10. In the Auth header list, select Add OIDC token.

11. In the Service account list, select the service account you previously created.

12. In the Audience field, enter the function's HTTP URL that you previously copied.

13. Click Create.

You have created a cron job that runs your Cloud Run function at 16:30 on Sundays.

Run your Cloud Scheduler job

You can now run the job you created.

1. In the Google Cloud console, go to the Cloud Scheduler page.

   Go to Cloud Scheduler

2. Select the checkbox for the job that you created and click Force run.

   When it is initially invoked, the first job created in a project can take a few minutes to configure and run.

3. After the job runs, the Status of last execution should indicate Success.

Verify the results in Cloud Run functions

You can verify that your Cloud Run function is successfully triggered and executed by your cron job.

1. In the Google Cloud console, go to the Cloud Run page.

   Go to Cloud Run

2. Select Filter services > Deployment type > Function. This filters the list of services to only show functions.

3. Click the function name.

   The Service details page opens and displays service metrics.

4. Click the Logs tab.

   You should see a log entry similar to POST 200 146 B 5 ms Google-Cloud-Scheduler https://FUNCTION_NAME

Clean up

To avoid incurring charges to your Google Cloud account for the resources used in this tutorial, either delete the project that contains the resources, or keep the project and delete the individual resources.

Delete project

Caution: Deleting a project has the following effects:

• Everything in the project is deleted. If you used an existing project for the tasks in this document, when you delete it, you also delete any other work you've done in the project.
• Custom project IDs are lost. When you created this project, you might have created a custom project ID that you want to use in the future. To preserve the URLs that use the project ID, such as an appspot.com URL, delete selected resources inside the project instead of deleting the whole project.

If you plan to explore multiple architectures, tutorials, or quickstarts, reusing projects can help you avoid exceeding project quota limits.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Delete tutorial resources

1. In the Google Cloud console, go to the Cloud Scheduler page.

   Go to Cloud Scheduler

2. Select the checkbox next to your job.

3. Click Delete and confirm your deletion.

4. In the Google Cloud console, go to the Cloud Run page.

   Go to Cloud Run

5. Select the checkbox next to your service.

6. Click Delete and confirm your deletion.

7. In the Google Cloud console, go to the Service Accounts page.

   Go to Service Accounts

8. Select the checkbox next to the service account you created.

9. Click Delete and confirm your deletion.

What's next

• Use Cloud Scheduler to trigger Cloud Run on a schedule
• Write CloudEvents functions to schedule your function to respond to events within your project.