Quickstart: Deploy a Cloud Run functionusing the gcloud CLI

This page shows you how to deploy an HTTPCloud Run function using the gcloud CLI.

Before you begin

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.

Install the Google Cloud CLI.

Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

Toinitialize the gcloud CLI, run the following command:

gcloudinit

Create or select 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.

Create a Google Cloud project:
```
gcloud projects createPROJECT_ID
```
ReplacePROJECT_ID with a name for the Google Cloud project you are creating.
Select the Google Cloud project that you created:
```
gcloud config set projectPROJECT_ID
```
ReplacePROJECT_ID with your Google Cloud project name.

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

Enable the Artifact Registry, Cloud Build, Cloud Run Admin API, and Cloud Logging APIs:

gcloudservicesenableartifactregistry.googleapis.com cloudbuild.googleapis.com run.googleapis.com logging.googleapis.com

Grant roles to your user account. Run the following command once for each of the following IAM roles:roles/run.sourceDeveloper, roles/run.admin, roles/resourcemanager.projectIamAdmin, roles/iam.serviceAccountUser, roles/serviceusage.serviceUsageAdmin

gcloudprojectsadd-iam-policy-bindingPROJECT_ID--member="user:USER_IDENTIFIER"--role=ROLE

ReplacePROJECT_ID with your project ID.
ReplaceUSER_IDENTIFIER with the identifier for your user account. For example,user:myemail@example.com.
ReplaceROLE with each individual role.

Install the Google Cloud CLI.

Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

Toinitialize the gcloud CLI, run the following command:

gcloudinit

Create or select a Google Cloud project.

Create a Google Cloud project:
```
gcloud projects createPROJECT_ID
```
ReplacePROJECT_ID with a name for the Google Cloud project you are creating.
Select the Google Cloud project that you created:
```
gcloud config set projectPROJECT_ID
```
ReplacePROJECT_ID with your Google Cloud project name.

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

Enable the Artifact Registry, Cloud Build, Cloud Run Admin API, and Cloud Logging APIs:

gcloudservicesenableartifactregistry.googleapis.com cloudbuild.googleapis.com run.googleapis.com logging.googleapis.com

gcloudprojectsadd-iam-policy-bindingPROJECT_ID--member="user:USER_IDENTIFIER"--role=ROLE

ReplacePROJECT_ID with your project ID.
ReplaceUSER_IDENTIFIER with the identifier for your user account. For example,user:myemail@example.com.
ReplaceROLE with each individual role.

To set the default project for your Cloud Run service:
```
gcloudconfigsetprojectPROJECT_ID
```
ReplacePROJECT_ID with the name of the project you created for this quickstart.
If you are under a domain restriction organization policyrestricting unauthenticated invocations for your project, you will need to access your deployed service as described underTesting private services.
Grant the Cloud Build service account the following IAM role.
Click to view required roles for the Cloud Build service account
Cloud Build automatically uses theCompute Engine default service account as the default Cloud Build service account to build your source code and Cloud Run resource, unless you override this behavior. For Cloud Build to build your sources, ask your administrator to grantCloud Run Builder (roles/run.builder) to the Compute Engine default service account on your project:
gcloudprojectsadd-iam-policy-bindingPROJECT_ID\--member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com\--role=roles/run.builder
ReplacePROJECT_NUMBER with your Google Cloud project number, andPROJECT_ID with your Google Cloud project ID. For detailed instructions on how to find your project ID, and project number, seeCreating and managing projects.
Granting the Cloud Run builder role to the Compute Engine default service account takes a couple of minutes topropagate.
Note:
The iam.automaticIamGrantsForDefaultServiceAccounts organization policy constraint prevents the Editor role from being automatically granted to default service accounts. If you created your organization after May 3, 2024, this constraint is enforced by default.
We strongly recommend that you enforce this constraint to disable the automatic role grant. If you disable the automatic role grant, you must decide which roles to grant to the default service accounts, and thengrant these roles yourself.
If the default service account already has the Editor role, we recommend that you replace the Editor role with less permissive roles.To safely modify the service account's roles, usePolicy Simulator to see the impact of the change, and thengrant and revoke the appropriate roles.

Write the sample function

To write an application, follow these steps:

Node.js

Create a new directory namedhelloworld and change directory into it:
```
   mkdir helloworld   cd helloworld
```

Create apackage.json file in thehelloworld directory to specifyNode.js dependencies:

{"name":"nodejs-docs-samples-functions-hello-world-get","version":"0.0.1","private":true,"license":"Apache-2.0","author":"Google Inc.","repository":{"type":"git","url":"https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"},"engines":{"node":">=16.0.0"},"scripts":{"test":"c8 mocha -p -j 2 test/*.test.js --timeout=6000 --exit"},"dependencies":{"@google-cloud/functions-framework":"^3.1.0"},"devDependencies":{"c8":"^10.0.0","gaxios":"^6.0.0","mocha":"^10.0.0","wait-port":"^1.0.4"}}

