feat: Create regional replicated Sample (GoogleCloudPlatform#12982)

* Created regional replicated disk Sample. Updated tests.

Author: Thoughtseize1

compute/client_library/ingredients/disks/create_replicated_disk.py

@@ -0,0 +1,60 @@
+#  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
+#
+#      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.
+
+# 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_replicated_disk>
+def create_regional_replicated_disk(
+    project_id,
+    region,
+    disk_name,
+    size_gb,
+    disk_type: str = "pd-ssd",
+) -> compute_v1.Disk:
+    """Creates a synchronously replicated disk in a region across two zones.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the disk will be created.
+        disk_name (str): The name of the disk.
+        size_gb (int): The size of the disk in gigabytes.
+        disk_type (str): The type of the disk. Default is 'pd-ssd'.
+    Returns:
+        compute_v1.Disk: The created disk object.
+    """
+    disk = compute_v1.Disk()
+    disk.name = disk_name
+
+    # You can specify the zones where the disk will be replicated.
+    disk.replica_zones = [
+        f"zones/{region}-a",
+        f"zones/{region}-b",
+    ]
+    disk.size_gb = size_gb
+    disk.type = f"regions/{region}/diskTypes/{disk_type}"
+
+    client = compute_v1.RegionDisksClient()
+    operation = client.insert(project=project_id, region=region, disk_resource=disk)
+
+    wait_for_extended_operation(operation, "Replicated disk creation")
+
+    return client.get(project=project_id, region=region, disk=disk_name)
+
+
+# </INGREDIENT>

compute/client_library/recipes/disks/create_replicated_disk.py

@@ -0,0 +1,23 @@
+#  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
+#
+#      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.
+# flake8: noqa
+
+# <REGION compute_disk_regional_replicated>
+# <IMPORTS/>
+
+# <INGREDIENT wait_for_extended_operation />
+
+# <INGREDIENT create_replicated_disk />
+
+# </REGION compute_disk_regional_replicated>

compute/client_library/snippets/disks/create_replicated_disk.py

@@ -0,0 +1,116 @@
+#  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
+#
+#      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.
+# flake8: noqa
+
+
+# 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_disk_regional_replicated]
+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_regional_replicated_disk(
+    project_id,
+    region,
+    disk_name,
+    size_gb,
+    disk_type: str = "pd-ssd",
+) -> compute_v1.Disk:
+    """Creates a synchronously replicated disk in a region across two zones.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the disk will be created.
+        disk_name (str): The name of the disk.
+        size_gb (int): The size of the disk in gigabytes.
+        disk_type (str): The type of the disk. Default is 'pd-ssd'.
+    Returns:
+        compute_v1.Disk: The created disk object.
+    """
+    disk = compute_v1.Disk()
+    disk.name = disk_name
+
+    # You can specify the zones where the disk will be replicated.
+    disk.replica_zones = [
+        f"zones/{region}-a",
+        f"zones/{region}-b",
+    ]
+    disk.size_gb = size_gb
+    disk.type = f"regions/{region}/diskTypes/{disk_type}"
+
+    client = compute_v1.RegionDisksClient()
+    operation = client.insert(project=project_id, region=region, disk_resource=disk)
+
+    wait_for_extended_operation(operation, "Replicated disk creation")
+
+    return client.get(project=project_id, region=region, disk=disk_name)
+
+
+# [END compute_disk_regional_replicated]

compute/client_library/snippets/tests/test_disks.py

@@ -28,6 +28,7 @@
 from ..disks.create_hyperdisk_from_pool import create_hyperdisk_from_pool
 from ..disks.create_hyperdisk_storage_pool import create_hyperdisk_storage_pool
 from ..disks.create_kms_encrypted_disk import create_kms_encrypted_disk
+from ..disks.create_replicated_disk import create_regional_replicated_disk
 from ..disks.create_secondary_custom import create_secondary_custom_disk
 from ..disks.create_secondary_disk import create_secondary_disk
 from ..disks.create_secondary_region_disk import create_secondary_region_disk
@@ -447,6 +448,17 @@ def test_create_custom_secondary_disk(
     assert disk.labels["source-disk"] == test_empty_pd_balanced_disk.name
 
 
+def test_create_replicated_disk(autodelete_regional_disk_name):
+    disk = create_regional_replicated_disk(
+        project_id=PROJECT,
+        region=REGION_SECONDARY,
+        disk_name=autodelete_regional_disk_name,
+        size_gb=DISK_SIZE,
+    )
+    assert f"{PROJECT}/zones/{REGION_SECONDARY}-" in disk.replica_zones[0]
+    assert f"{PROJECT}/zones/{REGION_SECONDARY}-" in disk.replica_zones[1]
+
+
 def test_start_stop_region_replication(
     autodelete_regional_blank_disk, autodelete_regional_disk_name
 ):