Ingredient and recipe

Author: Thoughtseize1

compute/client_library/ingredients/compute_reservation/create_compute_shared_reservation.py

@@ -0,0 +1,95 @@
+# 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_compute_shared_reservation>
+def create_compute_shared_reservation(
+    project_id: str,
+    zone: str = "us-central1-a",
+    reservation_name="your-reservation-name",
+    shared_project_id: str = "shared-project-id",
+) -> compute_v1.Reservation:
+    """Creates a compute reservation in GCP.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        zone (str): The zone to create the reservation.
+        reservation_name (str): The name of the reservation to create.
+        shared_project_id (str): The ID of the project that the reservation is shared with.
+    Returns:
+        Reservation object that represents the new reservation.
+    """
+
+    instance_properties = compute_v1.AllocationSpecificSKUAllocationReservedInstanceProperties(
+        machine_type="n1-standard-1",
+        # Optional. Specifies amount of local ssd to reserve with each instance.
+        local_ssds=[
+            compute_v1.AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk(
+                disk_size_gb=375, interface="NVME"
+            ),
+        ],
+    )
+
+    reservation = compute_v1.Reservation(
+        name=reservation_name,
+        specific_reservation=compute_v1.AllocationSpecificSKUReservation(
+            count=3,  # Number of resources that are allocated.
+            # If you use source_instance_template, you must exclude the instance_properties field.
+            # It can be a full or partial URL.
+            # source_instance_template="projects/[PROJECT_ID]/global/instanceTemplates/my-instance-template",
+            instance_properties=instance_properties,
+        ),
+        share_settings=compute_v1.ShareSettings(
+            share_type="SPECIFIC_PROJECTS",
+            project_map={
+                shared_project_id: compute_v1.ShareSettingsProjectConfig(
+                    project_id=shared_project_id
+                )
+            },
+        ),
+    )
+
+    # Create a client
+    client = compute_v1.ReservationsClient()
+
+    operation = client.insert(
+        project=project_id,
+        zone=zone,
+        reservation_resource=reservation,
+    )
+    wait_for_extended_operation(operation, "Reservation creation")
+
+    reservation = client.get(
+        project=project_id, zone=zone, reservation=reservation_name
+    )
+    shared_project = next(iter(reservation.share_settings.project_map.values()))
+
+    print("Name: ", reservation.name)
+    print("STATUS: ", reservation.status)
+    print("SHARED PROJECT: ", shared_project)
+    # Example response:
+    # Name:  your-reservation-name
+    # STATUS:  READY
+    # SHARED PROJECT:  project_id: "123456789012"
+
+    return reservation
+
+
+# </INGREDIENT>

compute/client_library/recipes/compute_reservations/create_compute_shared_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_reservation_create_shared>
+# <IMPORTS/>
+
+# <INGREDIENT wait_for_extended_operation />
+
+# <INGREDIENT create_compute_shared_reservation />
+# </REGION compute_reservation_create_shared>