Configure GCS to prevent egress charges

Allie Hajian
  • Updated

This document provides step-by-step instructions for those sharing data with a large group to avoid network egress charges through the use of Google Cloud's VPC Service Controls. This document includes instructions on how to create a service perimeter around the Cloud project that contains your data storage bucket.

Source material for this article was contributed by Matt Bookman and the Verily Life Sciences solutions team as part of the design and engineering rollout of Terra support for data regionality.

Overview

Making a Google Cloud Storage (GCS) bucket public or sharing with a group is an easy way to make your data more useful to more people. Unfortunately, if the users of your data copy that data out of the bucket's Cloud Storage region, network egress charges can be incurred.

The Requester Pays feature can be enabled on the bucket to protect you as the data provider. Unfortunately, the end users of your data may be unaware of egress charges until after they've incurred them

Fortunately, it is possible to avoid network egress charges through the use of Google Cloud's VPC Service Controls. This document provides instructions on how to create a service perimeter around the Cloud project that contains your bucket.

Note that generally this service perimeter solution doesn't work with Requester Pays buckets. There is a limitation on service perimeters when using the Requester Pays feature. When using the Requester Pays feature with a storage bucket inside a service perimeter that protects the Cloud Storage service, you cannot identify a project to pay that is outside the perimeter. The target project must be in the same perimeter as the storage bucket or in a perimeter bridge with the bucket's project.

Example

The following example demonstrates configuration for Google Cloud Storage. For concreteness, this example is for data stored in the us-central1 region. VPC service controls are added to prevent egress outside of this region.

Example Overview

In this example, we have an organization named testorg.net. In it, there is a project named test-project.

When you put a project into a service perimeter, you can restrict the usage of Google Cloud services such as Cloud Storage. This would prevent data in Cloud Storage from leaving the perimeter. However, we also apply an Access Level, which allows for specific access to services inside the perimeter. The Access Level created in this example will allow an ingress of requests from specific IP ranges. We do not specify any egress rules, so only VMs allowed in through the access level can download the Cloud Storage data.

Google Cloud Storage Cloud Resources

In test-project, there is a bucket named test-data-bucket. Our goal in this example is to create a perimeter such that we can restrict access on test-data-bucket only to VMs in us-central1.

Configure-GCS-to-prevent-egress-charges.png

VPC Configuration

Before you begin

Creating the Access Level and Perimeter requires an access policy to exist for your organization. If it doesn't exist yet, create an access policy for your organization. Organizations can only have one access policy. If you attempt to create an access policy while one already exists for your organization, you will receive an error.

We also recommend creating the following environment variables for the configuration process:

$ export PROJECT_NUMBER=<The project number>
$ export PROJECT_ID=<The project ID>
$ export ORGANIZATION_ID=<The organization ID>
$ export POLICY_ID=<The project access policy ID>
$ export PROJECT_ADMIN_EMAIL=<Project administrator email>

# You can retrieve your ORGANIZATION_ID with this command:

$ curl -X POST -H "Authorization: Bearer \"$(gcloud auth
application-default print-access-token)\""           -H "Content-Type:
application/json; charset=utf-8"             
https://cloudresourcemanager.googleapis.com/v1/projects/${PROJECT_NUMBER}:getAncestry

# This will return:
#{
#  "ancestor": [
#    {
#      "resourceId": {
#        "type": "project",
#        "id": <PROJECT_ID>
#      }
#    },
#    {
#      "resourceId": {
#        "type": "organization",
#        "id": <ORGANIZATION_ID>
#      }
#    }
#  ]
#}

# You can retrieve your POLICY_ID with this command:
$ gcloud access-context-manager policies list \
--organization=${ORGANIZATION_ID}

# This will return:
# NAME          ORGANIZATION     TITLE           ETAG
# <POLICY_ID>  <ORGANIZATION_ID> <POLICY_TITLE>  <POLICY_ETAG>

Create Access Level

First, we create an Access Level to allow access from the IP ranges of VMs in us-central1. The IP ranges are publicly available from https://www.gstatic.com/ipranges/cloud.json.

Note that restricting access to only these IP ranges will block the use of the Cloud Console UI to view the bucket. In order to continue using the Cloud Console UI we'll also give our individual account access. 

