This document describes how to create Hyperdisk pools. Hyperdisk pools are block storage resources that help you manage your Hyperdisk block storage resources in aggregate. Hyperdisk pools are available in the following variants:

• Hyperdisk Storage Pools: recommended for most workloads
• Hyperdisk Exapools: recommended for very large workloads that require more than 100 GiB/s of concurrent performance

To learn about the different types of Hyperdisk pools, see Hyperdisk pools overview.

Before you begin

• If you haven't already, set up authentication. Authentication verifies your identity for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine by selecting one of the following options:

  Select the tab for how you plan to use the samples on this page:

  Console

  When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

  gcloud

  1. Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:

     gcloud init

     If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  2. Set a default region and zone.

  Go

  To use the Go samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.

  Install the Google Cloud CLI.

  If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  If you're using a local shell, then create local authentication credentials for your user account:

  gcloud auth application-default login

  You don't need to do this if you're using Cloud Shell.

  If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

  For more information, see Set up authentication for a local development environment.

  Java

  To use the Java samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.

  Install the Google Cloud CLI.

  If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  If you're using a local shell, then create local authentication credentials for your user account:

  gcloud auth application-default login

  You don't need to do this if you're using Cloud Shell.

  If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

  For more information, see Set up authentication for a local development environment.

  Node.js

  To use the Node.js samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.

  Install the Google Cloud CLI.

  If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  If you're using a local shell, then create local authentication credentials for your user account:

  gcloud auth application-default login

  You don't need to do this if you're using Cloud Shell.

  If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

  For more information, see Set up authentication for a local development environment.

  REST

  To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.

  Install the Google Cloud CLI.

  If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  For more information, see Authenticate for using REST in the Google Cloud authentication documentation.

Required roles and permissions

To get the permissions that you need to create a Hyperdisk pool, ask your administrator to grant you the following IAM roles on the project:

• Compute Instance Admin (v1) (roles/compute.instanceAdmin.v1)
• To connect to a VM instance that can run as a service account: Service Account User (v1) (roles/iam.serviceAccountUser role)

For more information about granting roles, see Manage access to projects, folders, and organizations.

These predefined roles contain the permissions required to create a Hyperdisk pool. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to create a Hyperdisk pool:

• compute.storagePools.create on the project
• compute.storagePools.setLabels on the project

You might also be able to get these permissions with custom roles or other predefined roles.

Limitations

The following limitations apply when you create Hyperdisk Storage Pools:

Resource limits:

• You can create a Hyperdisk Storage Pool with up to 5 PiB of provisioned capacity.
• You can create a maximum of 5 Storage Pools per hour.
• You can create a maximum of 10 Storage Pools per day.
• You can create at most 10 Storage Pools per project.
• You can't change the provisioning model for a pool. For example, you can't change a Standard capacity Storage Pool to an Advanced capacity Storage Pool or an Advanced performance Storage Pool to a Standard performance Storage Pool.
• Pools are a zonal resource.
• You can create up to 10,000 disks in a Storage Pool.
• You can use Hyperdisk Storage Pools with only Compute Engine. Cloud SQL instances can't use Hyperdisk Storage Pools.
• You can change the provisioned capacity or performance of a Storage Pool at most two times in a 24 hour period.
• You can create only Hyperdisk Balanced disks in a Hyperdisk Balanced pool, and you can create only Hyperdisk Throughput disks in a Hyperdisk Throughput pool
• You must contact your account team to change the provisioned capacity, IOPS, or throughput of an Exapool.
• You must contact your account team to delete an Exapool.

Limits for disks in a Storage Pool:

• Only new disks in the same project and zone can be created in a pool.
• You can't move disks in or out of a pool. To move a disk in or out of a pool, you have to recreate the disk from a snapshot. For more information, see Change the disk type.
• To create boot disks in a pool, you must use a Hyperdisk Balanced Storage Pool or Hyperdisk Balanced Exapool.
• Pools don't support regional disks.
• You can't clone, create instant snapshots of, or configure Asynchronous Replication for disks in a pool.

Capacity ranges and provisioned performance limits

When you create a Storage Pool, the provisioned capacity, IOPS, and throughput can't exceed the limits described in Limits for pools.

To create a new Hyperdisk Storage Pool, use the Google Cloud console, Google Cloud CLI, or REST. You must specify the following properties when you create a Storage Pool:

• Zone
• Storage Pool type
• Capacity provisioning model
• Pool provisioned capacity
• Performance provisioning type

• Pool provisioned IOPS and throughput

gcloud compute storage-pools create NAME  \
    --zone=ZONE   \
    --storage-pool-type=STORAGE_POOL_TYPE   \
    --capacity-provisioning-type=CAPACITY_TYPE \
    --provisioned-capacity=POOL_CAPACITY   \
    --performance-provisioning-type=PERFORMANCE_TYPE \
    --provisioned-iops=IOPS   \
    --provisioned-throughput=THROUGHPUT   \
    --description=DESCRIPTION

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/storagePools

{
    "name": "NAME",
    "description": "DESCRIPTION",
    "poolProvisionedCapacityGb": "POOL_CAPACITY",
    "storagePoolType": "projects/PROJECT_ID/zones/ZONE/storagePoolTypes/STORAGE_POOL_TYPE",
    "poolProvisionedIops": "IOPS",
    "poolProvisionedThroughput": "THROUGHPUT",
    "capacityProvisioningType": "CAPACITY_TYPE",
    "performanceProvisioningType": "PERFORMANCE_TYPE"
}

Create a Hyperdisk Exapool

Hyperdisk Exapools are generally available with an allowlist. To create a Hyperdisk Exapool, contact your account team.

What's next?

• Add disks to a pool.
• Manage pools.