Set up Cloud Number Registry

This page explains how to set up Cloud Number Registry in your organization.

Before you begin

  1. Create or select a project to use to manage Cloud Number Registry for the parent organization. We strongly recommend creating a dedicated project for this purpose. For more information, see Limitations.

    1. In the Google Cloud console, go to the project selector page.

      Go to project selector

    2. Select or create a Google Cloud project.

      Roles required to select or create a project

      • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
      • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

  2. Enable the Cloud Number Registry API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  3. Verify that you have the permissions required to complete this guide.

Required roles

To get the permissions that you need to set up and manage Cloud Number Registry, ask your administrator to grant you the Cloud Number Registry IPAM Admin (roles/cloudnumberregistry.ipamAdmin) IAM role on your project. For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Optional: Check if Cloud Number Registry is configured

Only one project in each organization can configure Cloud Number Registry. You can check if Cloud Number Registry is already configured in your organization from any project in the organization.

gcloud

Check if Cloud Number Registry is already configured in your organization by using the gcloud alpha number-registry ipam-admin-scopes check-availability command.

  • If Cloud Number Registry is already configured, the response is UNAVAILABLE.
  • If there's no existing configuration, the response is AVAILABLE.
gcloud alpha number-registry ipam-admin-scopes check-availability \
    --scopes=SCOPE \
    --location=global

Replace SCOPE with the organization that you want to manage—for example, organizations/12345678.

Create an IPAM admin scope

When you create the IPAM admin scope, Cloud Number Registry performs setup tasks and identifies supported Compute Engine resources in your organization and adds them to a default registry book. You can view the status of the IPAM admin scope to check if setup is complete.

You can manage Cloud Number Registry through this default registry book, or you optionally create additional registry books to organize your resources.

gcloud

Create the IPAM admin scope by using the gcloud alpha number-registry ipam-admin-scopes create command.

To check the progress of the Cloud Number Registry setup, view the status of the IPAM admin scope.

gcloud alpha number-registry ipam-admin-scopes create SCOPE_NAME \
    --enabled-addon-platforms=COMPUTE_ENGINE \
    --scopes=SCOPE \
    --location=global

Replace the following:

  • SCOPE_NAME: a name for the IPAM admin scope
  • SCOPE: the organization that you want to manage—for example, organizations/12345678.

View the status of the IPAM admin scope

The admin scope can have the following statuses during setup:

  • SETUP_IN_PROGRESS: setup has started but synchronization isn't complete.

  • READY_TO_USE: synchronization is complete and Cloud Number Registry is ready to use.

gcloud

View details about the IPAM admin scope by using the gcloud alpha number-registry ipam-admin-scopes describe command.

gcloud alpha number-registry ipam-admin-scopes describe SCOPE_NAME \
    --location=global

Replace SCOPE_NAME with the IPAM admin scope name.

What's next