Consume reservations

Console

1. To create a reservation with resources that can be used by VMs with a reservation affinity property configured to consume any reservations (default), follow these steps:

   1. Select the type of reservation that you want to create:

      • To create standalone reservation, do the following:

        1. In the Google Cloud console, go to the Reservations page.

           Go to Reservations

        2. On the On-demand reservation tab (default), click add_box Create reservation.

           The Create a reservation page opens.

      • To create a reservation that is attached to a commitment, do the following:

        1. In the Google Cloud console, go to the Committed use discounts page.

           Go to Committed use discounts

           The Commitment list page opens.

        2. Click add_box Purchase commitment.

           The Purchase a committed use discount page opens.

        3. Specify the commitment properties. Then, in the Reservations section, click Add an item.

           The Add a new reservation section appears.

           For more information about how to purchase a commitment with an attached reservation, see Purchase commitments with attached reservations.

   2. In the Name field, enter a name for your reservation. For this example, enter reservation-01.

   3. Choose the Region and Zone where you want to reserve resources. For this example, select us-central1 as the region and us-central1-a as the zone.

   4. Choose your preferred Share type:

      • To create a reservation for a single project, select Local.
      • To create a shared reservation among multiple projects, select Shared. To share this reservation with other projects, click add Add projects and select the desired projects from the current project's organization.

   5. In the Use with VM instance section, select Use reservation automatically, so that any matching VMs can automatically use this reservation.

   6. In the Number of VM instances field, enter the number of VMs that you want to reserve. For this example, enter 2.

   7. Specify the resources that you want to reserve for each VM:

      • If you want to reserve VMs that match an existing instance template, select Use instance template and select an instance template from the list.
      • Otherwise, select Specify machine type and specify the following:
        1. In the Machine family, Series, and Machine type fields, select a machine family, series, and machine type.
        2. Optional: Specify a minimum CPU platform and/or GPUs:
           1. To expand the CPU Platform and GPU section, click the expand_more expander arrow.
           2. Optional: To specify a minimum CPU platform, in the CPU Platform list, select an option.
           3. Optional: To add GPUs, click add Add GPU. Then, in the GPU type and Number of GPUs fields, select the type and number of GPUs for each VM.
        3. Optional: Add local SSDs:
           1. In the Number of disks field, select the number of local SSDs for each VM.
           2. In the Interface type field, select the interface for the local SSDs.

      For this example, select Specify machine type. Then select the n2-standard-32 machine type for the General-purpose machine family and N2 series and select the minimum CPU platform Intel Cascade Lake.

   8. Finish creating the reservation:

      • If you are creating standalone reservation, click Create.

      • If you are creating a reservation that is attached to a commitment:

        1. To finish specifying the properties for this reservation, click Done.
        2. To finish creating the commitment and attached reservations, click Purchase.

2. In the same project or a project that the reservation is shared with, create a VM that targets any open reservation.

   Ensure that the VM's properties match the VM properties in reservation-01, including the zone, machine type (machine family, vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD interface and size.

   For more information about how to create a VM, see Create and start a VM

   1. In the Google Cloud console, go to the Create an instance page.

      Go to Create an instance

      The Create an instance page opens.

   2. Specify a name for your VM.

   3. In the following sections, select a configuration that exactly matches all the properties of your reservation, including any optional properties. For this example, you must match the following VM properties with reservation-01:

      • Region: us-central1
      • Zone: us-central1-a
      • Machine type: n2-standard-32
      • Minimum CPU platform: Intel Cascade Lake
      • GPUs: none
      • Local SSDs: none

   4. Expand the Advanced options section and then expand the Management section. In the Reservations list, select Automatically use created reservation.

   5. To create the VM, click Create.

gcloud

1. Create an open reservation called reservation-01.

   gcloud compute reservations create reservation-01 \
       --vm-count=2 \
       --machine-type=n2-standard-32 \
       --min-cpu-platform="Intel Cascade Lake" \
       --zone=us-central1-a
   

