feat: New Compute reservation Sample (#12781)

Thoughtseize1 · web-flow · commit db6cba20ee8a · 2024-11-25T13:43:15.000+01:00
* Created new compute_template_not_consume_reservation
diff --git a/compute/client_library/ingredients/compute_reservation/create_vm_template_not_consume_reservation.py b/compute/client_library/ingredients/compute_reservation/create_vm_template_not_consume_reservation.py
@@ -0,0 +1,79 @@
+# 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.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+
+# <INGREDIENT create_template_not_consume_reservation>
+def create_instance_template_not_consume_reservation(
+    project_id: str,
+    template_name: str,
+    machine_type: str = "n1-standard-1",
+) -> compute_v1.InstanceTemplate:
+    """
+    Creates an instance template that creates VMs that don't explicitly consume reservations
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        template_name: name of the new template to create.
+        machine_type: machine type for the instance.
+    Returns:
+        InstanceTemplate object that represents the new instance template.
+    """
+
+    template = compute_v1.InstanceTemplate()
+    template.name = template_name
+    template.properties.machine_type = machine_type
+    # The template describes the size and source image of the boot disk
+    # to attach to the instance.
+    template.properties.disks = [
+        compute_v1.AttachedDisk(
+            boot=True,
+            auto_delete=True,  # The disk will be deleted when the instance is deleted
+            initialize_params=compute_v1.AttachedDiskInitializeParams(
+                source_image="projects/debian-cloud/global/images/family/debian-11",
+                disk_size_gb=10,
+            ),
+        )
+    ]
+    # The template connects the instance to the `default` network,
+    template.properties.network_interfaces = [
+        compute_v1.NetworkInterface(
+            network="global/networks/default",
+            access_configs=[
+                compute_v1.AccessConfig(
+                    name="External NAT",
+                    type="ONE_TO_ONE_NAT",
+                )
+            ],
+        )
+    ]
+    # The template doesn't explicitly consume reservations
+    template.properties.reservation_affinity = compute_v1.ReservationAffinity(
+        consume_reservation_type="NO_RESERVATION"
+    )
+
+    template_client = compute_v1.InstanceTemplatesClient()
+    operation = template_client.insert(
+        project=project_id, instance_template_resource=template
+    )
+
+    wait_for_extended_operation(operation, "instance template creation")
+
+    return template_client.get(project=project_id, instance_template=template_name)
+# </INGREDIENT>
diff --git a/compute/client_library/recipes/compute_reservations/create_vm_template_not_consume_reservation.py b/compute/client_library/recipes/compute_reservations/create_vm_template_not_consume_reservation.py
@@ -0,0 +1,21 @@
+# 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.
+
+# <REGION compute_template_not_consume_reservation>
+# <IMPORTS/>
+
+# <INGREDIENT wait_for_extended_operation />
+
+# <INGREDIENT create_template_not_consume_reservation />
+# </REGION compute_template_not_consume_reservation>
diff --git a/compute/client_library/snippets/compute_reservations/create_vm_template_not_consume_reservation.py b/compute/client_library/snippets/compute_reservations/create_vm_template_not_consume_reservation.py
@@ -0,0 +1,137 @@
+# 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.
+
+
+# This file is automatically generated. Please do not modify it directly.
+# Find the relevant recipe file in the samples/recipes or samples/ingredients
+# directory and apply your changes there.
+
+
+# [START compute_template_not_consume_reservation]
+from __future__ import annotations
+
+import sys
+from typing import Any
+
+from google.api_core.extended_operation import ExtendedOperation
+from google.cloud import compute_v1
+
+
+def wait_for_extended_operation(
+    operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300
+) -> Any:
+    """
+    Waits for the extended (long-running) operation to complete.
+
+    If the operation is successful, it will return its result.
+    If the operation ends with an error, an exception will be raised.
+    If there were any warnings during the execution of the operation
+    they will be printed to sys.stderr.
+
+    Args:
+        operation: a long-running operation you want to wait on.
+        verbose_name: (optional) a more verbose name of the operation,
+            used only during error and warning reporting.
+        timeout: how long (in seconds) to wait for operation to finish.
+            If None, wait indefinitely.
+
+    Returns:
+        Whatever the operation.result() returns.
+
+    Raises:
+        This method will raise the exception received from `operation.exception()`
+        or RuntimeError if there is no exception set, but there is an `error_code`
+        set for the `operation`.
+
+        In case of an operation taking longer than `timeout` seconds to complete,
+        a `concurrent.futures.TimeoutError` will be raised.
+    """
+    result = operation.result(timeout=timeout)
+
+    if operation.error_code:
+        print(
+            f"Error during {verbose_name}: [Code: {operation.error_code}]: {operation.error_message}",
+            file=sys.stderr,
+            flush=True,
+        )
+        print(f"Operation ID: {operation.name}", file=sys.stderr, flush=True)
+        raise operation.exception() or RuntimeError(operation.error_message)
+
+    if operation.warnings:
+        print(f"Warnings during {verbose_name}:\n", file=sys.stderr, flush=True)
+        for warning in operation.warnings:
+            print(f" - {warning.code}: {warning.message}", file=sys.stderr, flush=True)
+
+    return result
+
+
+def create_instance_template_not_consume_reservation(
+    project_id: str,
+    template_name: str,
+    machine_type: str = "n1-standard-1",
+) -> compute_v1.InstanceTemplate:
+    """
+    Creates an instance template that creates VMs that don't explicitly consume reservations
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        template_name: name of the new template to create.
+        machine_type: machine type for the instance.
+    Returns:
+        InstanceTemplate object that represents the new instance template.
+    """
+
+    template = compute_v1.InstanceTemplate()
+    template.name = template_name
+    template.properties.machine_type = machine_type
+    # The template describes the size and source image of the boot disk
+    # to attach to the instance.
+    template.properties.disks = [
+        compute_v1.AttachedDisk(
+            boot=True,
+            auto_delete=True,  # The disk will be deleted when the instance is deleted
+            initialize_params=compute_v1.AttachedDiskInitializeParams(
+                source_image="projects/debian-cloud/global/images/family/debian-11",
+                disk_size_gb=10,
+            ),
+        )
+    ]
+    # The template connects the instance to the `default` network,
+    template.properties.network_interfaces = [
+        compute_v1.NetworkInterface(
+            network="global/networks/default",
+            access_configs=[
+                compute_v1.AccessConfig(
+                    name="External NAT",
+                    type="ONE_TO_ONE_NAT",
+                )
+            ],
+        )
+    ]
+    # The template doesn't explicitly consume reservations
+    template.properties.reservation_affinity = compute_v1.ReservationAffinity(
+        consume_reservation_type="NO_RESERVATION"
+    )
+
+    template_client = compute_v1.InstanceTemplatesClient()
+    operation = template_client.insert(
+        project=project_id, instance_template_resource=template
+    )
+
+    wait_for_extended_operation(operation, "instance template creation")
+
+    return template_client.get(project=project_id, instance_template=template_name)
+
+
+# [END compute_template_not_consume_reservation]
diff --git a/compute/client_library/snippets/tests/test_compute_reservation.py b/compute/client_library/snippets/tests/test_compute_reservation.py
@@ -39,11 +39,13 @@
 from ..compute_reservations.create_not_consume_reservation import (
     create_vm_not_consume_reservation,
 )
+from ..compute_reservations.create_vm_template_not_consume_reservation import (
+    create_instance_template_not_consume_reservation,
+)
 from ..compute_reservations.delete_compute_reservation import delete_compute_reservation
 from ..compute_reservations.get_compute_reservation import get_compute_reservation
 from ..compute_reservations.list_compute_reservation import list_compute_reservation
 
-
 from ..instances.create import create_instance
 from ..instances.delete import delete_instance
 
@@ -223,6 +225,25 @@ def test_consume_shared_reservaton():
         delete_compute_reservation(PROJECT_ID, ZONE, RESERVATION_NAME)
 
 
+def test_create_template_not_consume_reservation():
+    template_name = "test-template-" + uuid.uuid4().hex[:10]
+    try:
+        template = create_instance_template_not_consume_reservation(
+            PROJECT_ID, template_name, MACHINE_TYPE
+        )
+        assert (
+            template.properties.reservation_affinity.consume_reservation_type
+            == "NO_RESERVATION"
+        )
+    finally:
+        try:
+            compute_v1.InstanceTemplatesClient().delete(
+                project=PROJECT_ID, instance_template=template_name
+            )
+        except Exception as e:
+            print(f"Failed to delete template: {e}")
+
+
 def test_create_vm_not_consume_reservations():
     instance = create_vm_not_consume_reservation(
         PROJECT_ID, ZONE, INSTANCE_NAME, MACHINE_TYPE
