Use a user-managed notebooks instance within a service perimeter

This page describes how to use VPC Service Controls to set up a user-managed notebooks instance within a service perimeter.

Before you begin

  1. Read the Overview of VPC Service Controls.

  2. Create a user-managed notebooks instance. This instance is not within a service perimeter yet.

  3. Create a service perimeter using VPC Service Controls. This service perimeter protects the Google-managed resources of services that you specify. While creating your service perimeter, do the following:

    1. When it's time to add projects to your service perimeter, add the project that contains your user-managed notebooks instance.

    2. When it's time to add services to your service perimeter, add the Notebooks API.

    If you have created your service perimeter without adding the projects and services you need, see Managing service perimeters to learn how to update your service perimeter.

Configure your DNS entries using Cloud DNS

Vertex AI Workbench user-managed notebooks instances use several domains that a Virtual Private Cloud network doesn't handle by default. To ensure that your VPC network correctly handles requests sent to those domains, use Cloud DNS to add DNS records. For more information about VPC routes, see Routes.

To create a managed zone for a domain, add a DNS entry that will route the request, and execute the transaction, complete the following steps. Repeat these steps for each of several domains that you need to handle requests for, starting with *

In Cloud Shell or any environment where the Google Cloud CLI is installed, enter the following Google Cloud CLI commands.

  1. To create a private managed zone for one of the domains that your VPC network needs to handle:

        gcloud dns managed-zones create ZONE_NAME \
            --visibility=private \
            --networks= \
            --dns-name=DNS_NAME \
            --description="Description of your managed zone"

    Replace the following:

    • ZONE_NAME: a name for the zone to create. You must use a separate zone for each domain. This zone name is used in each of the following steps.
    • PROJECT_ID: the ID of the project that hosts your VPC network
    • NETWORK_NAME: the name of the VPC network that you created earlier
    • DNS_NAME: the part of the domain name that comes after the *., with a period on the end. For example, * has a DNS_NAME of
  2. Start a transaction.

        gcloud dns record-sets transaction start --zone=ZONE_NAME
  3. Add the following DNS A record. This reroutes traffic to Google's restricted IP addresses.

        gcloud dns record-sets transaction add \
            --name=DNS_NAME. \
            --type=A \
            --zone=ZONE_NAME \
  4. Add the following DNS CNAME record to point to the A record that you just added. This redirects all traffic matching the domain to the IP addresses listed in the previous step.

        gcloud dns record-sets transaction add \
            --name=\*.DNS_NAME. \
            --type=CNAME DNS_NAME. \
            --zone=ZONE_NAME \
  5. Execute the transaction.

        gcloud dns record-sets transaction execute --zone=ZONE_NAME
  6. Repeat these steps for each of the following domains. For each repetition, change ZONE_NAME and DNS_NAME to the appropriate values for that domain. Keep PROJECT_ID and NETWORK_NAME the same each time. You already completed these steps for *

    • *
    • *
    • *
    • * to run code that interacts with other Google APIs and services

Configure the service perimeter

After configuring the DNS records, either create a service perimeter or update an existing perimeter to add your project to the service perimeter.

In the VPC network, add a route for the range with a next hop of Default internet gateway.

Use Artifact Registry within your service perimeter

If you want to use Artifact Registry in your service perimeter, see Configure restricted access for GKE private clusters.

Use Shared VPC

If you are using Shared VPC, you must add the host and the service projects to the service perimeter. In the host project, you must also grant the Compute Network User role (roles/compute.networkUser) to the Notebooks Service Agent from the service project. For more information, see Managing service perimeters.

Access your user-managed notebooks instance

Follow the steps for opening a notebook.


Identity type for ingress and egress policies

When you specify an ingress or egress policy for a service perimeter, you can't use ANY_SERVICE_ACCOUNT or ANY_USER_ACCOUNT as an identity type for all Vertex AI Workbench operations.

Instead, use ANY_IDENTITY as the identity type.

Accessing the user-managed notebooks proxy from a workstation without internet

To access user-managed notebooks instances from a workstation with limited internet access, verify with your IT administrator that you can access the following domains:

  • *
  • *
  • *
  • *
  • *
  • *
  • *

You must have access to these domains for authentication to Google Cloud. See the previous section, Configure your DNS entries using Cloud DNS, for further configuration information.

What's next