feat: tpu_queued_resources_create/delete_force/delete/get/list

tpu/package.json

@@ -21,4 +21,4 @@
     "c8": "^10.0.0",
     "mocha": "^10.0.0"
   }
-}
+}

tpu/queuedResources/createQueuedResource.js

@@ -0,0 +1,124 @@
+/*
+ * 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(tpuClient) {
+  // [START tpu_queued_resources_create]
+  // Import the TPUClient
+  // TODO(developer): Uncomment below line before running the sample.
+  // const {TpuClient} = require('@google-cloud/tpu').v2alpha1;
+  const {Node, NetworkConfig, QueuedResource} =
+    require('@google-cloud/tpu').protos.google.cloud.tpu.v2alpha1;
+
+  // Instantiate a tpuClient
+  // TODO(developer): Uncomment below line before running the sample.
+  // tpuClient = new TpuClient();
+
+  /**
+   * TODO(developer): Update these variables before running the sample.
+   */
+  // Project ID or project number of the Google Cloud project, where you want to create queued resource.
+  const projectId = await tpuClient.getProjectId();
+
+  // The name of the network you want the node to connect to. The network should be assigned to your project.
+  const networkName = 'compute-tpu-network';
+
+  // The region of the subnetwork, that you want the node to connect to.
+  const region = 'us-central1';
+
+  // The name for your queued resource.
+  const queuedResourceName = 'queued-resource-1';
+
+  // The name for your node.
+  const nodeName = 'node-name-1';
+
+  // The zone in which to create the node.
+  // For more information about supported TPU types for specific zones,
+  // see https://cloud.google.com/tpu/docs/regions-zones
+  const zone = `${region}-f`;
+
+  // The accelerator type that specifies the version and size of the node you want to create.
+  // For more information about supported accelerator types for each TPU version,
+  // see https://cloud.google.com/tpu/docs/system-architecture-tpu-vm#versions.
+  const tpuType = 'v2-8';
+
+  // Software version that specifies the version of the node runtime to install. For more information,
+  // see https://cloud.google.com/tpu/docs/runtimes
+  const tpuSoftwareVersion = 'tpu-vm-tf-2.14.1';
+
+  async function callCreateQueuedResource() {
+    // Create a node
+    const node = new Node({
+      name: nodeName,
+      zone,
+      acceleratorType: tpuType,
+      runtimeVersion: tpuSoftwareVersion,
+      // Define network
+      networkConfig: new NetworkConfig({
+        enableExternalIps: true,
+        network: `projects/${projectId}/global/networks/${networkName}`,
+        subnetwork: `projects/${projectId}/regions/${region}/subnetworks/${networkName}`,
+      }),
+      queuedResource: `projects/${projectId}/locations/${zone}/queuedResources/${queuedResourceName}`,
+    });
+
+    // Define parent for requests
+    const parent = `projects/${projectId}/locations/${zone}`;
+
+    // Create queued resource
+    const queuedResource = new QueuedResource({
+      name: queuedResourceName,
+      tpu: {
+        nodeSpec: [
+          {
+            parent,
+            node,
+            nodeId: nodeName,
+          },
+        ],
+      },
+      // TODO(developer): Uncomment next line if you want to specify reservation.
+      // reservationName: 'reservation-name/ Before deleting the queued resource it is required to delete the TPU VM.'
+    });
+
+    const request = {
+      parent: `projects/${projectId}/locations/${zone}`,
+      queuedResource,
+      queuedResourceId: queuedResourceName,
+    };
+
+    const [operation] = await tpuClient.createQueuedResource(request);
+
+    // Wait for the create operation to complete.
+    const [response] = await operation.promise();
+
+    // You can wait until TPU Node is READY,
+    // and check its status using callGetTpuVm() from `tpu_vm_get` sample.
+    console.log(`Queued resource ${queuedResourceName} created.`);
+    return response;
+  }
+  return await callCreateQueuedResource();
+  // [END tpu_queued_resources_create]
+}
+
+module.exports = main;
+
+// TODO(developer): Uncomment below lines before running the sample.
+// main(...process.argv.slice(2)).catch(err => {
+//   console.error(err);
+//   process.exitCode = 1;
+// });

tpu/queuedResources/deleteQueuedResource.js

