Add Hyperdisk storage to a VM

You can use a Hyperdisk Extreme or Hyperdisk Throughput volume with your VM by completing the following tasks:

Create a blank, non-boot, and zonal Hyperdisk volume and attach it to your VM either as part of VM creation or as separate tasks.
Format and mount the volume to provide access to a data or file system.

The process is the same for Hyperdisk Balanced volumes, except that you can also create boot disks of type Hyperdisk Balanced.

For general information about Hyperdisk, see About Hyperdisk.

Before you begin

Review the Hyperdisk limitations before adding a Hyperdisk volume to your VM.
If you haven't already, set up authentication. Authentication is the process by which your identity is verified for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine as follows.

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, then initialize it by running the following command:
```
gcloud init
```
  Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.
2. Set a default region and zone.
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.
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 add a Hyperdisk volume to your VM, 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 that can run as a service account: Service Account User (v1) (roles/iam.serviceAccountUser)

For more information about granting roles, see Manage access.

These predefined roles contain the permissions required to add a Hyperdisk volume to your VM. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to add a Hyperdisk volume to your VM:

To create and attach a Hyperdisk volume:
- compute.disks.create on the project
- compute.instances.attachDisk on the VM
- compute.disks.use on the volume that you want to attach to the VM
To format and mount the attached volume: compute.instances.setMetadata on the VM

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

Supported values for Hyperdisk volumes

The values you use when creating or modifying a Hyperdisk volume must fall within the range of maximum and minimum values described in Hyperdisk limits per disk.

If you're modifying the size of a Hyperdisk volume that's attached to a VM, then the new values can't exceed the Hyperdisk limits per VM.

The provisioned IOPS and throughput for a Hyperdisk volume must follow the rules outlined in About IOPS and throughput provisioning for Hyperdisk.

Add a Hyperdisk volume to your VM

You can create and attach a Hyperdisk volume by using the Google Cloud console, Google Cloud CLI, or REST.

The size, throughput, and IOPS that you specify when creating a Hyperdisk volume must be in the range of supported values.

Console

Go to the VM instances page.

Go to VM instances
Click the name of the VM where you want to add a disk.
On the VM instance details page, click Edit.
Under the heading Additional disks, click Add new disk.
Specify a name for the disk, and optionally add a description. Select Blank disk as the Disk source type.
Under Disk settings, choose a disk type from the following list. The values that you specify must be in the range of supported values.
1. Hyperdisk Balanced. You can also change the default disk Size, Provisioned IOPS, and Provisioned Throughput settings.
2. Hyperdisk Extreme. You can also change the default disk Size and Provisioned IOPS settings.
3. Hyperdisk ML. You can also change the default disk Size and Provisioned Throughput settings.
4. Hyperdisk Throughput.You can also change the default disk Size and Provisioned Throughput settings.
Click Save.
To apply your changes to the VM, click Save.

gcloud

Use the gcloud compute disks create command to create the Hyperdisk volume.
```
gcloud compute disks create DISK_NAME \
   --zone=ZONE \
   --size=DISK_SIZE \
   --type=DISK_TYPE \
   --provisioned-iops=IOPS_LIMIT
   --provisioned-throughput=THROUGHPUT_LIMIT
```
Replace the following:
- DISK_NAME: the name of the new disk.
- ZONE: the name of zone where the new disk is being created.
- DISK_SIZE: Optional: The size of the new disk. The value must be a whole number followed by a size unit of GB for gibibyte, or TB for tebibyte. If no size unit is specified, 100 GB is used as the default value. The accepted values for the disk size are:
  - Hyperdisk Balanced: From 4 GiB to 64 TiB, inclusive, in 1 GiB increments.
  - Hyperdisk Extreme: From 64 GiB to 64 TiB, inclusive, in 1 GiB increments.
  - Hyperdisk ML: From 4 GiB to 64 TiB, inclusive, in 1 GiB increments.
  - Hyperdisk Throughput: From 2 TiB to 32 TiB, inclusive, in 1 GiB increments.
- DISK_TYPE: the type of disk. Use one of the following values: hyperdisk-balanced, hyperdisk-extreme, hyperdisk-ml, or hyperdisk-throughput
- IOPS_LIMIT: Optional: For Hyperdisk Balanced or Hyperdisk Extreme disks, this is the number of I/O operations per second (IOPS) that the disk can handle.
- THROUGHPUT_LIMIT: Optional: For Hyperdisk Balanced, Hyperdisk ML, or Hyperdisk Throughput volumes, this is an integer that represents the throughput, measured in MiB per second, that the disk can handle.
Optional: Use the gcloud compute disks describe DISK_NAME command to see a description of your disk.
After you create the disk, you can attach the disk to a VM.

REST

Construct a POST request to create a zonal Hyperdisk by using the disks.insert method. Include the name, sizeGb, type, provisionedIops, and provisionedThroughput properties. To create this disk as an empty and unformatted non-boot disk, don't specify a source image or a source snapshot.
```
POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/disks
{
   "name": "DISK_NAME",
   "sizeGb": "DISK_SIZE",
   "type": "https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/diskTypes/DISK_TYPE",
   "provisionedIops": "IOPS_LIMIT",
   "provisionedThroughput": "THROUGHPUT_LIMIT"
}
```
Replace the following:
- PROJECT_ID: your project ID
- ZONE: the zone where your VM and new disk are located
- DISK_NAME: the name of the new disk
- DISK_SIZE: Optional: The size of the new disk. The value must be a whole number followed by a size unit of GB for gibibytes or TB for tebibytes.
- DISK_TYPE: the type of disk. To create a Hyperdisk volume, use one of the following values: hyperdisk-balanced, hyperdisk-extreme, hyperdisk-ml, or hyperdisk-throughput.
- IOPS_LIMIT: Optional: For Hyperdisk Balanced and Hyperdisk Extreme, this is the number of I/O operations per second that the disk can handle.
- THROUGHPUT_LIMIT: Optional: For Hyperdisk Balanced, Hyperdisk ML, or Hyperdisk Throughput volumes, this is an integer that represents the throughput, measured in MiB per second, that the disk can handle.
Optional: Use the compute.disks.get method to see a description of your disk.
After you create the disk, you can attach the disk to any running or stopped VM.

Format and mount the disk

After you create and attach the new disk to a VM, you must format and mount the disk, so that the operating system can use the available storage space.

Linux: See Formatting and mounting a non-boot disk on a Linux VM
Windows: See Formatting and mounting a non-boot disk on a Windows VM

What's next

Learn how to customize the IOPS and throughput on your Hyperdisk volumes.
Learn how to regularly back up your disks using snapshots to prevent unintended data loss.