Create anindex.js file in thehelloworld directory with the followingNode.js sample:

constfunctions=require('@google-cloud/functions-framework');// Register an HTTP function with the Functions Framework that will be executed// when you make an HTTP request to the deployed function's endpoint.functions.http('helloGET',(req,res)=>{res.send('Hello World!');});

Python

Create a new directory namedhelloworld and change directory into it:
```
   mkdir helloworld   cd helloworld
```
Create arequirements.txt file in thehelloworld directory, to specifyPython dependencies:
```
functions-framework==3.8.2flask==3.0.3google-cloud-error-reporting==1.11.1MarkupSafe==2.1.3
```
This adds packages needed by the sample.

Create amain.py file in thehelloworld directory with the followingPython sample:

importfunctions_framework@functions_framework.httpdefhello_get(request):"""HTTP Cloud Function.    Args:        request (flask.Request): The request object.        <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>    Returns:        The response text, or any set of values that can be turned into a        Response object using `make_response`        <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.    Note:        For more information on how Flask integrates with Cloud        Functions, see the `Writing HTTP functions` page.        <https://cloud.google.com/functions/docs/writing/http#http_frameworks>    """return"Hello World!"

Go

Create a new directory namedhelloworld and change directory into it:
```
   mkdir helloworld   cd helloworld
```

Create ago.mod file to declare thego module:

