feat: consume reservations samples

compute/reservations/createInstanceToConsumeAnyReservation.js

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+async function main(instanceName) {
+  // [START compute_consume_any_matching_reservation]
+  // Import the Compute library
+  const computeLib = require('@google-cloud/compute');
+  const compute = computeLib.protos.google.cloud.compute.v1;
+
+  // Instantiate a reservationsClient
+  const instancesClient = new computeLib.InstancesClient();
+  // Instantiate a zoneOperationsClient
+  const zoneOperationsClient = new computeLib.ZoneOperationsClient();
+
+  /**
+   * TODO(developer): Update/uncomment these variables before running the sample.
+   */
+  // The ID of the project where you want to create instance.
+  const projectId = await instancesClient.getProjectId();
+  // The zone in which to create instance.
+  const zone = 'us-central1-a';
+  // The name of the instance to create.
+  // const instanceName = 'instance-01';
+  // Machine type to use for VM.
+  const machineType = 'n1-standard-4';
+
+  // Create instance to consume reservation if their properties match the VM properties
+  async function callCreateInstanceToConsumeAnyReservation() {
+    // Describe the size and source image of the boot disk to attach to the instance.
+    const disk = new compute.Disk({
+      boot: true,
+      autoDelete: true,
+      type: 'PERSISTENT',
+      initializeParams: {
+        diskSizeGb: '10',
+        sourceImage: 'projects/debian-cloud/global/images/family/debian-12',
+      },
+    });
+
+    //  Define networkInterface
+    const networkInterface = new compute.NetworkInterface({
+      name: 'global/networks/default',
+    });
+
+    // Define reservationAffinity
+    const reservationAffinity = new compute.ReservationAffinity({
+      consumeReservationType: 'ANY_RESERVATION',
+    });
+
+    // Create an instance
+    const instance = new compute.Instance({
+      name: instanceName,
+      machineType: `zones/${zone}/machineTypes/${machineType}`,
+      minCpuPlatform: 'Intel Skylake',
+      disks: [disk],
+      networkInterfaces: [networkInterface],
+      reservationAffinity,
+    });
+
+    const [response] = await instancesClient.insert({
+      project: projectId,
+      instanceResource: instance,
+      zone,
+    });
+
+    let operation = response.latestResponse;
+
+    // Wait for the create instance operation to complete.
+    while (operation.status !== 'DONE') {
+      [operation] = await zoneOperationsClient.wait({
+        operation: operation.name,
+        project: projectId,
+        zone: operation.zone.split('/').pop(),
+      });
+    }
+
+    console.log(`Instance ${instanceName} created.`);
+  }
+
+  await callCreateInstanceToConsumeAnyReservation();
+  // [END compute_consume_any_matching_reservation]
+}
+
+main(...process.argv.slice(2)).catch(err => {
+  console.error(err);
+  process.exitCode = 1;
+});

compute/reservations/createInstanceToConsumeSingleProjectReservation.js

@@ -0,0 +1,110 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+async function main(instanceName, reservationName) {
+  // [START compute_consume_single_project_reservation]
+  // Import the Compute library
+  const computeLib = require('@google-cloud/compute');
+  const compute = computeLib.protos.google.cloud.compute.v1;
+
+  // Instantiate a reservationsClient
+  const instancesClient = new computeLib.InstancesClient();
+  // Instantiate a zoneOperationsClient
+  const zoneOperationsClient = new computeLib.ZoneOperationsClient();
+
+  /**
+   * TODO(developer): Update/uncomment these variables before running the sample.
+   */
+  // The ID of the project where you want to create instance.
+  const projectId = await instancesClient.getProjectId();
+  // The zone in which to create instance.
+  const zone = 'us-central1-a';
+  // The name of the instance to create.
+  // const instanceName = 'instance-01';
+  // The name of the reservation to consume.
+  // Ensure that the specificReservationRequired field in reservation properties is set to true.
+  // const reservationName = 'reservation-01';
+  // Machine type to use for VM.
+  const machineType = 'n1-standard-4';
+
+  // Create instance to consume a specific single-project reservation
+  async function callCreateInstanceToConsumeSingleProjectReservation() {
+    // Describe the size and source image of the boot disk to attach to the instance.
+    // 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
+    const disk = new compute.Disk({
+      boot: true,
+      autoDelete: true,
+      type: 'PERSISTENT',
+      initializeParams: {
+        diskSizeGb: '10',
+        sourceImage: 'projects/debian-cloud/global/images/family/debian-12',
+      },
+    });
+
+    //  Define networkInterface
+    const networkInterface = new compute.NetworkInterface({
+      name: 'global/networks/default',
+    });
+
+    // Define reservationAffinity
+    const reservationAffinity = new compute.ReservationAffinity({
+      consumeReservationType: 'SPECIFIC_RESERVATION',
+      key: 'compute.googleapis.com/reservation-name',
+      values: [reservationName],
+    });
+
+    // Create an instance
+    const instance = new compute.Instance({
+      name: instanceName,
+      machineType: `zones/${zone}/machineTypes/${machineType}`,
+      minCpuPlatform: 'Intel Skylake',
+      disks: [disk],
+      networkInterfaces: [networkInterface],
+      reservationAffinity,
+    });
+
+    const [response] = await instancesClient.insert({
+      project: projectId,
+      instanceResource: instance,
+      zone,
+    });
+
+    let operation = response.latestResponse;
+
+    // Wait for the create instance operation to complete.
+    while (operation.status !== 'DONE') {
+      [operation] = await zoneOperationsClient.wait({
+        operation: operation.name,
+        project: projectId,
+        zone: operation.zone.split('/').pop(),
+      });
+    }
+
+    console.log(`Instance ${instanceName} created.`);
+  }
+
+  await callCreateInstanceToConsumeSingleProjectReservation();
+  // [END compute_consume_single_project_reservation]
+}
+
+main(...process.argv.slice(2)).catch(err => {
+  console.error(err);
+  process.exitCode = 1;
+});

compute/reservations/createInstanceToNotConsumeReservation.js

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+async function main(instanceName) {
+  // [START compute_instance_not_consume_reservation]
+  // Import the Compute library
+  const computeLib = require('@google-cloud/compute');
+  const compute = computeLib.protos.google.cloud.compute.v1;
+
+  // Instantiate a reservationsClient
+  const instancesClient = new computeLib.InstancesClient();
+  // Instantiate a zoneOperationsClient
+  const zoneOperationsClient = new computeLib.ZoneOperationsClient();
+
+  /**
+   * TODO(developer): Update/uncomment these variables before running the sample.
+   */
+  // The ID of the project where you want to create instance.
+  const projectId = await instancesClient.getProjectId();
+  // The zone in which to create instance.
+  const zone = 'us-central1-a';
+  // The name of the instance to create.
+  // const instanceName = 'instance-01';
+  // Machine type to use for VM.
+  const machineType = 'n1-standard-4';
+
+  // Create a VM that explicitly doesn't consume reservations
+  async function callCreateInstanceToNotConsumeReservation() {
+    // Describe the size and source image of the boot disk to attach to the instance.
+    const disk = new compute.Disk({
+      boot: true,
+      autoDelete: true,
+      type: 'PERSISTENT',
+      initializeParams: {
+        diskSizeGb: '10',
+        sourceImage: 'projects/debian-cloud/global/images/family/debian-12',
+      },
+    });
+
+    //  Define networkInterface
+    const networkInterface = new compute.NetworkInterface({
+      name: 'global/networks/default',
+    });
+
+    // Define reservationAffinity
+    const reservationAffinity = new compute.ReservationAffinity({
+      consumeReservationType: 'NO_RESERVATION',
+    });
+
+    // Create an instance
+    const instance = new compute.Instance({
+      name: instanceName,
+      machineType: `zones/${zone}/machineTypes/${machineType}`,
+      minCpuPlatform: 'Intel Skylake',
+      disks: [disk],
+      networkInterfaces: [networkInterface],
+      reservationAffinity,
+    });
+
+    const [response] = await instancesClient.insert({
+      project: projectId,
+      instanceResource: instance,
+      zone,
+    });
+
+    let operation = response.latestResponse;
+
+    // Wait for the create instance operation to complete.
+    while (operation.status !== 'DONE') {
+      [operation] = await zoneOperationsClient.wait({
+        operation: operation.name,
+        project: projectId,
+        zone: operation.zone.split('/').pop(),
+      });
+    }
+
+    console.log(`Instance ${instanceName} created.`);
+  }
+
+  await callCreateInstanceToNotConsumeReservation();
+  // [END compute_instance_not_consume_reservation]
+}
+
+main(...process.argv.slice(2)).catch(err => {
+  console.error(err);
+  process.exitCode = 1;
+});

compute/reservations/createReservationFromProperties.js

@@ -50,25 +50,25 @@ async function main(reservationName) {
         // To have the reserved VMs use a specific minimum CPU platform instead of the zone's default CPU platform.
         minCpuPlatform: 'Intel Skylake',
         // If you want to attach GPUs to your reserved N1 VMs, update and uncomment guestAccelerators if needed.
-        guestAccelerators: [
-          {
-            // The number of GPUs to add per reserved VM.
-            acceleratorCount: 1,
-            // Supported GPU model for N1 VMs. Ensure that your chosen GPU model is available in the zone,
-            // where you want to reserve resources.
-            acceleratorType: 'nvidia-tesla-t4',
-          },
-        ],
+        // guestAccelerators: [
+        //   {
+        //     // The number of GPUs to add per reserved VM.
+        //     acceleratorCount: 1,
+        //     // Supported GPU model for N1 VMs. Ensure that your chosen GPU model is available in the zone,
+        //     // where you want to reserve resources.
+        //     acceleratorType: 'nvidia-tesla-t4',
+        //   },
+        // ],
         // If you want to add local SSD disks to each reserved VM, update and uncomment localSsds if needed.
         // You can specify up to 24 Local SSD disks. Each Local SSD disk is 375 GB.
-        localSsds: [
-          {
-            diskSizeGb: 375,
-            // The type of interface you want each Local SSD disk to use. Specify one of the following values: NVME or SCSI.
-            // Make sure that the machine type you specify for the reserved VMs supports the chosen disk interfaces.
-            interface: 'NVME',
-          },
-        ],
+        // localSsds: [
+        //   {
+        //     diskSizeGb: 375,
+        //     // The type of interface you want each Local SSD disk to use. Specify one of the following values: NVME or SCSI.
+        //     // Make sure that the machine type you specify for the reserved VMs supports the chosen disk interfaces.
+        //     interface: 'NVME',
+        //   },
+        // ],
       },
     });
 
@@ -77,6 +77,9 @@ async function main(reservationName) {
       name: reservationName,
       zone,
       specificReservation,
+      // To specify that only VMs that specifically target this reservation can consume it,
+      // set specificReservationRequired field to true.
+      specificReservationRequired: true,
     });
 
     const [response] = await reservationsClient.insert({

compute/reservations/createReservationInstanceTemplate.js

@@ -68,6 +68,9 @@ async function main(reservationName, location, instanceTemplateName) {
     const reservation = new compute.Reservation({
       name: reservationName,
       specificReservation,
+      // To specify that only VMs that specifically target this reservation can consume it,
+      // set specificReservationRequired field to true.
+      specificReservationRequired: true,
     });
 
     const [response] = await reservationsClient.insert({