@@ -0,0 +1,84 @@
+/*
+ * 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(tpuClient) {
+  // [START tpu_queued_resources_delete]
+  // Import the TPUClient
+  // TODO(developer): Uncomment below line before running the sample.
+  // const {TpuClient} = require('@google-cloud/tpu').v2alpha1;
+
+  // Instantiate a tpuClient
+  // TODO(developer): Uncomment below line before running the sample.
+  // tpuClient = new TpuClient();
+
+  /**
+   * TODO(developer): Update these variables before running the sample.
+   */
+  // Project ID or project number of the Google Cloud project, where you want to delete node.
+  const projectId = await tpuClient.getProjectId();
+
+  // The name of queued resource.
+  const queuedResourceName = 'queued-resource-1';
+
+  // The zone of your queued resource.
+  const zone = 'us-central1-f';
+
+  async function callDeleteTpuVM(nodeName) {
+    const request = {
+      name: `projects/${projectId}/locations/${zone}/nodes/${nodeName}`,
+    };
+
+    const [operation] = await tpuClient.deleteNode(request);
+
+    // Wait for the delete operation to complete.
+    await operation.promise();
+
+    console.log(`Node: ${nodeName} deleted.`);
+  }
+
+  async function callDeleteQueuedResource() {
+    const request = {
+      name: `projects/${projectId}/locations/${zone}/queuedResources/${queuedResourceName}`,
+    };
+
+    // Retrive node name
+    const [queuedResource] = await tpuClient.getQueuedResource(request);
+    const nodeName = queuedResource.tpu.nodeSpec[0].nodeId;
+
+    // Before deleting the queued resource it is required to delete the TPU VM.
+    await callDeleteTpuVM(nodeName);
+
+    const [operation] = await tpuClient.deleteQueuedResource(request);
+
+    // Wait for the delete operation to complete.
+    const [response] = await operation.promise();
+
+    console.log(`Queued resource ${queuedResourceName} deleted.`);
+    return response;
+  }
+  return await callDeleteQueuedResource();
+  // [END tpu_queued_resources_delete]
+}
+
+module.exports = main;
+
+// TODO(developer): Uncomment below lines before running the sample.
+// main(...process.argv.slice(2)).catch(err => {
+//   console.error(err);
+//   process.exitCode = 1;
+// });

tpu/queuedResources/forceDeleteQueuedResource.js

@@ -0,0 +1,65 @@
+/*
+ * 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(tpuClient) {
+  // [START tpu_queued_resources_delete_force]
+  // Import the TPUClient
+  // TODO(developer): Uncomment below line before running the sample.
+  // const {TpuClient} = require('@google-cloud/tpu').v2alpha1;
+
+  // Instantiate a tpuClient
+  // TODO(developer): Uncomment below line before running the sample.
+  // tpuClient = new TpuClient();
+
+  /**
+   * TODO(developer): Update these variables before running the sample.
+   */
+  // Project ID or project number of the Google Cloud project, where you want to delete node.
+  const projectId = await tpuClient.getProjectId();
+
+  // The name of queued resource.
+  const queuedResourceName = 'queued-resource-1';
+
+  // The zone of your queued resource.
+  const zone = 'us-central1-f';
+
+  async function callForceDeleteQueuedResource() {
+    const request = {
+      name: `projects/${projectId}/locations/${zone}/queuedResources/${queuedResourceName}`,
+      force: true,
+    };
+
+    const [operation] = await tpuClient.deleteQueuedResource(request);
+
+    // Wait for the delete operation to complete.
+    const [response] = await operation.promise();
+
+    console.log(`Queued resource ${queuedResourceName} deletion forced.`);
+    return response;
+  }
+  return await callForceDeleteQueuedResource();
+  // [END tpu_queued_resources_delete_force]
+}
+
+module.exports = main;
+
+// TODO(developer): Uncomment below lines before running the sample.
+// main(...process.argv.slice(2)).catch(err => {
+//   console.error(err);
+//   process.exitCode = 1;
+// });

tpu/queuedResources/getQueuedResource.js

@@ -0,0 +1,61 @@
+/*
+ * 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(tpuClient) {
+  // [START tpu_queued_resources_get]
+  // Import the TPUClient
+  // TODO(developer): Uncomment below line before running the sample.
+  // const {TpuClient} = require('@google-cloud/tpu').v2alpha1;
+
+  // Instantiate a tpuClient
+  // TODO(developer): Uncomment below line before running the sample.
+  // tpuClient = new TpuClient();
+
+  /**
+   * TODO(developer): Update these variables before running the sample.
+   */
+  // Project ID or project number of the Google Cloud project, where you want to retrive node.
+  const projectId = await tpuClient.getProjectId();
+
+  // The name of queued resource.
+  const queuedResourceName = 'queued-resource-1';
+
+  // The zone of your queued resource.
+  const zone = 'us-central1-f';
+
+  async function callGetQueuedResource() {
+    const request = {
+      name: `projects/${projectId}/locations/${zone}/queuedResources/${queuedResourceName}`,
+    };
+
+    const [response] = await tpuClient.getQueuedResource(request);
+
+    console.log(`Queued resource ${queuedResourceName} retrived.`);
+    return response;
+  }
+  return await callGetQueuedResource();
+  // [END tpu_queued_resources_get]
+}
+
+module.exports = main;
+
+// TODO(developer): Uncomment below lines before running the sample.
+// main(...process.argv.slice(2)).catch(err => {
+//   console.error(err);
+//   process.exitCode = 1;
+// });