docs(samples): Adding template samples

samples/snippets/sample_templates.py

@@ -0,0 +1,195 @@
+# Copyright 2021 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.
+from typing import Iterable
+
+from google.cloud import compute_v1
+
+
+def get_instance_template(project_id: str, template_name: str) -> compute_v1.InstanceTemplate:
+    """
+    Retrieve information about given instance template.
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        template_name: name of the template you want to get.
+
+    Returns:
+        InstanceTemplate object containing information about given template.
+    """
+    template_client = compute_v1.InstanceTemplatesClient()
+    return template_client.get(project=project_id, instance_template=template_name)
+
+
+def list_instance_templates(project_id: str) -> Iterable[compute_v1.InstanceTemplate]:
+    """
+    Get a list of InstanceTemplate objects available in given project.
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+
+    Returns:
+        Iterable list of InstanceTemplate objects.
+    """
+    template_client = compute_v1.InstanceTemplatesClient()
+    return template_client.list(project=project_id)
+
+
+def create_template(project_id: str, template_name: str) -> compute_v1.InstanceTemplate:
+    """
+    Create a new template in given project with provided name.
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        template_name: name of the new template that is created.
+
+    Returns:
+        InstanceTemplate object describing the new instance template.
+    """
+    # Describe the size and source image of the boot disk to attach to the instance.
+    disk = compute_v1.AttachedDisk()
+    initialize_params = compute_v1.AttachedDiskInitializeParams()
+    initialize_params.source_image = (
+        "projects/debian-cloud/global/images/family/debian-11"
+    )
+    initialize_params.disk_size_gb = 250
+    disk.initialize_params = initialize_params
+    disk.auto_delete = True
+    disk.boot = True
+
+    # Use the default network, without specifying a subnetwork.
+    network_interface = compute_v1.NetworkInterface()
+    network_interface.name = "global/networks/default"
+
+    # Let the instance have external IP
+    network_interface.access_configs = [compute_v1.AccessConfig()]
+    network_interface.access_configs[0].name = "External NAT"
+    network_interface.access_configs[0].type_ = compute_v1.AccessConfig.Type.ONE_TO_ONE_NAT
+    network_interface.access_configs[0].network_tier = (
+        compute_v1.AccessConfig.NetworkTier.PREMIUM
+    )
+
+    template = compute_v1.InstanceTemplate()
+    template.name = template_name
+    template.properties.disks = [disk]
+    template.properties.machine_type = "e2-standard-4"
+    template.properties.network_interfaces = [network_interface]
+
+    template_client = compute_v1.InstanceTemplatesClient()
+    operation_client = compute_v1.GlobalOperationsClient()
+    op = template_client.insert(project=project_id, instance_template_resource=template)
+    operation_client.wait(project=project_id, operation=op.name)
+
+    return template_client.get(project=project_id, instance_template=template_name)
+
+
+def create_template_from_instance(project_id: str, instance: str, template_name: str) -> compute_v1.InstanceTemplate:
+    """
+    Create a new instance template based on an existing instance.
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        instance: the instance the new template will be based on. This value uses
+            the following format: "projects/{project}/zones/{zone}/instances/{instance_name}"
+        template_name: name of the new template that is created.
+
+    Returns:
+        InstanceTemplate object describing the new instance template.
+    """
+    disk = compute_v1.DiskInstantiationConfig()
+    # This name must match the name of a disk attached to the instance you are
+    # basing your template on.
+    disk.device_name = "disk-1"
+    # Replace the original disk image used in your instance with a Rocky Linux image.
+    disk.instantiate_from = (
+        compute_v1.DiskInstantiationConfig.InstantiateFrom.CUSTOM_IMAGE
+    )
+    disk.custom_image = "projects/rocky-linux-cloud/global/images/family/rocky-linux-8"
+    # You can override the auto_delete setting.
+    disk.auto_delete = True
+
+    template = compute_v1.InstanceTemplate()
+    template.name = template_name
+    template.source_instance = instance
+    template.source_instance_params = compute_v1.SourceInstanceParams()
+    template.source_instance_params.disk_configs = [disk]
+
+    template_client = compute_v1.InstanceTemplatesClient()
+    operation_client = compute_v1.GlobalOperationsClient()
+    op = template_client.insert(project=project_id, instance_template_resource=template)
+    operation_client.wait(project=project_id, operation=op.name)
+
+    return template_client.get(project=project_id, instance_template=template_name)
+
+
+def create_template_with_subnet(
+    project_id: str, network: str, subnetwork: str, template_name: str
+) -> compute_v1.InstanceTemplate:
+    """
+    Create an instance template that will use a provided subnet.
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        network: the network to be used in the new template. This value uses
+            the following format: "projects/{project}/global/networks/{network}"
+        subnetwork: the subnetwork to be used in the new template. This value
+            uses the following format: "projects/{project}/regions/{region}/subnetworks/{subnetwork}"
+        template_name: name of the new template that is created.
+
+    Returns:
+        InstanceTemplate object describing the new instance template.
+    """
+    # Describe the size and source image of the boot disk to attach to the instance.
+    disk = compute_v1.AttachedDisk()
+    initialize_params = compute_v1.AttachedDiskInitializeParams()
+    initialize_params.source_image = (
+        "projects/debian-cloud/global/images/family/debian-11"
+    )
+    initialize_params.disk_size_gb = 250
+    disk.initialize_params = initialize_params
+    disk.auto_delete = True
+    disk.boot = True
+
+    template = compute_v1.InstanceTemplate()
+    template.name = template_name
+    template.properties = compute_v1.InstanceProperties()
+    template.properties.disks = [disk]
+    template.properties.machine_type = "e2-standard-4"
+
+    # Make this template use provided subnetwork.
+    network_interface = compute_v1.NetworkInterface()
+    network_interface.network = network
+    network_interface.subnetwork = subnetwork
+    template.properties.network_interfaces = [network_interface]
+
+    template_client = compute_v1.InstanceTemplatesClient()
+    operation_client = compute_v1.GlobalOperationsClient()
+    op = template_client.insert(project=project_id, instance_template_resource=template)
+    operation_client.wait(project=project_id, operation=op.name)
+
+    return template_client.get(project=project_id, instance_template=template_name)
+
+
+def delete_instance_template(project_id: str, template_name: str):
+    """
+    Delete an instance template.
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        template_name: name of the new template to delete.
+    """
+    template_client = compute_v1.InstanceTemplatesClient()
+    operation_client = compute_v1.GlobalOperationsClient()
+    op = template_client.delete(project=project_id, instance_template=template_name)
+    operation_client.wait(project=project_id, operation=op.name)
+    return

samples/snippets/test_sample_start_stop.py

@@ -22,7 +22,7 @@
 
 import pytest
 
-from samples.snippets.sample_start_stop import start_instance, start_instance_with_encryption_key, stop_instance
+from sample_start_stop import start_instance, start_instance_with_encryption_key, stop_instance
 
 PROJECT = google.auth.default()[1]
 
@@ -43,6 +43,7 @@ def _make_disk(raw_key: bytes = None):
     disk.auto_delete = True
     disk.boot = True
     disk.type_ = compute_v1.AttachedDisk.Type.PERSISTENT
+    disk.device_name = 'disk-1'
 
     if raw_key:
         disk.disk_encryption_key = compute_v1.CustomerEncryptionKey()

samples/snippets/test_sample_templates.py

@@ -0,0 +1,98 @@
+# Copyright 2021 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.
+
+import uuid
+
+import google.auth
+
+from sample_templates import (
+    create_template,
+    create_template_from_instance,
+    create_template_with_subnet,
+    delete_instance_template,
+    list_instance_templates,
+)
+
+from test_sample_start_stop import compute_instance
+# Needed to make the flake8 happy.
+assert compute_instance
+
+PROJECT = google.auth.default()[1]
+
+INSTANCE_ZONE = "europe-central2-b"
+
+
+def test_create_instance():
+    template_name = "i" + uuid.uuid4().hex[:10]
+    template = create_template(PROJECT, template_name)
+
+    try:
+        assert template.name == template_name
+        assert template.properties.disks[0].initialize_params.disk_size_gb == 250
+        assert (
+            "debian-11" in template.properties.disks[0].initialize_params.source_image
+        )
+        assert (
+            template.properties.network_interfaces[0].name == "global/networks/default"
+        )
+        assert template.properties.machine_type == "e2-standard-4"
+    finally:
+        delete_instance_template(PROJECT, template_name)
+    assert all(
+        template.name != template_name for template in list_instance_templates(PROJECT)
+    )
+
+
+def test_create_from_instance(compute_instance):
+    template_name = "i" + uuid.uuid4().hex[:10]
+    template = create_template_from_instance(
+        PROJECT, compute_instance.self_link, template_name
+    )
+
+    try:
+        assert template.name == template_name
+        assert template.properties.machine_type in compute_instance.machine_type
+        assert (
+            template.properties.disks[0].disk_size_gb
+            == compute_instance.disks[0].disk_size_gb
+        )
+        assert (
+            template.properties.disks[0].initialize_params.source_image
+            == "projects/rocky-linux-cloud/global/images/family/rocky-linux-8"
+        )
+    finally:
+        delete_instance_template(PROJECT, template_name)
+
+
+def test_create_template_with_subnet():
+    template_name = "i" + uuid.uuid4().hex[:10]
+    template = create_template_with_subnet(
+        PROJECT,
+        "global/networks/default",
+        "regions/asia-east1/subnetworks/default",
+        template_name,
+    )
+
+    try:
+        assert template.name == template_name
+        assert (
+            "global/networks/default"
+            in template.properties.network_interfaces[0].network
+        )
+        assert (
+            "regions/asia-east1/subnetworks/default"
+            in template.properties.network_interfaces[0].subnetwork
+        )
+    finally:
+        delete_instance_template(PROJECT, template_name)