modulegithub.com/GoogleCloudPlatform/golang-samples/functions/functionsv2/helloworldgo1.23.0requiregithub.com/GoogleCloudPlatform/functions-framework-gov1.8.1require(github.com/cloudevents/sdk-go/v2v2.15.2// indirectgithub.com/google/go-cmpv0.6.0// indirectgithub.com/google/uuidv1.6.0// indirectgithub.com/json-iterator/gov1.1.12// indirectgithub.com/modern-go/concurrentv0.0.0-20180306012644-bacd9c7ef1dd// indirectgithub.com/modern-go/reflect2v1.0.2// indirectgithub.com/stretchr/testifyv1.10.0// indirectgo.uber.org/multierrv1.11.0// indirectgo.uber.org/zapv1.27.0// indirectgolang.org/x/timev0.9.0// indirect)

Create anhello_http.go file in thehelloworld directory with thefollowing Go code sample:

// Package helloworld provides a set of Cloud Functions samples.packagehelloworldimport("fmt""net/http""github.com/GoogleCloudPlatform/functions-framework-go/functions")funcinit(){functions.HTTP("HelloGet",helloGet)}// helloGet is an HTTP Cloud Function.funchelloGet(whttp.ResponseWriter,r*http.Request){fmt.Fprint(w,"Hello, World!")}

Java

Create a new directory namedhelloworld and change directory into it:
```
   mkdir helloworld   cd helloworld
```

Create the following project structure to contain the source directoryand source file:

mkdir -p ~/helloworld/src/main/java/functionstouch ~/helloworld/src/main/java/functions/HelloWorld.java

Update theHelloWorld.java file with the following Java code sample:

packagefunctions;importcom.google.cloud.functions.HttpFunction;importcom.google.cloud.functions.HttpRequest;importcom.google.cloud.functions.HttpResponse;importjava.io.BufferedWriter;importjava.io.IOException;publicclassHelloWorldimplementsHttpFunction{// Simple function to return "Hello World"@Overridepublicvoidservice(HttpRequestrequest,HttpResponseresponse)throwsIOException{BufferedWriterwriter=response.getWriter();writer.write("Hello World!");}}

Create apom.xml file in thehelloworld directory, and add the followingJava dependencies:

<?xmlversion="1.0"encoding="UTF-8"?><!--Copyright2020GoogleLLCLicensedundertheApacheLicense,Version2.0(the"License");youmaynotusethisfileexceptincompliancewiththeLicense.YoumayobtainacopyoftheLicenseathttp://www.apache.org/licenses/LICENSE-2.0Unlessrequiredbyapplicablelaworagreedtoinwriting,softwaredistributedundertheLicenseisdistributedonan"AS IS"BASIS,WITHOUTWARRANTIESORCONDITIONSOFANYKIND,eitherexpressorimplied.SeetheLicenseforthespecificlanguagegoverningpermissionsandlimitationsundertheLicense.--><projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.example.functions</groupId><artifactId>functions-hello-world</artifactId><version>1.0.0-SNAPSHOT</version><parent><groupId>com.google.cloud.samples</groupId><artifactId>shared-configuration</artifactId><version>1.2.0</version></parent><dependencyManagement><dependencies><dependency><artifactId>libraries-bom</artifactId><groupId>com.google.cloud</groupId><scope>import</scope><type>pom</type><version>26.32.0</version></dependency></dependencies></dependencyManagement><properties><maven.compiler.target>11</maven.compiler.target><maven.compiler.source>11</maven.compiler.source></properties><dependencies><!--RequiredforFunctionprimitives--><dependency><groupId>com.google.cloud.functions</groupId><artifactId>functions-framework-api</artifactId><version>1.1.0</version><scope>provided</scope></dependency><!--Thefollowingdependenciesareonlyrequiredfortesting--><dependency><groupId>com.google.truth</groupId><artifactId>truth</artifactId><version>1.4.0</version><scope>test</scope></dependency><dependency><groupId>com.google.guava</groupId><artifactId>guava-testlib</artifactId><scope>test</scope></dependency><dependency><groupId>org.mockito</groupId><artifactId>mockito-core</artifactId><version>5.10.0</version><scope>test</scope></dependency></dependencies><build><plugins><plugin><!--GoogleCloudFunctionsFrameworkMavenpluginThispluginallowsyoutorunCloudFunctionsJavacodelocally.Usethefollowingterminalcommandtorunagivenfunctionlocally:mvnfunction:run-Drun.functionTarget=your.package.yourFunction--><groupId>com.google.cloud.functions</groupId><artifactId>function-maven-plugin</artifactId><version>0.11.0</version><configuration><functionTarget>functions.HelloWorld</functionTarget></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><!--version3.0.0-M4doesnotloadJUnit5correctly--><!--seehttps://issues.apache.org/jira/browse/SUREFIRE-1750 --><version>3.2.5</version><configuration><includes><include>**/*Test.java</include></includes><skipTests>${skipTests}</skipTests><reportNameSuffix>sponge_log</reportNameSuffix><trimStackTrace>false</trimStackTrace></configuration></plugin></plugins></build></project>

Ruby

Create a new directory namedhelloworld and change directory into it:
```
   mkdir helloworld   cd helloworld
```

Create a file namedapp.rb and paste the following code into it:

require"functions_framework"FunctionsFramework.http"hello_get"do|_request|# The request parameter is a Rack::Request object.# See https://www.rubydoc.info/gems/rack/Rack/Request# Return the response body as a string.# You can also return a Rack::Response object, a Rack response array, or# a hash which will be JSON-encoded into a response."Hello World!"end

Create a file namedGemfile and copy the following into it:

source"https://rubygems.org"gem"base64","~> 0.2"gem"functions_framework","~> 1.4"

If you don't have Bundler 2.0 or greater installed, installBundler.
Generate aGemfile.lock file by running:
```
bundle install
```

PHP

Create a new directory namedhelloworld and change directory into it:
```
   mkdir helloworld   cd helloworld
```

Create a file namedindex.php and paste the following code into it:

use Psr\Http\Message\ServerRequestInterface;function helloGet(ServerRequestInterface $request): string{    return 'Hello, World!' . PHP_EOL;}

If you aren't using Cloud Shell, create acomposer.json file andpaste the following code into it:

{    "require": {        "google/cloud-functions-framework": "^1.0"    },    "scripts": {        "start": [           "Composer\\Config::disableProcessTimeout",           "FUNCTION_TARGET=helloGet php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"        ]    }}

.NET

Install.NET SDK.
From the console, create a new empty web project using the dotnetcommand.
```
dotnet new web -o helloworld-csharp
```
Change directory tohelloworld-csharp:

Replace the sample code in the project filehelloworld-csharp.csprojwith the following:

<Project Sdk="Microsoft.NET.Sdk">  <PropertyGroup>    <OutputType>Exe</OutputType>    <TargetFramework>net8.0</TargetFramework>  </PropertyGroup>  <ItemGroup>    <PackageReference Include="Google.Cloud.Functions.Hosting" Version="3.0.1" />  </ItemGroup></Project>

Replace the sample code inProgram.cs file with the following:

using Google.Cloud.Functions.Framework;using Microsoft.AspNetCore.Http;using System.Threading.Tasks;namespace HelloWorld;public class Function : IHttpFunction{    public async Task HandleAsync(HttpContext context)    {        await context.Response.WriteAsync("Hello World!", context.RequestAborted);    }}

Deploy the function

Important: This quickstart assumes that you have owner or editor roles in the project you are using for the quickstart. Otherwise, refer to theCloud Run Source Developer role for the required permissions for deploying a Cloud Run resource from source.

To deploy your Cloud Run function, follow these steps:

Deploy the function by running the following command in the directory thatcontains the sample code: