Now Reading: Configure environment variables for instances | Cloud Run | Google Cloud Documentation
- 01
Configure environment variables for instances | Cloud Run | Google Cloud Documentation
Configure environment variables for instances | Cloud Run | Google Cloud Documentation
This page describes how to configure environment variables for your Cloud Run
instance.
Required roles
To get the permissions that
you need to configure and deploy Cloud Run instances,
ask your administrator to grant you the
following IAM roles:
For a list of IAM roles and permissions that are associated with
Cloud Run, see
Cloud Run IAM roles
and Cloud Run IAM permissions.
If your Cloud Run instance interfaces with
Google Cloud APIs, such as Cloud Client Libraries, see the
service identity configuration guide.
For more information about granting roles, see
deployment permissions
and manage access.
Set environment variables
You can set environment variables for a Cloud Run instance using the
Google Cloud CLI or YAML:
gcloud
To specify environment variables while creating your instance, use the
--set-env-vars flag:
gcloud beta run instances create INSTANCE --image IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2
Replace the following:
- INSTANCE: the name of your instance
IMAGE_URL: a reference to the container
image, such asus-docker.pkg.dev/cloudrun/container/hello:latest.- KEY1=VALUE1,KEY2=VALUE2: the comma-separated list of variable
names and values
For more information on how to set multiple environment variables or escape
special characters, see Set multiple environment variables.
YAML
If you are creating a new instance, skip this step.
If you are updating an existing instance, download its YAML configuration:gcloud beta run instances describe INSTANCE --format export > instance.yaml
The following example contains the YAML configuration:
apiVersion: run.googleapis.com/v1 kind: Instance metadata: name: INSTANCE annotations: run.googleapis.com/launch-stage: BETA spec: containers: - env: - name: KEY value: VALUE - name: KEY2 value: VALUE2 image: IMAGE
Replace the following:
- INSTANCE: the name of your Cloud Run instance.
- KEY and VALUE: the name and values of the environment
variables. IMAGE_URL: a reference to the container
image, such asus-docker.pkg.dev/cloudrun/container/hello:latest.
Create or update the instance using the following command:
gcloud beta run instances replace instance.yaml
Set default environment variables in the container
You can use the ENV
statement in a Dockerfile to set default values for environment variables:
ENV KEY1=VALUE1,KEY2=VALUE2
Order of precedence: container versus instance variables
If you set a default environment variable in the container and also
set an environment variable with the same name on the
Cloud Run instance, the value set on the instance takes
precedence.
Set multiple environment variables
You can set multiple environment variables by using the .env file or the
--set-env-vars flag.
Set multiple environment variables using the .env file
gcloud
To specify multiple environment variables from the .env file, run the following
command:
gcloud beta run instances create INSTANCE --image IMAGE_URL --env-vars-file=ENV_FILE_PATH
Replace the following:
- INSTANCE: the name of the instance.
IMAGE_URL: a reference to the container
image, such asus-docker.pkg.dev/cloudrun/container/hello:latest.- ENV_FILE_PATH: path to the
.envfile.
Set multiple environment variables using the --set-env-vars flag
If you have multiple environment variables that cannot be listed in KEY1=VALUE1,KEY2=VALUE2
format, you can repeat the --set-env-vars flag multiple times:
[...] --set-env-vars "KEY1=VALUE1" \ --set-env-vars "KEY2=VALUE2" \ --set-env-vars "KEY3=VALUE3"
Escape comma characters
Because the comma character , is used to split environment variables, if your
environment variable contains comma characters as values, you need to
escape those delimiters by specifying a different
delimiter character, for example, @:
--set-env-vars "^@^KEY1=value1,value2,value3@KEY2=..."
Update environment variables
You can update runtime environment variables for existing instances. This is a
non-destructive approach that changes or adds runtime environment variables,
but doesn’t delete them.
You can update environment variables using the Google Cloud CLI or
YAML:
gcloud
To update environment variables of an existing instance, use the
--update-env-vars
flag:
gcloud beta run instances update INSTANCE --update-env-vars KEY1=VALUE1,KEY2=VALUE2
Replace the following:
- INSTANCE: the name of your instance
- KEY1=VALUE1,KEY2=VALUE2: the comma-separated list of variable
names and values
YAML
Download the instance YAML configuration:
gcloud beta run instances describe INSTANCE --format export > instance.yaml
Edit the key (name) and value variables.
Update the instance using the following command:
gcloud beta run instances replace instance.yaml
Delete environment variables
gcloud
To selectively remove environment variables from an existing instance, use
the --remove-env-vars
flag:
gcloud beta run instances update INSTANCE --remove-env-vars KEY1,KEY2
Replace the following:
- INSTANCE: the name of your instance
- KEY1,KEY2: the comma-separated list of variable names
Alternatively, clear all previously set environment variables
with the --clear-env-vars
flag:
gcloud beta run instances update INSTANCE --clear-env-vars
Replace INSTANCE with the name of your instance.
Sample code
For a code sample that shows how to access environment variables in your code,
refer to Handling sensitive configuration with Secret Manager
in the end user authentication tutorial.
What’s next
You can use environment variables to set a buildpacks
configuration. For language-specific details, see the buildpacks documentation
for:
