Console
    Contact Us Start free

    Configure environment variables (1st gen)

    You can deploy arbitrary key/value pairs alongside a Cloud Run function. These pairs are made available to your function either as literal environment variables , accessible by your code at runtime, or as configuration information for Google Cloud's buildpacks .

    Environment variables are bound to a single function and are not visible to other functions in your Google Cloud project. Each variable is stored in the Cloud Run functions backend and exist within the same lifecycle as the function to which they are bound.

    You can add or remove runtime environment variables using either the Google Cloud CLI or the Google Cloud console.

    Setting runtime environment variables

    Use these methods to establish new variables or completely replace existing variables. To make additive changes, use the update process described in the next section.

    gcloud

    To set a runtime environment variable using the Google Cloud CLI, use the --set-env-vars flag at deploy time:

    gcloud  
functions  
deploy  
--no-gen2  
 FUNCTION_NAME 
  
--set-env-vars  
 FOO 
 = 
bar  
 FLAGS 
  
...

    You can also set multiple runtime environment variables using a comma separated list:

    gcloud  
functions  
deploy  
--no-gen2  
 FUNCTION_NAME 
  
--set-env-vars  
 FOO 
 = 
bar,BAZ = 
boo  
 FLAGS 
...

    If you want to store your configuration in a file (e.g. under source control), you can use a YAML file together with the --env-vars-file flag:

    gcloud  
functions  
deploy  
--no-gen2  
 FUNCTION_NAME 
  
--env-vars-file  
.env.yaml  
 FLAGS 
...

    where the contents of the .env.yaml file are:

     FOO: bar
 BAZ: boo

    In the above examples, FLAGS ... refers to other options that you pass during deployment of your function. For a complete reference for the deploy command, see gcloud functions deploy .

    Google Cloud console UI

    You can set runtime environment variables during function creation in the Google Cloud console:

    1. Open the Functions Overview page in the Google Cloud console:

      Go to the Cloud Run functions Overview page .

    2. Click Create function.

    3. Fill in the required fields for your function.

    4. Open the Runtime, build and connections settingssection.

    5. Select the Runtimetab.

    6. In the Runtime environment variablessection, click Add variableand add the name and value.

      For instructions on how to add environment variables to an existing function, see Updating runtime environment variables .

    Updating runtime environment variables

    You can also update runtime environment variables for existing functions. This is a non-destructive approach that changes or adds runtime environment variables, but does not delete.

    gcloud

    To update a variable using the Google Cloud CLI, use the --update-env-vars flag at deploy time:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--update-env-vars  
 FOO 
 = 
bar

    You can also update multiple runtime environment variables using a comma separated list:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--update-env-vars  
 FOO 
 = 
bar,BAZ = 
boo

    Google Cloud console UI

    To update runtime environment variables using the Google Cloud console:

    1. Open the Functions Overview page in the Google Cloud console:

      Go to the Cloud Run functions Overview page .

    2. Click an existing function to go to its details page.

    3. Click Edit.

    4. Open the Runtime, build and connections settingssection.

    5. Select the Runtimetab.

    6. Make your edits in the Runtime environment variablessection.

    Deleting runtime environment variables

    gcloud

    If you want to selectively remove runtime environment variables you can use the --remove-env-vars flag at deploy time:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--remove-env-vars  
FOO,BAZ

    Alternatively, you can clear all previously set runtime environment variables with the --clear-env-vars flag:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--clear-env-vars

    Google Cloud console UI

    To delete runtime environment variables using the Google Cloud console:

    1. Open the Functions Overview page in the Google Cloud console:

      Go to the Cloud Run functions Overview page .

    2. Click an existing function to go to its details page.

    3. Click Edit.

    4. Open the Runtime, build and connections settingssection.

    5. Select the Runtimetab.

    6. In the Runtime environment variablessection, click the garbage icon next to the key/value pair to delete it.

    Runtime environment variables set automatically

    This section lists runtime environment variables that are set automatically.

    Key Description
    FUNCTION_TARGET Reserved: The function to be executed.
    FUNCTION_SIGNATURE_TYPE Reserved: The type of the function: http for HTTP functions, and event for event-driven functions.
    K_SERVICE Reserved: The name of the function resource.
    K_REVISION Reserved: The version identifier of the function.
    PORT Reserved: The port over which the function is invoked. 
      gcloud 
  
 functions 
  
 deploy 
  
 envVarMemory 
  
\ -- 
 no 
 - 
 gen2 
  
\ -- 
 runtime 
  
 nodejs10 
  
\ -- 
 set 
 - 
 env 
 - 
 vars 
  
 FUNCTION_MEMORY_MB 
 = 
 2 
 Gi 
  
\ -- 
 memory 
  
 2 
 Gi 
  
\ -- 
 trigger 
 - 
 http

    Setting and retrieving runtime environment variables: an example

    Set the runtime environment variable:

    Node.js

    gcloud functions deploy envVar \
--runtime nodejs20 \
--set-env-vars FOO=bar \
--trigger-http

    Use the --runtime flag to specify the runtime ID of a supported Node.js version to run your function.

    Python

    gcloud functions deploy env_vars \
--runtime python312 \
--set-env-vars FOO=bar \
--trigger-http

    Use the --runtime flag to specify the runtime ID of a supported Python version to run your function.

    Go

    gcloud functions deploy EnvVar \
--runtime go121 \
--set-env-vars FOO=bar \
--trigger-http

    Use the --runtime flag to specify the runtime ID of a supported Go version to run your function.

    Java

    gcloud functions deploy java-envVar-function \
--entry-point functions.EnvVars \
--runtime java17 \
--memory 512MB \
--set-env-vars FOO=bar \
--trigger-http

    Use the --runtime flag to specify the runtime ID of a supported Java version to run your function.

    C#

    gcloud functions deploy csharp-envVar-function \
--entry-point EnvironmentVariables.Function \
--runtime dotnet6 \
--set-env-vars FOO=bar \
--trigger-http

    Use the --runtime flag to specify the runtime ID of a supported .NET version to run your function.

    Ruby

    gcloud  
functions  
deploy  
env_vars  
--runtime  
ruby33  
 \ 
--set-env-vars  
 FOO 
 = 
bar  
 \ 
--trigger-http

    Use the --runtime flag to specify the runtime ID of a supported Ruby version to run your function.

    PHP

      
gcloud  
functions  
deploy  
envVar  
--runtime  
php82  
 \ 
--set-env-vars  
 FOO 
 = 
bar  
 \ 
--trigger-http

    Use the --runtime flag to specify the runtime ID of a supported PHP version to run your function.

    At runtime access the variables programmatically:

    Node.js

    In Node.js use the process.env property to access runtime environment variables:

      exports 
 . 
 envVar 
  
 = 
  
 ( 
 req 
 , 
  
 res 
 ) 
  
 = 
>  
 { 
  
 // Sends 'bar' as response 
  
 res 
 . 
 send 
 ( 
 process 
 . 
 env 
 . 
 FOO 
 ); 
 };

    Python

    In Python use os.environ to access runtime environment variables:

      import 
  
 os 
 def 
  
 env_vars 
 ( 
 request 
 ): 
 return 
 os 
 . 
 environ 
 . 
 get 
 ( 
 "FOO" 
 , 
 "Specified environment variable is not set." 
 )

    Go

    In Go use os.Getenv() to access runtime environment variables:

      // Package tips contains tips for writing Cloud Functions in Go. 
 package 
  
 tips 
 import 
  
 ( 
  
 "fmt" 
  
 "net/http" 
  
 "os" 
 ) 
 // EnvVar is an example of getting an environment variable in a Go function. 
 func 
  
 EnvVar 
 ( 
 w 
  
 http 
 . 
 ResponseWriter 
 , 
  
 r 
  
 * 
 http 
 . 
 Request 
 ) 
  
 { 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "FOO: %q" 
 , 
  
 os 
 . 
 Getenv 
 ( 
 "FOO" 
 )) 
 }

    Java

    In Java use System.getenv to access runtime environment variables:

      import 
  
 com.google.cloud.functions.HttpFunction 
 ; 
 import 
  
 com.google.cloud.functions.HttpRequest 
 ; 
 import 
  
 com.google.cloud.functions.HttpResponse 
 ; 
 import 
  
 java.io.BufferedWriter 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 EnvVars 
  
 implements 
  
 HttpFunction 
  
 { 
  
 // Returns the environment variable "foo" set during function deployment. 
  
 @Override 
  
 public 
  
 void 
  
 service 
 ( 
 HttpRequest 
  
 request 
 , 
  
 HttpResponse 
  
 response 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 BufferedWriter 
  
 writer 
  
 = 
  
 response 
 . 
 getWriter 
 (); 
  
 String 
  
 foo 
  
 = 
  
 System 
 . 
 getenv 
 ( 
 "FOO" 
 ); 
  
 if 
  
 ( 
 foo 
  
 == 
  
 null 
 ) 
  
 { 
  
 foo 
  
 = 
  
 "Specified environment variable is not set." 
 ; 
  
 } 
  
 writer 
 . 
 write 
 ( 
 foo 
 ); 
  
 } 
 }

    C#

    At runtime, environment variables are accessible using Environment.GetEnvironmentVariable in C#: 
     using 
  
 Google.Cloud.Functions.Framework 
 ; 
 using 
  
 Microsoft.AspNetCore.Http 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Threading.Tasks 
 ; 
 namespace 
  
 EnvironmentVariables 
 ; 
 public 
  
 class 
  
 Function 
  
 : 
  
 IHttpFunction 
 { 
  
 public 
  
 async 
  
 Task 
  
 HandleAsync 
 ( 
 HttpContext 
  
 context 
 ) 
  
 { 
  
 string 
  
 foo 
  
 = 
  
 Environment 
 . 
 GetEnvironmentVariable 
 ( 
 "FOO" 
 ) 
  
 ?? 
  
 "Specified environment variable is not set." 
 ; 
  
 await 
  
 context 
 . 
 Response 
 . 
 WriteAsync 
 ( 
 foo 
 , 
  
 context 
 . 
 RequestAborted 
 ); 
  
 } 
 }

    Ruby

    At runtime, environment variables are accessible using ENV in Ruby: 
      require 
  
 "functions_framework" 
 FunctionsFramework 
 . 
 http 
  
 "env_vars" 
  
 do 
  
 | 
 _request 
 | 
  
 ENV 
 [ 
 "FOO" 
 ] 
  
 || 
  
 "Specified environment variable is not set." 
 end

    PHP

    At runtime, environment variables are accessible using PHP's getenv function: 
     use Psr\Http\Message\ServerRequestInterface; 
 function envVar(ServerRequestInterface $request): string 
 { 
 return getenv('FOO') . PHP_EOL; 
 }

    Using build environment variables

    You can also set build environment variables for runtimes that support buildpacks .

    Build environment variables are key/value pairs deployed alongside a function that let you pass configuration information to buildpacks. For example, you might want to customize compiler options. You can add or remove these build environment variables using either the Google Cloud CLI or the Google Cloud console UI.

    Setting build environment variables

    Use these methods to establish new variables or completely replace existing variables. To make additive changes, use the update process (the --update-build-env-vars flag in gcloud ) described in the next section.

    gcloud

    To set a variable using the Google Cloud CLI, use the --set-build-env-vars flag at deploy time:

    gcloud  
beta  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--set-build-env-vars  
 FOO 
 = 
bar  
 FLAGS 
...

    You can also set multiple build environment variables using a comma separated list:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--set-build-env-vars  
 FOO 
 = 
bar,BAZ = 
boo  
 FLAGS 
...

    If you want to store your configuration in a file (e.g. under source control), you can use a YAML file together with the --build-env-vars-file flag:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--build-env-vars-file  
 FILE_NAME 
.yaml  
 FLAGS 
...

    where the contents of the *.yaml file are:

     FOO: bar
 BAZ: boo

    In the above examples, FLAGS ... refers to other options that you pass during deployment of your function. For a complete reference for the deploy command, see gcloud beta functions deploy .

    Google Cloud console UI

    You can also set build environment variables during function creation in the Google Cloud console:

    1. Open the Functions Overview page in the Google Cloud console:

      Go to the Cloud Run functions Overview page .

    2. Click Create function.

    3. Fill in the required fields for your function.

    4. Open the Runtime, build and connections settingssection.

    5. Select the Buildtab.

    6. In the Build environment variablessection, click Add variableand add the name and value.

    Updating build environment variables

    You can also update build environment variables for existing functions. This is a non-destructive approach that changes or adds build environment variables, but does not delete.

    gcloud

    To set a variable using the Google Cloud CLI, use the --update-build-env-vars flag at deploy time:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--update-build-env-vars  
 FOO 
 = 
