Deploy a Cloud Run function (1st gen)

This guide shows you how to deploy a legacy 1st gen Cloud Run function from source code. If you are creating a new function, see the Console Quickstart on Cloud Run.

The deployment process takes your source code and configuration settings and builds a runnable image that Cloud Run functions manages automatically in order to handle requests to your function.

Deployment basics

Users deploying Cloud Run functions must have the Cloud Run functions Developer IAM role or a role that includes the same permissions. See also Additional configuration for deployment.

Deploy a function using the gcloud CLI as follows:

  1. Use the gcloud functions deploy command to deploy a function:

    gcloud functions deploy YOUR_FUNCTION_NAME \
  [--gen2] \
  --region=YOUR_REGION \
  --runtime=YOUR_RUNTIME \
  --source=YOUR_SOURCE_LOCATION \
  --entry-point=YOUR_CODE_ENTRYPOINT \
  TRIGGER_FLAGS

    The first argument, YOUR_FUNCTION_NAME, is a name for your deployed function. The function name must start with a letter followed by up to 62 letters, numbers, hyphens, or underscores, and must end with a letter or a number.

    • The --gen2 flag specifies that you want to deploy to Cloud Run functions. As of September 2024, this becomes the default. To deploy to 1st gen, use --no-gen2.

    • The --region flag specifies the region in which to deploy your function. See Locations for a list of regions supported by Cloud Run functions.

    • The --runtime flag specifies which language runtime your function uses. Cloud Run functions supports several runtimes - see Runtimes for more information.

    • The --source flag specifies the location of your function source code. See the following sections for details:

    • The --entry-point flag specifies the entry point to your function in your source code. This is the code that will be executed when your function runs. The value of this flag must be a function name or fully-qualified class name that exists in your source code. See Function entry point for more information.

    • To specify the trigger for your function, additional flags (represented as TRIGGER_FLAGS above) are required, depending on the trigger you want to use:

      Trigger flags Trigger description
      --trigger-http Trigger the function with an HTTP(S) request. See HTTP triggers for more information.
      --trigger-topic=YOUR_PUBSUB_TOPIC Trigger the function when a message is published to the specified Pub/Sub topic. See Pub/Sub triggers for more information.
      --trigger-bucket=YOUR_STORAGE_BUCKET Trigger the function when an object is created or overwritten in the specified Cloud Storage bucket. See Cloud Storage triggers for more information.
      --trigger-event=EVENT_TYPE
      [--trigger-resource=RESOURCE]       		Trigger the function when the specified event occurs. Specifying a resource is required for some event types. See Triggers supported in Cloud Run functions (1st gen) for more information.

      You can optionally specify additional configuration, networking, and security options when you deploy a function.

      For a complete reference on the deployment command and its flags, see the gcloud functions deploy documentation.

      For some example deployment commands, see Command-line examples.

Deploy from your local machine

This section describes how to use gcloud CLI to deploy a function from source code located on your local machine.

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Follow the deployment instructions above using the gcloud functions deploy command.

    For the --source flag, specify a local file system path to the root directory of the function source code - see Source directory structure. The current working directory is used if this flag is omitted.

    You can also optionally use the --stage-bucket flag to specify a Cloud Storage bucket to upload your source code to as part of deployment.

    During upload of your source code, Cloud Run functions excludes unnecessary files through the .gcloudignore file.

Deploy from Cloud Storage

This section describes how to use gcloud CLI to deploy a function from source code located in a Cloud Storage bucket. The source code must be packaged as a ZIP file.

For Cloud Run functions to read from a Cloud Storage bucket, you must grant the storage.objects.get permission to the account performing the deployment.

See Use IAM permissions in the Cloud Storage documentation for information about controlling access to buckets.

With this permission you can now deploy a function from Cloud Storage:

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Follow the deployment instructions above using the gcloud functions deploy command.

    For the --source flag, specify a Cloud Storage path, starting with gs://. The object at the path must be a ZIP file containing the function source code. Your function source files must be located at the root of the ZIP file - see Source directory structure.

Command-line examples

This section shows deployment commands for some example deployment scenarios.

For details about different triggers supported by Cloud Run functions, see Cloud Run functions triggers.

HTTP function from local source code

Suppose you have an HTTP function as follows:

  • The function uses Node.js 20.
  • The source code is located in the current working directory (.).
  • The entry point in the code is named myHttpFunction.

To deploy the function to Cloud Run functions with the name my-http-function in the region us-central1, you use the following command:

gcloud functions deploy my-http-function \
  --no-gen2 \
  --region=us-central1 \
  --runtime=nodejs20 \
  --source=. \
  --entry-point=myHttpFunction \
  --trigger-http

Pub/Sub function from source code in Cloud Storage

Suppose you have an event-driven function as follows:

  • The function handles Pub/Sub message publish events.
  • The function uses Python 3.12.
  • The source code is located in Cloud Storage at the path gs://my-bucket/my_function_source.zip.
  • The entry point in the code is named pubsub_handler.

To deploy the function to Cloud Run functions with the name my-pubsub-function in the region europe-west1, and have the function triggered by messages on the Pub/Sub topic my-topic, you use the following command:

gcloud functions deploy my-pubsub-function \
  --no-gen2 \
  --region=europe-west1 \
  --runtime=python312 \
  --source=gs://my-bucket/my_function_source.zip \
  --entry-point=pubsub_handler \
  --trigger-topic=my-topic

Cloud Storage function from local source code

Suppose you have an event-driven function as follows:

  • The function handles Cloud Storage object deletion events.
  • The function uses Java 17.
  • The source code is located locally at the path ./functions/storage-function.
  • The entry point in the code is named myproject.StorageFunction.

To deploy the function to Cloud Run functions with the name my-storage-function in the region asia-northeast1, and have the function triggered by events in the Cloud Storage bucket my-bucket, you use the following command:

gcloud functions deploy my-storage-function \
  --no-gen2 \
  --region=asia-northeast1 \
  --runtime=java17 \
  --source=./functions/storage-function \
  --entry-point=myproject.StorageFunction \
  --trigger-resource=gs://my-bucket \
  --trigger-event=google.storage.object.delete

Next steps