By default, a Cloud Run service connects to external endpoints on the internet using a dynamic IP address pool. This default is not suitable if the Cloud Run service connects to an external endpoint that requires connections originating from a static IP address, such as a database or API using an IP address-based firewall. For those connections, you must configure your Cloud Run service to route requests through a static IP address.
This guide describes how to enable a Cloud Run service to send requests using a static IP address.
Task overview
To enable a Cloud Run service to route requests through a static IP address, configure the Cloud Run service's VPC egress to route all outbound traffic through a VPC network that has a Cloud NAT gateway configured with the static IP address.
Routing your traffic through Cloud NAT does not cause an additional hop in your networking stack since the Cloud NAT gateway and the Cloud Router provide only a control plane and the packets do not pass through the NAT gateway or the Cloud Router.
Note that all Cloud Run services connected to the same VPC network share the same egress IP address. To use different egress IP addresses for separate Cloud Run services, follow this guide to create separate subnets and, optionally, Serverless VPC Access connectors.
Create a subnet
You must create a dedicated /28
subnet to host a connector. If you're using
Direct VPC egress, use an existing subnet or create another one.
If you use a connector, the dedicated subnet prevents other compute resources in
your VPC, such as Compute Engine VMs or Google Kubernetes Engine
clusters, from accidentally using the static IP, if you have configured
Serverless VPC Access to access the internet.
gcloud
Find the name of your VPC network:
gcloud compute networks list
You should see output like the following:
NAME SUBNET_MODE BGP_ROUTING_MODE default AUTO REGIONAL
Identify the network that you'll attach to your Serverless VPC Access connector.
Create a subnet in the VPC for the Serverless VPC Access connector.
gcloud compute networks subnets create SUBNET_NAME \ --range=RANGE --network=NETWORK_NAME --region=REGION
Replace the following values in this command:
SUBNET_NAME
with a name you want to give to the subnet.RANGE
with the IP range in CIDR format you want to assign to this subnet (e.g.10.124.0.0/28
)NETWORK_NAME
with the name of the VPC network.REGION
with the region in which you want to create a Serverless VPC Access connector.
Terraform
Create the VPC network to use.
Replace
cr-static-ip-network
with the subnet name.Create a subnet in the VPC for the Serverless VPC Access connector.
Replace
cr-static-ip
with your subnet name10.124.0.0/28
with your CIDR rangeus-central1
with your Google Cloud region
Create a Serverless VPC Access connector
You don't need to create a connector if you use Direct VPC egress integration. If you don't use Direct VPC egress, you need a Serverless VPC Access connector to route your Cloud Run service outbound traffic to a VPC network.
To create a Serverless VPC Access connector:
gcloud
Create a Serverless VPC Access connector with a pre-created subnet.
gcloud compute networks vpc-access connectors create CONNECTOR_NAME \ --region=REGION \ --subnet-project=PROJECT_ID \ --subnet=SUBNET_NAME
Replace the following values in this command:
CONNECTOR
with a name you want to give to this resource.PROJECT_ID
with a name that hosts the subnet.SUBNET_NAME
with the name of the subnet you created.REGION
with the region in which you want to create a NAT gateway.
Terraform
Create a Serverless VPC Access connector.
Replace
cr-conn
with the name of your Serverless VPC Access connector
Configure network address translation (NAT)
If you use Direct VPC egress or a Serverless VPC Access connector, requests from your Cloud Run service arrive at your VPC network. If you want to route outbound requests to external endpoints through a static IP, configure a Cloud NAT gateway.
gcloud
Create a new Cloud Router to program a NAT gateway:
gcloud compute routers create ROUTER_NAME \ --network=NETWORK_NAME \ --region=REGION
Replace the following values in this command:
ROUTER_NAME
with a name for the Cloud Router resource you want to create.NETWORK_NAME
with the name of the VPC network you found earlier.REGION
with the region in which you want to create a NAT gateway.
Reserve a static IP address. A reserved IP address resource retains the underlying IP address when the resource it is associated with is deleted and re-created:
gcloud compute addresses create ORIGIN_IP_NAME --region=REGION
Replace the following values in this command:
ORIGIN_IP_NAME
with the name you want to assign to the IP address resource.REGION
with the region that will run the Cloud NAT router. Ideally the same region as your Cloud Run service to minimize latency and network costs.
Create a Cloud NAT gateway configuration on this router to route the traffic originating from the VPC network using the static IP address you created:
gcloud compute routers nats create NAT_NAME \ --router=ROUTER_NAME \ --region=REGION \ --nat-custom-subnet-ip-ranges=SUBNET_NAME \ --nat-external-ip-pool=ORIGIN_IP_NAME
Replace the following values in this command:
NAT_NAME
with a name for the Cloud NAT gateway resource you want to create.ROUTER_NAME
with the name of your Cloud Router.REGION
with the region in which you want to create a NAT gateway.ORIGIN_IP_NAME
with the name of the reserved IP address resource you created in the previous step.
Terraform
Create a new Cloud Router to program a NAT gateway:
Replace
cr-static-ip-router
with your subnet name.Reserve a static IP address. A reserved IP address resource retains the underlying IP address when the resource it is associated with is deleted and recreated:
Replace
cr-static-ip-addr
with your subnet name.Create a Cloud NAT gateway configuration on this router to route the traffic originating from the VPC network using the static IP address you created:
Replace
cr-static-nat
with your Cloud NAT gateway name.
Route Cloud Run traffic through the VPC network
After NAT is configured, deploy or update your Cloud Run service with Direct VPC egress or the Serverless VPC Access connector and set the VPC egress to route all traffic through the VPC network:
gcloud
Direct VPC egress
To deploy or update your Cloud Run service to use Direct VPC egress and route all egress traffic through it, run the following command:
gcloud run deploy SERVICE_NAME \ --image=IMAGE_URL \ --network=NETWORK \ --subnet=SUBNET \ --region=REGION \ --vpc-egress=all-traffic
Replace the following values in this command:
- SERVICE_NAME with the name of the Cloud Run service you want to deploy.
- IMAGE_URL with a reference to the container image, for
example,
us-docker.pkg.dev/cloudrun/container/hello:latest
. If you use Artifact Registry, the repository REPO_NAME must already be created. The URL has the shapeLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
. - NETWORK with the name of your VPC network.
- SUBNET with the name of your subnet.
- REGION with a region for your service.
Serverless VPC Access connector
To deploy or update your Cloud Run service to use a Serverless VPC Access connector and route all egress traffic through it, run the following command:
gcloud run deploy SERVICE_NAME \ --image=IMAGE_URL \ --vpc-connector=CONNECTOR_NAME \ --region=REGION \ --vpc-egress=all-traffic
Replace the following values in this command:
- SERVICE_NAME with the name of the Cloud Run service you want to deploy.
- IMAGE_URL with a reference to the container image, for
example,
us-docker.pkg.dev/cloudrun/container/hello:latest
. If you use Artifact Registry, the repository REPO_NAME must already be created. The URL has the shapeLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
. - CONNECTOR_NAME with the name of your Serverless VPC Access connector.
- REGION with a region for your service.
Terraform
This Cloud Run service uses a VPC connector and routes all egress traffic through it:
Replace us-docker.pkg.dev/cloudrun/container/hello
with a reference to your container image.
Verify the static external IP
After completing the previous steps, you have set up Cloud NAT on your VPC network with a predefined static IP address, and you have routed all of your Cloud Run service's outbound traffic into your VPC network. Requests from your Cloud Run service travel through your VPC network and reach external endpoints using the static IP address.
To verify this behavior and confirm the origin IP address that your service uses, you can make a request to an API or a website such as curlmyip.org that shows the origin IP address.
Deleting the static external IP
If you no longer need a static external IP address, see Release a static external IP address.