bar

    You can also update multiple build environment variables using a comma separated list:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--update-build-env-vars  
 FOO 
 = 
bar,BAZ = 
boo

    Google Cloud console UI

    To update build environment variables using the Google Cloud console:

    1. Open the Functions Overview page in the Google Cloud console:

      Go to the Cloud Run functions Overview page .

    2. Click an existing function to go to its details page.

    3. Click Edit.

    4. Open the Runtime, build and connections settingssection.

    5. Select the Buildtab.

    6. Make your edits in the Build environment variablessection.

    Deleting build environment variables

    gcloud

    If you want to selectively remove build environment variables you can use the --remove-build-env-vars flag at deploy time:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--remove-build-env-vars  
FOO,BAZ

    Alternatively, you can clear all previously set build environment variables with the --clear-build-env-vars flag:

    gcloud  
functions  
deploy  
 FUNCTION_NAME 
  
--no-gen2  
--clear-build-env-vars

    Google Cloud console UI

    To delete build environment variables using the Google Cloud console:

    1. Open the Functions Overview page in the Google Cloud console:

      Go to the Cloud Run functions Overview page .

    2. Click an existing function to go to its details page.

    3. Click Edit.

    4. Open the Runtime, build and connections settingssection.

    5. Select the Buildtab.

    6. In the Build environment variablessection, click the garbage icon next to the key/value pair to delete it.

    Variable lifecycle

    All environment variables are bound to a deployment of a Cloud Run function, and can only be set or changed with a deployment. If a deployment fails for any reason, any changes to environment variables will not be applied. Environment variable changes require a successful deployment.

    Best practices and reserved environment variables

    Some additional environment variables are automatically set depending on the runtime your function uses. These are based on the runtime's operating system (for example, DEBIAN_FRONTEND , SHLVL , or PATH ) and the language runtime (for example, NODE_ENV , VIRTUAL_ENV , or GOPATH ).

    Environment variables that are provided by the environment (other than the ones listed in Environment variables set automatically ) might change in future runtime versions. As a best practice, we recommend that you do not depend on or modify any environment variables that you have not set explicitly.

    Modifying environment variables that are provided by the environment might lead to unpredictable outcomes. Attempts to modify such environment variables could be blocked or, worse, lead to unintended consequences such as functions that cannot start. As a best practice, consider prefixing any environment variables with a unique key to avoid conflicts.

    Finally, you cannot use the following environment variables:

    Key Description
    Empty ('') Keys cannot be an empty string.
    = Keys cannot contain the '=' character.
    X_GOOGLE_ Keys cannot contain the prefix X_GOOGLE_ .

    Size limits

    The total number of bytes used by runtime environment variable names and values for an individual function is limited to 32KiB. There are no specific limits on individual keys or values within this overall capacity.

    For build environment variables, up to 100 variables can be defined, with the definition string foo=bar limited to 64KiB.

    Managing secrets

    Environment variables can be used for function configuration, but are not recommended as a way to store secrets such as database credentials or API keys. These more sensitive values should be stored outside both your source code and outside environment variables. Some execution environments or the use of some frameworks can result in the contents of environment variables being sent to logs, and storing sensitive credentials in YAML files, deployment scripts or under source control is not recommended.

    For storing secrets, we recommend that you use Secret Manager. To configure Cloud Run functions to access secrets stored in Secret Manager, see Configure secrets . Note that there is no Cloud Run functions-specific integration with Cloud KMS.

    Portability

    It is possible that environment variables that currently work with your Cloud Run function won't work with a different runtime environment, such as in a different language or with certain tools or libraries. It is also possible that they will not be accepted by a different platform.

    You can avoid such issues by following the POSIX standard for environment variables . If you use the Google Cloud console to edit variables, Google Cloud console will warn you whenever you define a variable that might have portability issues (but will not prevent deployment). As a general rule, we recommend that environment variable keys consist solely of uppercase letters, digits, and <underscore> ( _ ), as defined in the Portable Character Set , and that they do not begin with a digit.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: