chore(samples): add custom machine type samples (#742)

compute/instances/custom-machine-type/createWithHelper.js

@@ -0,0 +1,256 @@
+// Copyright 2022 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
+//
+//      http://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.
+
+/**
+ * Creates a new VM instance with a custom machine type.
+ *
+ * @param {string} projectId - ID or number of the project you want to use.
+ * @param {string} zone - Name of the zone you want to use, for example: us-west3-b
+ * @param {string} instanceName - Name of the new machine.
+ * @param {string} cpuSeries - Type of CPU you want to use.
+ * @param {int} coreCount - Number of CPU cores you want to use.
+ * @param {int} memory - The amount of memory for the VM instance, in megabytes.
+ */
+function main(projectId, zone, instanceName, cpuSeries, coreCount, memory) {
+  // [START compute_custom_machine_type_create_with_helper]
+  /**
+   * TODO(developer): Uncomment and replace these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const zone = 'europe-central2-b';
+  // const instanceName = 'YOUR_INSTANCE_NAME';
+  // const cpuSeries = 'N1';
+  // const coreCount = 2
+  // const memory = 256
+
+  const compute = require('@google-cloud/compute');
+
+  function range(from, to, step) {
+    return [...Array(Math.floor((to - from) / step) + 1)].map(
+      (_, i) => from + i * step
+    );
+  }
+
+  class CustomMachineType {
+    constructor(zone, cpuSeries, coreCount, memory) {
+      this.zone = zone;
+      this.cpuSeries = cpuSeries;
+      this.coreCount = coreCount;
+      this.memory = memory;
+
+      this.N1 = 'custom';
+      this.N2 = 'n2-custom';
+      this.N2D = 'n2d-custom';
+      this.E2 = 'e2-custom';
+      this.E2Micro = 'e2-custom-micro';
+      this.E2Small = 'e2-custom-small';
+      this.E2Medium = 'e2-custom-medium';
+
+      this.CpuSeriesE2Limit = {
+        allowedCores: range(2, 33, 2),
+        minMemPerCore: 512,
+        maxMemPerCore: 8192,
+        allowExtraMemory: false,
+        extraMemoryLimit: 0,
+      };
+
+      this.CpuSeriesE2MicroLimit = {
+        allowedCores: [],
+        minMemPerCore: 1024,
+        maxMemPerCore: 2048,
+        allowExtraMemory: false,
+        extraMemoryLimit: 0,
+      };
+
+      this.CpuSeriesE2SmallLimit = {
+        allowedCores: [],
+        minMemPerCore: 2048,
+        maxMemPerCore: 4096,
+        allowExtraMemory: false,
+        extraMemoryLimit: 0,
+      };
+
+      this.CpuSeriesE2MediumLimit = {
+        allowedCores: [],
+        minMemPerCore: 4096,
+        maxMemPerCore: 8192,
+        allowExtraMemory: false,
+        extraMemoryLimit: 0,
+      };
+
+      this.CpuSeriesN2Limit = {
+        allowedCores: [...range(2, 33, 2), ...range(36, 129, 4)],
+        minMemPerCore: 512,
+        maxMemPerCore: 8192,
+        allowExtraMemory: true,
+        extraMemoryLimit: 624 << 10,
+      };
+
+      this.CpuSeriesN2DLimit = {
+        allowedCores: [2, 4, 8, 16, 32, 48, 64, 80, 96],
+        minMemPerCore: 512,
+        maxMemPerCore: 8192,
+        allowExtraMemory: true,
+        extraMemoryLimit: 768 << 10,
+      };
+
+      this.CpuSeriesN1Limit = {
+        allowedCores: [1, range(2, 97, 2)],
+        minMemPerCore: 922,
+        maxMemPerCore: 6656,
+        allowExtraMemory: true,
+        extraMemoryLimit: 624 << 10,
+      };
+
+      this.TYPE_LIMITS = {
+        [this.N1]: this.CpuSeriesN1Limit,
+        [this.N2]: this.CpuSeriesN2Limit,
+        [this.N2D]: this.CpuSeriesN2DLimit,
+        [this.E2]: this.CpuSeriesE2Limit,
+        [this.E2Micro]: this.CpuSeriesE2MicroLimit,
+        [this.E2Small]: this.CpuSeriesE2SmallLimit,
+        [this.E2Medium]: this.CpuSeriesE2MediumLimit,
+      };
+
+      if (![this.E2, this.N1, this.N2, this.N2D].includes(cpuSeries)) {
+        throw new Error(`Incorrect CPU type: ${this.cpuSeries}`);
+      }
+
+      this.typeLimit = this.TYPE_LIMITS[this.cpuSeries];
+
+      // Check whether the requested parameters are allowed.
+      // Find more information about limitations of custom machine types at:
+      // https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types
+
+      // Check the number of cores
+      if (
+        this.typeLimit.allowedCores.length > 0 &&
+        !this.typeLimit.allowedCores.includes(coreCount)
+      ) {
+        throw new Error(
+          `Invalid number of cores requested. Allowed number of cores for ${this.cpuSeries} is: ${this.typeLimit.allowedCores}`
+        );
+      }
+
+      // Memory must be a multiple of 256 MB
+      if (this.memory % 256 !== 0) {
+        throw new Error('Requested memory must be a multiple of 256 MB');
+      }
+
+      // Check if the requested memory isn't too little
+      if (this.memory < this.coreCount * this.typeLimit.minMemPerCore) {
+        throw new Error(
+          `Requested memory is too low. Minimal memory for ${this.cpuSeries} is ${this.typeLimit.minMemPerCore} MB per core`
+        );
+      }
+
+      // Check if the requested memory isn't too much
+      if (
+        this.memory > this.coreCount * this.typeLimit.maxMemPerCore &&
+        !this.typeLimit.allowExtraMemory
+      ) {
+        throw new Error(
+          `Requested memory is too large.. Maximum memory allowed for ${this.cpuSeries} is ${this.typeLimit.maxMemPerCore} MB per core`
+        );
+      }
+
+      if (
+        this.memory > this.typeLimit.extraMemoryLimit &&
+        this.typeLimit.allowExtraMemory
+      ) {
+        throw new Error(
+          `Requested memory is too large.. Maximum memory allowed for ${this.cpuSeries} is ${this.typeLimit.extraMemoryLimit} MB`
+        );
+      }
+    }
+
+    // Returns the custom machine type in form of a string acceptable by Compute Engine API.
+    getMachineTypeURI() {
+      if (
+        [this.E2Small, this.E2Micro, this.E2Medium].includes(this.cpuSeries)
+      ) {
+        return `zones/${this.zone}/machineTypes/${this.cpuSeries}-${this.memory}`;
+      }
+
+      if (this.memory > this.coreCount * this.typeLimit.maxMemPerCore) {
+        return `zones/${this.zone}/machineTypes/${this.cpuSeries}-${this.coreCount}-${this.memory}-ext`;
+      }
+
+      return `zones/${zone}/machineTypes/${this.cpuSeries}-${this.coreCount}-${this.memory}`;
+    }
+  }
+
+  async function createInstanceWithCustomMachineTypeWithHelper() {
+    const instancesClient = new compute.InstancesClient();
+
+    const machineType = new CustomMachineType(
+      zone,
+      cpuSeries,
+      coreCount,
+      memory
+    ).getMachineTypeURI();
+
+    const [response] = await instancesClient.insert({
+      instanceResource: {
+        name: instanceName,
+        disks: [
+          {
+            initializeParams: {
+              diskSizeGb: '64',
+              sourceImage:
+                'projects/debian-cloud/global/images/family/debian-11/',
+            },
+            autoDelete: true,
+            boot: true,
+          },
+        ],
+        machineType,
+        networkInterfaces: [
+          {
+            name: 'global/networks/default',
+          },
+        ],
+      },
+      project: projectId,
+      zone,
+    });
+    let operation = response.latestResponse;
+    const operationsClient = new compute.ZoneOperationsClient();
+
+    // Wait for the create operation to complete.
+    while (operation.status !== 'DONE') {
+      [operation] = await operationsClient.wait({
+        operation: operation.name,
+        project: projectId,
+        zone: operation.zone.split('/').pop(),
+      });
+    }
+
+    console.log('Instance created.');
+  }
+
+  createInstanceWithCustomMachineTypeWithHelper();
+  // [END compute_custom_machine_type_create_with_helper]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+const args = process.argv.slice(2);
+args[4] = parseInt(args[4]);
+args[5] = parseInt(args[5]);
+
+main(...args);

compute/instances/custom-machine-type/createWithoutHelper.js

@@ -0,0 +1,96 @@
+// Copyright 2022 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
+//
+//      http://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.
+
+/**
+ * Creates new VM instances without using a CustomMachineType class.
+ *
+ * @param {string} projectId - ID or number of the project you want to use.
+ * @param {string} zone - Name of the zone you want to use, for example: us-west3-b
+ * @param {string} instanceName - Name of the new machine.
+ * @param {string} cpuSeries - Type of CPU you want to use.
+ * @param {int} coreCount - Number of CPU cores you want to use.
+ * @param {int} memory - The amount of memory for the VM instance, in megabytes.
+ */
+function main(projectId, zone, instanceName, cpuSeries, coreCount, memory) {
+  // [START compute_custom_machine_type_create_without_helper]
+  /**
+   * TODO(developer): Uncomment and replace these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const zone = 'europe-central2-b';
+  // const instanceName = 'YOUR_INSTANCE_NAME';
+  // const cpuSeries = 'N1';
+  // const coreCount = 2
+  // const memory = 256
+
+  const compute = require('@google-cloud/compute');
+
+  async function createWithoutHelper() {
+    const instancesClient = new compute.InstancesClient();
+
+    const machineType = `zones/${zone}/machineTypes/${cpuSeries}-${coreCount}-${memory}`;
+
+    const [response] = await instancesClient.insert({
+      instanceResource: {
+        name: instanceName,
+        disks: [
+          {
+            initializeParams: {
+              diskSizeGb: '64',
+              sourceImage:
+                'projects/debian-cloud/global/images/family/debian-11/',
+            },
+            autoDelete: true,
+            boot: true,
+          },
+        ],
+        machineType,
+        networkInterfaces: [
+          {
+            name: 'global/networks/default',
+          },
+        ],
+      },
+      project: projectId,
+      zone,
+    });
+    let operation = response.latestResponse;
+    const operationsClient = new compute.ZoneOperationsClient();
+
+    // Wait for the create operation to complete.
+    while (operation.status !== 'DONE') {
+      [operation] = await operationsClient.wait({
+        operation: operation.name,
+        project: projectId,
+        zone: operation.zone.split('/').pop(),
+      });
+    }
+
+    console.log('Instance created.');
+  }
+
+  createWithoutHelper();
+  // [END compute_custom_machine_type_create_without_helper]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+const args = process.argv.slice(2);
+args[4] = parseInt(args[4]);
+args[5] = parseInt(args[5]);
+
+main(...args);