First, create a file named us_central.yaml that contains:

$ head us_central.yaml
- members:
  - user:${PROJECT_ADMIN_EMAIL}
- ipSubnetworks:
  - 8.34.210.0/24
  - 8.34.212.0/22
  - 8.34.216.0/22
  - 8.35.192.0/21
  <snip>

You can get the full list of us-central1 IP ranges with something like:

$ curl https://www.gstatic.com/ipranges/cloud.json | \
jq -r '.prefixes | .[] | {scope: .scope, ip: .ipv4Prefix} | select(.scope ==
"us-central1") | {ip} | .[]'

Or if you prefer to use Python instead of jq:

$ curl https://www.gstatic.com/ipranges/cloud.json | \
python3 -c '

import sys, json
prefixes = json.load(sys.stdin)["prefixes"]
for p in prefixes:
if p["scope"] == "us-central1":
print(p["ipv4Prefix"]) 

Finally, use gcloud to create the access level:

$ gcloud access-context-manager levels create us_central1_only \
--title=us_central1_only \
--basic-level-spec=us_central.yaml \
--policy=${POLICY_ID} \
--combine-function="or"

Create a Perimeter

Next, we need to create a perimeter that uses the above access level. This perimeter will be placed around test-project and enforced on the Google Cloud Storage service.

$ gcloud access-context-manager perimeters create new_perimeter \    
  --title=new_perimeter \
  --resources=projects/${PROJECT_NUMBER} \
  --access-levels=us_central1_only \
  --restricted-services=storage.googleapis.com \
  --policy=${POLICY_ID}

Tests

These are from VMs outside of the org. 

From a us-central1 VM (success)

willyn@willyn-test:~$ curl http://metadata.google.internal/computeMetadata/v1/instance/zone -H 
"Metadata-Flavor: Google"
projects/426023965843/zones/us-central1-a
willyn@willyn-test:~$ gsutil cp gs://test-data-bucket/test.log .
Copying gs://test-data-bucket/test.log...
/ [1 files][534.3 KiB/534.3 KiB]                                               
Operation completed over 1 objects/534.3 KiB.

From a European VM (fail)

willyn@europe-west2-london-instance:~$ curl http://metadata.google.internal/computeMetadata/v1/instance/zone -H 
"Metadata-Flavor: Google"
projects/426023965843/zones/europe-west2-c
willyn@europe-west2-london-instance:~$ gsutil cp gs://test-data-bucket/test.log .
AccessDeniedException: 403 Request is prohibited by organization's policy. vpcServiceControlsUniqueIdentifier: 2n91jQ3T3Rh1jjZe4GWlMHJdNPB0QMg8fi14q44_v5OZut6mkRnFeQ

From a workstation when NOT logged in as PROJECT_ADMIN_EMAIL (fail)

$ gsutil cp gs://test-data-bucket/test.log .
AccessDeniedException: 403 Request is prohibited by organization's policy.
vpcServiceControlsUniqueIdentifier: 2n91jQ3T3Rh1jjZe4GWlMHJdNPB0QMg8fi14q44_v5OZut6mkRnFeQ

Notes/Caveats

  • VPC Service perimeters are only available to projects with a Cloud Organization. See the documentation for Creating and managing organizations.
  • Management of VPC service perimeters requires organization-level permissions. If you do not have permissions at this level, consult with your organization's IT administrators to set up VPC service perimeters around a dedicated data sharing project, and work with them to configure it.
  • Putting a project in the service perimeter as described above places all Cloud Storage buckets or Artifact Registry registries in the project inside the perimeter. Thus you will probably want to create a dedicated project (without other Cloud services enabled) for  buckets and registries in the same location with the same restrictions.
  • The above configuration restricts direct copies from bucket-to-bucket, even if the bucket is in the same region. If you want to copy an image from one registry to another, in the above example, you can pull the image to a VM in us-central1 and then push it to any target registry to which you have access.
  • We've considered if the Storage Transfer Service API should also be restricted. We believe the answer is no, because the Storage Transfer Service eventually calls Cloud Storage APIs, which will be checked appropriately.
  • Configure GCR/Artifact Registry to prevent egress charges also exists. It is similar to this doc, but specific for GCR access.

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.