2. Create a VM that targets any open reservation and that matches the VM properties in reservation-01, including the zone, machine type (machine family. vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD amount and interface.

   gcloud compute instances create instance-1 \
       --machine-type=n2-standard-32 \
       --min-cpu-platform="Intel Cascade Lake" \
       --zone=us-central1-a \
       --reservation-affinity=any
   

REST

1. Create an open reservation named reservation-01.

   POST https://compute.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/reservations
   
   {
     "name": "reservation-01",
     "specificReservation": {
       "count": "2",
       "instanceProperties": {
         "machineType": "n2-standard-32",
         "minCpuPlatform": "Intel Cascade Lake",
       }
     }
   }
   

2. Create a VM that targets any open reservation and that matches the VM properties in reservation-01, including the zone, machine type (machine family. vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD amount and interface.

   POST https://compute.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances
   
   {
     "name": "instance-1",
     "machineType": "zones/us-central1-a/machineTypes/n2-standard-32",
     "minCpuPlatform": "Intel Cascade Lake",
     "disks": [
       {
         "boot": true,
         "initializeParams": {
           "sourceImage": "projects/debian-cloud/global/images/family/debian-12"
         }
       }
     ],
     "networkInterfaces": [
       {
         "network": "global/networks/default"
       }
     ],
     "reservationAffinity": {
       "consumeReservationType": "ANY_RESERVATION"
     }
   }
   

Console

1. To create a reservation with resources that can only be used by VMs that specifically target the reservation by name, follow these steps:

   1. Select one of the following options:

      • To create standalone reservation, do the following:

        1. In the Google Cloud console, go to the Reservations page.

           Go to Reservations

        2. On the On-demand reservations tab (default), click add_box Create reservation.

           The Create a reservation page opens.

      • To create a reservation that is attached to a commitment, do the following:

        1. In the Google Cloud console, go to the Committed use discounts page.

           Go to Committed use discounts

        2. Click add_box Purchase commitment.

           The Purchase a committed use discount page opens.

        3. Specify the commitment properties. Then, in the Reservations section, click Add an item.

           The Add a new reservation section appears.

           For more information about how to purchase a commitment with an attached reservation, see Purchase commitments with attached reservations.

   2. In the Name field, enter a name for your reservation. For this example, enter reservation-02.

   3. Choose the Region and Zone where you want to reserve resources. For this example, select us-central1 as the region and us-central1-a as the zone.

   4. To specify that your reservation will be a single-project reservation, select Local as the Share type.

   5. In the Use with VM instance section, select Select specific reservation, so that only matching VMs that specifically target this reservation by name can use this reservation.

   6. In the Number of VM instances field, enter the number of VMs that you want to reserve. For this example, enter 10.

   7. Specify the resources that you want to reserve for each VM:

      • If you want to reserve VMs that match an existing instance template, select Use instance template and select an instance template from the list.
      • Otherwise, select Specify machine type and specify the following:
        1. In the Machine family, Series, and Machine type fields, select a machine family, series, and machine type.
        2. Optional: Specify a minimum CPU platform and/or GPUs:
           1. To expand the CPU Platform and GPU section, click the expand_more expander arrow.
           2. Optional: To specify a minimum CPU platform, in the CPU Platform list, select an option.
           3. Optional: To add GPUs, click add Add GPU. Then, in the GPU type and Number of GPUs fields, select the type and number of GPUs for each VM.
        3. Optional: Add local SSDs:
           1. In the Number of disks field, select the number of local SSDs for each VM.
           2. In the Interface type field, select the interface for the local SSDs.

      For this example, select Specify machine type. Then select the n2-standard-32 machine type for the General-purpose machine family and N2 series and select the minimum CPU platform Intel Cascade Lake.

   8. Finish creating the reservation:

      • If you are creating standalone reservation, click Create.

      • If you are creating a reservation that is attached to a commitment:

        1. To finish specifying the properties for this reservation, click Done.
        2. To finish creating the commitment and attached reservations, click Purchase.

2. In the same project, create a VM that targets that specific reservation by name.

   Ensure that the VM's properties match the VM properties of that specific reservation, including the zone, machine type (machine family, vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD interface and size.

   For more information about how to create a VM, see Create and start a VM.

   1. In the Google Cloud console, go to the Create an instance page.

      Go to Create an instance

   2. In the Name field, enter a name for the VM.

   3. In the following sections, select a configuration that exactly matches all the properties of your reservation, including any optional properties. For this example, you must match the following VM properties with reservation-02:

      • Region: us-central1
      • Zone: us-central1-a
      • Machine type: n2-standard-32
      • Minimum CPU platform: Intel Cascade Lake
      • GPUs: none
      • Local SSDs: none

   4. Expand the Advanced options section, and then do the following:

      1. Expand the Management section.

      2. In the Reservations section, in the Application policy list, select Select specific reservation.

      3. Select the reservation with matching VM properties that you want your VM to consume. For this example, select reservation-02.

   5. To create the VM, click Create.

gcloud

1. Create a reservation named reservation-02 with the --require-specific-reservation flag. These reserved resources can be used only by VMs that specifically target this reservation by name.

   gcloud compute reservations create reservation-02 \
       --machine-type=n2-standard-32 \
       --min-cpu-platform="Intel Cascade Lake" \
       --vm-count=10 \
       --zone=us-central1-a \
       --require-specific-reservation
   

2. Create a VM that targets reservation-02 by name by using the --reservation-affinity and --reservation flags.

   Ensure that the VM's properties match the reservation's VM properties, including the zone, machine type (machine family, vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD interface and size.

   gcloud compute instances create instance-2 \
       --machine-type=n2-standard-32 \
       --min-cpu-platform="Intel Cascade Lake" \
       --zone=us-central1-a \
       --reservation-affinity=specific \
       --reservation=reservation-02
   

REST

1. Create a reservation named reservation-02 with the specificReservationRequired field set to true.

   POST https://compute.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/reservations
   
   {
     "name":"reservation-02",
     "specificReservation":{
       "count":"10",
       "instanceProperties":{
         "machineType":"n2-standard-32",
         "minCpuPlatform": "Intel Cascade Lake",
       }
     },
     "specificReservationRequired": true
   }
   

2. Create a VM that targets reservation-02 by name by using the reservationAffinity field.

   Ensure that the VM's properties match the reservation's VM properties, including the zone, machine type (machine family, vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD interface and size.

   POST https://compute.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances
   
   {
     "name": "instance-2",
     "machineType": "zones/us-central1-a/machineTypes/n2-standard-32",
     "minCpuPlatform": "Intel Cascade Lake",
     "disks": [
       {
         "boot": true,
         "initializeParams": {
           "sourceImage": "projects/debian-clouid/global/images/family/debian-12"
         }
       }
     ],
     "networkInterfaces": [
       {
         "network": "global/networks/default"
       }
     ],
     "reservationAffinity": {
       "consumeReservationType": "SPECIFIC_RESERVATION",
       "key": "compute.googleapis.com/reservation-name",
       "values": [
         "reservation-02"
       ]
     }
   }
   

Console

1. To create a shared reservation with resources that can only be used by VMs that specifically target this reservation by name, follow these steps:

   1. Select one of the following options:

      • To create standalone reservation, do the following:

        1. In the Google Cloud console, go to the Reservations page.

           Go to Reservations

        2. On the On-demand reservations tab (default), click add_box Create reservation.

           The Create a reservation page opens.

      • To create a reservation that is attached to a commitment, do the following:

        1. In the Google Cloud console, go to the Committed use discounts page.

           Go to Committed use discounts

        2. Click add_box Purchase commitment.

           The Purchase a committed use discount page opens.

        3. Specify the commitment properties. Then, in the Reservations section, click Add an item.

           The Add a new reservation section appears.

           For more information about how to purchase a commitment with an attached reservation, see Purchase commitments with attached reservations.

   2. In the Name field, enter a name for your reservation. For this example, enter reservation-02.

   3. Choose the Region and Zone where you want to reserve resources. For this example, select us-central1 as the region and us-central1-a as the zone.

   4. To specify that your reservation is a shared reservation, select Shared as the Share type.

   5. Click add Add projects and select the projects from the current project's organization that you want to share the reservation with.

   6. In the Use with VM instance section, select Select specific reservation, so that only matching VMs that specifically target this reservation by name can use this reservation.

   7. In the Number of VM instances field, enter the number of VMs that you want to reserve. For this example, enter 10.

   8. Specify the resources that you want to reserve for each VM:

      • If you want to reserve VMs that match an existing instance template, select Use instance template and select an instance template from the list.
      • Otherwise, select Specify machine type and specify the following:
        1. In the Machine family, Series, and Machine type fields, select a machine family, series, and machine type.
        2. Optional: Specify a minimum CPU platform and/or GPUs:
           1. To expand the CPU Platform and GPU section, click the expand_more expander arrow.
           2. Optional: To specify a minimum CPU platform, in the CPU Platform list, select an option.
           3. Optional: To add GPUs, click add Add GPU. Then, in the GPU type and Number of GPUs fields, select the type and number of GPUs for each VM.
        3. Optional: Add local SSDs:
           1. In the Number of disks field, select the number of local SSDs for each VM.
           2. In the Interface type field, select the interface for the local SSDs.

      For this example, select Specify machine type. Then select the n2-standard-32 machine type for the General-purpose machine family and N2 series and select the minimum CPU platform Intel Cascade Lake. 1. Finish creating the reservation:

      • If you are creating standalone reservation, click Create.

      • If you are creating a reservation that is attached to a commitment:

        1. To finish specifying the properties for this reservation, click Done.
        2. To finish creating the commitment and attached reservations, click Purchase.

2. In the same project or a project that the reservation is shared with, create a VM that targets that specific reservation by name.

   Ensure that the VM's properties match the VM properties of that specific reservation, including the zone, machine type (machine family, vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD interface and size.

   1. In the Google Cloud console, go to the Create an instance page.

      Go to Create an instance

      The Create an instance page opens.

   2. Specify a Name for your VM.

   3. In the following sections, select a configuration that exactly matches all the properties of your reservation, including any optional properties. For this example, you must match the following VM properties with reservation-02:

      • Region: us-central1
      • Zone: us-central1-a
      • Machine type: n2-standard-32
      • Minimum CPU platform: Intel Cascade Lake
      • GPUs: none
      • Local SSDs: none

   4. Expand the Advanced options section and then expand the Management section. In the Reservations list, select Select specific reservation, and then do the following:

      1. Select a Reservation project that has reservations shared with your current project. For this example, select the project that you used to create reservation-02.
      2. Select the Reservation name of the shared reservation that you want this VM to consume. For this example, select reservation-02.

   5. To create the VM, click Create.

gcloud

1. Create a reservation named reservation-02 with the --require-specific-reservation flag. These reserved resources can be used only by VMs that specifically target this reservation by name.

   gcloud compute reservations create reservation-02 \
       --machine-type=n2-standard-32 \
       --min-cpu-platform="Intel Cascade Lake" \
       --vm-count=10 \
       --zone=us-central1-a \
       --project=my-owner-project \
       --share-setting=projects \
       --share-with=project-1,project-2 \
       --require-specific-reservation
   

2. Create a VM that targets reservation-02 by name by using the --reservation-affinity and --reservation flags. To consume this reservation from any consumer projects that this reservation is shared with, you must also specify the project that created the reservation, my-owner-project.

   Ensure that the VM's properties match the reservation's VM properties, including the zone, machine type (machine family, vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD interface and size.

   gcloud compute instances create instance-2 \
       --machine-type=n2-standard-32 \
       --min-cpu-platform="Intel Cascade Lake" \
       --zone=us-central1-a \
       --reservation-affinity=specific \
       --reservation=projects/my-owner-project/reservations/reservation-02
   

REST

1. Create a reservation named reservation-02 with the specificReservationRequired field set to true.

   POST https://compute.googleapis.com/compute/v1/projects/my-owner-project/zones/us-central1-a/reservations
   
   {
     "name":"reservation-02",
     "specificReservation":{
       "count":"10",
       "instanceProperties":{
         "machineType":"n2-standard-32",
         "minCpuPlatform": "Intel Cascade Lake"
       }
     },
     "shareSettings": {
       "shareType": "SPECIFIC_PROJECTS",
       "projectMap": {
         "project-1": {
           "projectId": "project-1"
         },
         "project-2": {
           "projectId": "project-2"
         }
       }
     },
     "specificReservationRequired": true
   }
   

2. Create a VM that targets reservation-02 by name by using the reservationAffinity field. To consume this reservation from any consumer projects that this reservation is shared with, you must also specify the owner project of the reservation, my-owner-project.

   Ensure that the VM's properties match the reservation's VM properties, including the zone, machine type (machine family, vCPUs, and memory), minimum CPU platform, GPU amount and type, and local SSD interface and size.

   POST https://compute.googleapis.com/compute/v1/projects/project-2/zones/us-central1-a/instances
   
   {
     "name": "instance-2",
     "machineType": "zones/us-central1-a/machineTypes/n2-standard-32",
     "minCpuPlatform": "Intel Cascade Lake",
     "disks": [
       {
         "boot": true,
         "initializeParams": {
           "sourceImage": "projects/debian-clouid/global/images/family/debian-12"
         }
       }
     ],
     "networkInterfaces": [
       {
         "network": "global/networks/default"
       }
     ],
     "reservationAffinity": {
       "consumeReservationType": "SPECIFIC_RESERVATION",
       "key": "compute.googleapis.com/reservation-name",
       "values": [
         "projects/my-owner-project/reservations/reservation-02"
       ]
     }
   }
   

Console

1. In the Google Cloud console, go to the Create an instance page.

   Go to Create an instance

2. In the Name field, enter a name for the VM.

3. In the Region and Zone lists, select the region and zone in which to create the VM.

4. In the Machine configuration section, specify the machine type to use for the VM.

5. Expand the Advanced options section, and then do the following:

   1. Expand the Management section.

   2. In the Reservations section, in the Application policy list, select Don't use.

6. Click Create.

gcloud

To create a VM that explicitly doesn't consume reservations, use the gcloud compute instances create command with the --reservation-affinity=none flag.

gcloud compute instances create VM_NAME \
    --machine-type=MACHINE_TYPE \
    --reservation-affinity=none \
    --zone=ZONE

Replace the following:

• VM_NAME: the name of the VM.

• MACHINE_TYPE: the machine type to use for the VM.

• ZONE: the zone in which to create the VM.

REST

To create a VM that explicitly doesn't consume reservations, make a POST request to the instances.insert method. In the request body, include the consumeReservationType field set to NO_RESERVATION.

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

{
  "name": "VM_NAME",
  "machineType": "zones/ZONE/machineTypes/MACHINE_TYPE",
  "disks": [
    {
      "boot": true,
      "initializeParams": {
        "sourceImage": "projects/IMAGE_PROJECT/global/images/IMAGE"
      }
    }
  ],
  "networkInterfaces": [
    {
      "network": "global/networks/default"
    }
  ],
  "reservationAffinity": {
    "consumeReservationType": "NO_RESERVATION"
  }
}

Replace the following:

• PROJECT_ID: the ID of the project in which to create the VM.

• ZONE: the zone in which to create the VM.

• VM_NAME: the name of the VM.

• MACHINE_TYPE: the machine type to use for the VM.

• IMAGE_PROJECT: the image project that contains the OS image—for example, debian-cloud. For more information about the supported image projects, see Public images.

• IMAGE: specify one of the following:

  • A specific version of the OS image—for example, debian-12-bookworm-v20240617.

  • An image family, which must be formatted as family/IMAGE_FAMILY. This specifies the most recent, non-deprecated OS image. For example, if you specify family/debian-12, the latest version in the Debian 12 image family is used. For more information about using image families, see Image families best practices.

Console

1. In the Google Cloud console, go to the Create an instance template page.

   Go to Create an instance template

2. In the Name field, enter a name for the instance template.

3. In the Location section, specify whether you want to create a regional (default) or global instance template.

4. In the Machine configuration section, specify the machine type to use for the VMs created using the template.

5. Expand the Advanced options section, and then do the following:

   1. Expand the Management section.

   2. In the Reservations section, in the Application policy list, select Don't use.

6. Click Create.

gcloud

To create an instance template that creates VMs that don't explicitly consume reservations, use the gcloud compute instances-templates create command with the --reservation-affinity=none flag.

For example, to create a global instance template that creates VMs that don't explicitly consume reservations, run the following command:

gcloud compute instance-templates create INSTANCE_TEMPLATE_NAME \
    --machine-type=MACHINE_TYPE \
    --reservation-affinity=none

Replace the following:

• INSTANCE_TEMPLATE_NAME: the name of the instance template.

• MACHINE_TYPE: the machine type to use for the VMs created using the instance template.

REST

To create an instance template that creates VMs that don't explicitly consume reservations, make a POST request to one of the following methods:

• To create a global instance template: instanceTemplates.insert method.

• To create a regional instance template: regionInstanceTemplates.insert method.

In the request body, include the consumeReservationType field and set it to NO_RESERVATION.

For example, to create a global instance template that creates VMs that don't explicitly consume reservations, make a request as follows:

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/InstanceTemplates

{
  "name": "INSTANCE_TEMPLATE_NAME",
  "properties": {
    "machineType": "MACHINE_TYPE",
    "disks": [
      {
        "boot": true,
        "initializeParams": {
          "sourceImage": "projects/IMAGE_PROJECT/global/images/IMAGE"
        }
      }
    ],
    "networkInterfaces": [
      {
        "network": "global/networks/default"
      }
    ],
    "reservationAffinity": {
      "consumeReservationType": "NO_RESERVATION"
    }
  }
}

Replace the following:

• PROJECT_ID: the ID of the project in which to create the instance template.

• INSTANCE_TEMPLATE_NAME: the name of the instance template.

• MACHINE_TYPE: the machine type to use for the VMs created using the instance template.

• IMAGE_PROJECT: the image project that contains the OS image—for example, debian-cloud. For more information about the supported image projects, see Public images.

• IMAGE: specify one of the following:

  • A specific version of the OS image—for example, debian-12-bookworm-v20240617.

  • An image family, which must be formatted as family/IMAGE_FAMILY. This specifies the most recent, non-deprecated OS image. For example, if you specify family/debian-12, the latest version in the Debian 12 image family is used. For more information about using image families, see Image families best practices.