This document explains how to create a virtual machine (VM) instance by using a
boot disk image, a boot disk snapshot, or a container image. Some
images support
Shielded VM features, which
offer security features such as UEFI-compliant firmware, Secure Boot, and
vTPM-protected Measured Boot.
On Shielded VMs, vTPM and integrity
monitoring are enabled by default.
While creating your VM, you can create one or more disks for it. You can also
add more disks
to the VM after it's created. Compute Engine automatically starts
the VM instance after you create it.
While creating a VM, you can also add multiple network interfaces.
To mitigate your VM's exposure to threats on the internet, you can omit
the external IP address when you add a network interface to the instance.
In such cases, the VM is accessible only from other VMs in the same
VPC network or a linked network unless you configure
Cloud NAT.
When creating VMs from images or disks by using the Google Cloud CLI or
the Compute Engine API, there's a limit of 20 VM instances per second. If you need
to create a higher number of VMs per second, request a higher quota limit
for the Images resource.
Create a VM instance from an image
This section explains how to create a VM from a public OS
image or a custom image.
A VM contains a bootloader, a boot file system, and an OS image.
View a list of public images available on Compute Engine
Before you create a VM by using a public image, review the list of public
images that are available on Compute Engine.
using Google.Cloud.Compute.V1;
using System;
using System.Threading.Tasks;
public class ListImagesAsyncSample
{
public async Task ListImagesAsync(
// TODO(developer): Set your own default values for these parameters or pass different values when calling this method.
string projectId = "your-project-id")
{
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests.
ImagesClient client = await ImagesClient.CreateAsync();
// Make the request to list all non-deprecated images in a project.
ListImagesRequest request = new ListImagesRequest
{
Project = projectId,
// Listing only non-deprecated images to reduce the size of the reply.
Filter = "deprecated.state != DEPRECATED",
// MaxResults indicates the maximum number of items that will be returned per page.
MaxResults = 100
};
// Although the MaxResults parameter is specified in the request, the sequence returned
// by the ListAsync() method hides the pagination mechanic. The library makes multiple
// requests to the API for you, so you can simply iterate over all the images.
await foreach (var image in client.ListAsync(request))
{
// The result is an Image collection.
Console.WriteLine($"Image: {image.Name}");
}
}
}
import (
"context"
"fmt"
"io"
compute "cloud.google.com/go/compute/apiv1"
"google.golang.org/api/iterator"
computepb "google.golang.org/genproto/googleapis/cloud/compute/v1"
"google.golang.org/protobuf/proto"
)
// printImagesList prints a list of all non-deprecated image names available in given project.
func printImagesList(w io.Writer, projectID string) error {
// projectID := "your_project_id"
ctx := context.Background()
imagesClient, err := compute.NewImagesRESTClient(ctx)
if err != nil {
return fmt.Errorf("NewImagesRESTClient: %v", err)
}
defer imagesClient.Close()
// Listing only non-deprecated images to reduce the size of the reply.
req := &computepb.ListImagesRequest{
Project: projectID,
MaxResults: proto.Uint32(3),
Filter: proto.String("deprecated.state != DEPRECATED"),
}
// Although the `MaxResults` parameter is specified in the request, the iterator returned
// by the `list()` method hides the pagination mechanic. The library makes multiple
// requests to the API for you, so you can simply iterate over all the images.
it := imagesClient.List(ctx, req)
for {
image, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
return err
}
fmt.Fprintf(w, "- %s\n", image.GetName())
}
return nil
}
import com.google.cloud.compute.v1.Image;
import com.google.cloud.compute.v1.ImagesClient;
import com.google.cloud.compute.v1.ImagesClient.ListPage;
import com.google.cloud.compute.v1.ListImagesRequest;
import java.io.IOException;
// Prints a list of all non-deprecated image names available in given project.
public static void listImages(String project) throws IOException {
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the `instancesClient.close()` method on the client to
// safely clean up any remaining background resources.
try (ImagesClient imagesClient = ImagesClient.create()) {
// Listing only non-deprecated images to reduce the size of the reply.
ListImagesRequest imagesRequest = ListImagesRequest.newBuilder()
.setProject(project)
.setMaxResults(100)
.setFilter("deprecated.state != DEPRECATED")
.build();
// Although the `setMaxResults` parameter is specified in the request, the iterable returned
// by the `list()` method hides the pagination mechanic. The library makes multiple
// requests to the API for you, so you can simply iterate over all the images.
int imageCount = 0;
for (Image image : imagesClient.list(imagesRequest).iterateAll()) {
imageCount++;
System.out.println(image.getName());
}
System.out.printf("Image count in %s is: %s", project, imageCount);
}
}
/**
* TODO(developer): Uncomment and replace these variables before running the sample.
*/
// const projectId = 'YOUR_PROJECT_ID';
const compute = require('@google-cloud/compute');
async function listImages() {
const imagesClient = new compute.ImagesClient();
// Listing only non-deprecated images to reduce the size of the reply.
const images = imagesClient.listAsync({
project: projectId,
maxResults: 3,
filter: 'deprecated.state != DEPRECATED',
});
// Although the `maxResults` parameter is specified in the request, the iterable returned
// by the `listAsync()` method hides the pagination mechanic. The library makes multiple
// requests to the API for you, so you can simply iterate over all the images.
for await (const image of images) {
console.log(` - ${image.name}`);
}
}
listImages();
use Google\Cloud\Compute\V1\ImagesClient;
/**
* Prints a list of all non-deprecated image names available in given project.
*
* @param string $projectId Project ID or project number of the Cloud project you want to list images from.
*
* @throws \Google\ApiCore\ApiException if the remote call fails.
*/
function list_all_images(string $projectId)
{
$imagesClient = new ImagesClient();
// Listing only non-deprecated images to reduce the size of the reply.
$optionalArgs = ['maxResults' => 100, 'filter' => 'deprecated.state != DEPRECATED'];
/**
* Although the maxResults parameter is specified in the request, the iterateAllElements() method
* hides the pagination mechanic. The library makes multiple requests to the API for you,
* so you can simply iterate over all the images.
*/
$pagedResponse = $imagesClient->list($projectId, $optionalArgs);
print('=================== Flat list of images ===================' . PHP_EOL);
foreach ($pagedResponse->iterateAllElements() as $element) {
printf(' - %s' . PHP_EOL, $element->getName());
}
}
import google.cloud.compute_v1 as compute_v1
def print_images_list(project: str) -> str:
"""
Prints a list of all non-deprecated image names available in given project.
Args:
project: project ID or project number of the Cloud project you want to list images from.
Returns:
The output as a string.
"""
images_client = compute_v1.ImagesClient()
# Listing only non-deprecated images to reduce the size of the reply.
images_list_request = compute_v1.ListImagesRequest(
project=project, max_results=100, filter="deprecated.state != DEPRECATED"
)
output = []
# Although the `max_results` parameter is specified in the request, the iterable returned
# by the `list()` method hides the pagination mechanic. The library makes multiple
# requests to the API for you, so you can simply iterate over all the images.
for img in images_client.list(request=images_list_request):
print(f" - {img.name}")
output.append(f" - {img.name}")
return "\n".join(output)
require "google/cloud/compute/v1"
# Prints a list of all non-deprecated image names available in given project.
#
# @param [String] project project ID or project number of the Cloud project you want to list images from.
def print_images_list project:
client = ::Google::Cloud::Compute::V1::Images::Rest::Client.new
# Make the request to list all non-deprecated images in a project.
request = {
project: project,
# max_results indicates the maximum number of items that will be returned per page.
max_results: 100,
# Listing only non-deprecated images to reduce the size of the reply.
filter: "deprecated.state != DEPRECATED"
}
# Although the `max_results` parameter is specified in the request, the iterable returned
# by the `list` method hides the pagination mechanic. The library makes multiple
# requests to the API for you, so you can simply iterate over all the images.
client.list(request).each do |image|
puts " - #{image.name}"
end
end
Create a VM instance from a public image
Google, open source communities, and third-party vendors provide and
maintain public OS images. By
default, all Google Cloud projects can create VMs from public OS images. However, if
your Cloud project has a defined list of
trusted images,
you can use only the images on that list to create a VM.
To perform this task, you must have the following
permissions:
compute.instances.create on the project
compute.instances.updateShieldedVmConfig if you plan to create a
Shielded VM instance and you want
to be able to change any of the Shielded VM settings
compute.networks.use on the project if using a legacy
network
compute.subnetworks.use either on the whole project or on the chosen subnet
(VPC networks)
compute.networks.useExternalIp on the project if you need to assign an external
IP address (either ephemeral or static) to the instance using a legacy network
compute.subnetworks.useExternalIp either on the whole project or on the chosen
subnet if you need to assign an external IP address (either ephemeral or static) to the instance
using a VPC network
compute.addresses.use on the project if specifying a static address in the
project
compute.instances.setMetadata if setting metadata
compute.instances.setTags on the instance if setting tags
compute.instances.setLabels on the instance if setting
labels
compute.images.useReadOnly on the image if creating a new root
persistent disk
compute.disks.create on the project if creating a new root
persistent disk with this instance
compute.disks.useReadOnly on the disk if attaching an existing
persistent disk in read-only mode
compute.disks.use on the disk if attaching an existing disk in
read/write mode
compute.disks.setLabels on the disk if setting
labels
compute.snapshots.create on the project to create a new
snapshot if creating an instance from a snapshot
compute.snapshots.useReadOnly on the snapshot if creating an instance
from a snapshot
Console
In the Google Cloud console, go to the VM instances page.
Optional: Change the Zone for this VM. Compute Engine
randomizes the list of zones within each region to encourage use across
multiple zones.
Select a Machine configuration for your VM.
In the Boot disk section, click Change, and then do the
following:
On the Public images tab, choose the following:
Operating system
OS version
Boot disk type
Boot disk size
Optional: For advanced configuration options, click Show advanced
configuration.
To confirm your boot disk options, click Select.
In the Firewall section, to permit HTTP or HTTPS traffic to
the VM, select Allow HTTP
traffic or Allow HTTPS traffic. When you
select one of these, Compute Engine adds a network tag to your
VM, which associates the firewall rule with the VM. Then,
Compute Engine creates the corresponding ingress firewall
rule that allows all incoming traffic on tcp:80
(HTTP) or tcp:443 (HTTPS).
Optional: If you chose an OS image that supports Shielded VM
features, you can modify the Shielded VM
settings.
To modify shielded VM settings, expand the Security section in the
Networking, disks, security, management, sole tenancy section and do
the following, as required:
This creates the VM from the most recent, non-deprecated OS image.
For example, if you specify --image-family=debian-10,
Compute Engine creates a VM from the latest version of the
OS image in the Debian 10 image family.
This creates the VM from the most recent, non-deprecated OS image.
For example, if you specify
"sourceImage": "projects/debian-cloud/global/images/family/debian-10",
Compute Engine creates a VM
from the latest version of the OS image in the Debian 10 image
family.
If you specify true for
enableSecureBoot, Compute Engine creates a VM
with all three Shielded VM features enabled. After
Compute Engine starts your VM, to
modify Shielded VM
options, you must stop the VM.
using Google.Cloud.Compute.V1;
using System.Threading.Tasks;
public class CreateInstanceAsyncSample
{
public async Task CreateInstanceAsync(
// TODO(developer): Set your own default values for these parameters or pass different values when calling this method.
string projectId = "your-project-id",
string zone = "us-central1-a",
string machineName = "test-machine",
string machineType = "n1-standard-1",
string diskImage = "projects/debian-cloud/global/images/family/debian-10",
long diskSizeGb = 10,
string networkName = "default")
{
Instance instance = new Instance
{
Name = machineName,
// See https://cloud.google.com/compute/docs/machine-types for more information on machine types.
MachineType = $"zones/{zone}/machineTypes/{machineType}",
// Instance creation requires at least one persistent disk.
Disks =
{
new AttachedDisk
{
AutoDelete = true,
Boot = true,
Type = ComputeEnumConstants.AttachedDisk.Type.Persistent,
InitializeParams = new AttachedDiskInitializeParams
{
// See https://cloud.google.com/compute/docs/images for more information on available images.
SourceImage = diskImage,
DiskSizeGb = diskSizeGb
}
}
},
NetworkInterfaces = { new NetworkInterface { Name = networkName } }
};
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests.
InstancesClient client = await InstancesClient.CreateAsync();
// Insert the instance in the specified project and zone.
var instanceCreation = await client.InsertAsync(projectId, zone, instance);
// Wait for the operation to complete using client-side polling.
// The server-side operation is not affected by polling,
// and might finish successfully even if polling times out.
await instanceCreation.PollUntilCompletedAsync();
}
}
import com.google.api.gax.longrunning.OperationFuture;
import com.google.cloud.compute.v1.AttachedDisk;
import com.google.cloud.compute.v1.AttachedDisk.Type;
import com.google.cloud.compute.v1.AttachedDiskInitializeParams;
import com.google.cloud.compute.v1.InsertInstanceRequest;
import com.google.cloud.compute.v1.Instance;
import com.google.cloud.compute.v1.InstancesClient;
import com.google.cloud.compute.v1.NetworkInterface;
import com.google.cloud.compute.v1.Operation;
import java.io.IOException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class CreateInstance {
public static void main(String[] args)
throws IOException, InterruptedException, ExecutionException, TimeoutException {
// TODO(developer): Replace these variables before running the sample.
String project = "your-project-id";
String zone = "zone-name";
String instanceName = "instance-name";
createInstance(project, zone, instanceName);
}
// Create a new instance with the provided "instanceName" value in the specified project and zone.
public static void createInstance(String project, String zone, String instanceName)
throws IOException, InterruptedException, ExecutionException, TimeoutException {
// Below are sample values that can be replaced.
// machineType: machine type of the VM being created.
// * This value uses the format zones/{zone}/machineTypes/{type_name}.
// * For a list of machine types, see https://cloud.google.com/compute/docs/machine-types
// sourceImage: path to the operating system image to mount.
// * For details about images you can mount, see https://cloud.google.com/compute/docs/images
// diskSizeGb: storage size of the boot disk to attach to the instance.
// networkName: network interface to associate with the instance.
String machineType = String.format("zones/%s/machineTypes/n1-standard-1", zone);
String sourceImage = String
.format("projects/debian-cloud/global/images/family/%s", "debian-11");
long diskSizeGb = 10L;
String networkName = "default";
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the `instancesClient.close()` method on the client to safely
// clean up any remaining background resources.
try (InstancesClient instancesClient = InstancesClient.create()) {
// Instance creation requires at least one persistent disk and one network interface.
AttachedDisk disk =
AttachedDisk.newBuilder()
.setBoot(true)
.setAutoDelete(true)
.setType(Type.PERSISTENT.toString())
.setDeviceName("disk-1")
.setInitializeParams(
AttachedDiskInitializeParams.newBuilder()
.setSourceImage(sourceImage)
.setDiskSizeGb(diskSizeGb)
.build())
.build();
// Use the network interface provided in the networkName argument.
NetworkInterface networkInterface = NetworkInterface.newBuilder()
.setName(networkName)
.build();
// Bind `instanceName`, `machineType`, `disk`, and `networkInterface` to an instance.
Instance instanceResource =
Instance.newBuilder()
.setName(instanceName)
.setMachineType(machineType)
.addDisks(disk)
.addNetworkInterfaces(networkInterface)
.build();
System.out.printf("Creating instance: %s at %s %n", instanceName, zone);
// Insert the instance in the specified project and zone.
InsertInstanceRequest insertInstanceRequest = InsertInstanceRequest.newBuilder()
.setProject(project)
.setZone(zone)
.setInstanceResource(instanceResource)
.build();
OperationFuture<Operation, Operation> operation = instancesClient.insertAsync(
insertInstanceRequest);
// Wait for the operation to complete.
Operation response = operation.get(3, TimeUnit.MINUTES);
if (response.hasError()) {
System.out.println("Instance creation failed ! ! " + response);
return;
}
System.out.println("Operation Status: " + response.getStatus());
}
}
}
use Google\Cloud\Compute\V1\InstancesClient;
use Google\Cloud\Compute\V1\AttachedDisk;
use Google\Cloud\Compute\V1\AttachedDiskInitializeParams;
use Google\Cloud\Compute\V1\Instance;
use Google\Cloud\Compute\V1\NetworkInterface;
/**
* To correctly handle string enums in Cloud Compute library
* use constants defined in the Enums subfolder.
*/
use Google\Cloud\Compute\V1\Enums\AttachedDisk\Type;
/**
* Creates an instance in the specified project and zone.
*
* @param string $projectId Project ID of the Cloud project to create the instance in.
* @param string $zone Zone to create the instance in (like "us-central1-a").
* @param string $instanceName Unique name for this Compute Engine instance.
* @param string $machineType Machine type of the instance being created.
* @param string $sourceImage Boot disk image name or family.
* @param string $networkName Network interface to associate with the instance.
*
* @throws \Google\ApiCore\ApiException if the remote call fails.
* @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
*/
function create_instance(
string $projectId,
string $zone,
string $instanceName,
string $machineType = 'n1-standard-1',
string $sourceImage = 'projects/debian-cloud/global/images/family/debian-11',
string $networkName = 'global/networks/default'
) {
// Set the machine type using the specified zone.
$machineTypeFullName = sprintf('zones/%s/machineTypes/%s', $zone, $machineType);
// Describe the source image of the boot disk to attach to the instance.
$diskInitializeParams = (new AttachedDiskInitializeParams())
->setSourceImage($sourceImage);
$disk = (new AttachedDisk())
->setBoot(true)
->setAutoDelete(true)
->setType(Type::PERSISTENT)
->setInitializeParams($diskInitializeParams);
// Use the network interface provided in the $networkName argument.
$network = (new NetworkInterface())
->setName($networkName);
// Create the Instance object.
$instance = (new Instance())
->setName($instanceName)
->setDisks([$disk])
->setMachineType($machineTypeFullName)
->setNetworkInterfaces([$network]);
// Insert the new Compute Engine instance using InstancesClient.
$instancesClient = new InstancesClient();
$operation = $instancesClient->insert($instance, $projectId, $zone);
// Wait for the operation to complete.
$operation->pollUntilComplete();
if ($operation->operationSucceeded()) {
printf('Created instance %s' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
printf('Instance creation failed: %s' . PHP_EOL, $error->getMessage());
}
}
import re
import sys
from typing import Any, List
from google.api_core.extended_operation import ExtendedOperation
from google.cloud import compute_v1
def get_image_from_family(project: str, family: str) -> compute_v1.Image:
"""
Retrieve the newest image that is part of a given family in a project.
Args:
project: project ID or project number of the Cloud project you want to get image from.
family: name of the image family you want to get image from.
Returns:
An Image object.
"""
image_client = compute_v1.ImagesClient()
# List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details
newest_image = image_client.get_from_family(project=project, family=family)
return newest_image
def disk_from_image(
disk_type: str,
disk_size_gb: int,
boot: bool,
source_image: str,
auto_delete: bool = True,
) -> compute_v1.AttachedDisk:
"""
Create an AttachedDisk object to be used in VM instance creation. Uses an image as the
source for the new disk.
Args:
disk_type: the type of disk you want to create. This value uses the following format:
"zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".
For example: "zones/us-west3-b/diskTypes/pd-ssd"
disk_size_gb: size of the new disk in gigabytes
boot: boolean flag indicating whether this disk should be used as a boot disk of an instance
source_image: source image to use when creating this disk. You must have read access to this disk. This can be one
of the publicly available images or an image from one of your projects.
This value uses the following format: "projects/{project_name}/global/images/{image_name}"
auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it
Returns:
AttachedDisk object configured to be created using the specified image.
"""
boot_disk = compute_v1.AttachedDisk()
initialize_params = compute_v1.AttachedDiskInitializeParams()
initialize_params.source_image = source_image
initialize_params.disk_size_gb = disk_size_gb
initialize_params.disk_type = disk_type
boot_disk.initialize_params = initialize_params
# Remember to set auto_delete to True if you want the disk to be deleted when you delete
# your VM instance.
boot_disk.auto_delete = auto_delete
boot_disk.boot = boot
return boot_disk
def wait_for_extended_operation(
operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300
) -> Any:
"""
This method will wait 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(
project_id: str,
zone: str,
instance_name: str,
disks: List[compute_v1.AttachedDisk],
machine_type: str = "n1-standard-1",
network_link: str = "global/networks/default",
subnetwork_link: str = None,
internal_ip: str = None,
external_access: bool = False,
external_ipv4: str = None,
accelerators: List[compute_v1.AcceleratorConfig] = None,
preemptible: bool = False,
custom_hostname: str = None,
delete_protection: bool = False,
) -> compute_v1.Instance:
"""
Send an instance creation request to the Compute Engine API and wait for it to complete.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
disks: a list of compute_v1.AttachedDisk objects describing the disks
you want to attach to your new instance.
machine_type: machine type of the VM being created. This value uses the
following format: "zones/{zone}/machineTypes/{type_name}".
For example: "zones/europe-west3-c/machineTypes/f1-micro"
network_link: name of the network you want the new instance to use.
For example: "global/networks/default" represents the network
named "default", which is created automatically for each project.
subnetwork_link: name of the subnetwork you want the new instance to use.
This value uses the following format:
"regions/{region}/subnetworks/{subnetwork_name}"
internal_ip: internal IP address you want to assign to the new instance.
By default, a free address from the pool of available internal IP addresses of
used subnet will be used.
external_access: boolean flag indicating if the instance should have an external IPv4
address assigned.
external_ipv4: external IPv4 address to be assigned to this instance. If you specify
an external IP address, it must live in the same region as the zone of the instance.
This setting requires `external_access` to be set to True to work.
accelerators: a list of AcceleratorConfig objects describing the accelerators that will
be attached to the new instance.
preemptible: boolean value indicating if the new instance should be preemptible
or not.
custom_hostname: Custom hostname of the new VM instance.
Custom hostnames must conform to RFC 1035 requirements for valid hostnames.
delete_protection: boolean value indicating if the new virtual machine should be
protected against deletion or not.
Returns:
Instance object.
"""
instance_client = compute_v1.InstancesClient()
# Use the network interface provided in the network_link argument.
network_interface = compute_v1.NetworkInterface()
network_interface.name = network_link
if subnetwork_link:
network_interface.subnetwork = subnetwork_link
if internal_ip:
network_interface.network_i_p = internal_ip
if external_access:
access = compute_v1.AccessConfig()
access.type_ = compute_v1.AccessConfig.Type.ONE_TO_ONE_NAT.name
access.name = "External NAT"
access.network_tier = access.NetworkTier.PREMIUM.name
if external_ipv4:
access.nat_i_p = external_ipv4
network_interface.access_configs = [access]
# Collect information into the Instance object.
instance = compute_v1.Instance()
instance.name = instance_name
instance.disks = disks
if re.match(r"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$", machine_type):
instance.machine_type = machine_type
else:
instance.machine_type = f"zones/{zone}/machineTypes/{machine_type}"
if accelerators:
instance.guest_accelerators = accelerators
instance.network_interfaces = [network_interface]
if preemptible:
# Set the preemptible setting
instance.scheduling = compute_v1.Scheduling()
instance.scheduling.preemptible = True
if custom_hostname is not None:
# Set the custom hostname for the instance
instance.hostname = custom_hostname
if delete_protection:
# Set the delete protection bit
instance.deletion_protection = True
# Prepare the request to insert an instance.
request = compute_v1.InsertInstanceRequest()
request.zone = zone
request.project = project_id
request.instance_resource = instance
# Wait for the create operation to complete.
print(f"Creating the {instance_name} instance in {zone}...")
operation = instance_client.insert(request=request)
wait_for_extended_operation(operation, "instance creation")
print(f"Instance {instance_name} created.")
return instance_client.get(project=project_id, zone=zone, instance=instance_name)
require "google/cloud/compute/v1"
# Sends an instance creation request to the Compute Engine API and waits for it to complete.
#
# @param [String] project project ID or project number of the Cloud project you want to use.
# @param [String] zone name of the zone you want to use. For example: "us-west3-b"
# @param [String] instance_name name of the new virtual machine.
# @param [String] machine_type machine type of the VM being created. For example: "e2-standard-2"
# See https://cloud.google.com/compute/docs/machine-types for more information
# on machine types.
# @param [String] source_image path to the operating system image to mount on your boot
# disk. This can be one of the public images
# (like "projects/debian-cloud/global/images/family/debian-10")
# or a private image you have access to.
# See https://cloud.google.com/compute/docs/images for more information on available images.
# @param [String] network_name name of the network you want the new instance to use.
# For example: "global/networks/default" represents the `default`
# network interface, which is created automatically for each project.
def create_instance project:, zone:, instance_name:,
machine_type: "n2-standard-2",
source_image: "projects/debian-cloud/global/images/family/debian-10",
network_name: "global/networks/default"
# Initialize client that will be used to send requests. This client only needs to be created
# once, and can be reused for multiple requests.
client = ::Google::Cloud::Compute::V1::Instances::Rest::Client.new
# Construct the instance object.
# It can be either a hash or ::Google::Cloud::Compute::V1::Instance instance.
instance = {
name: instance_name,
machine_type: "zones/#{zone}/machineTypes/#{machine_type}",
# Instance creation requires at least one persistent disk.
disks: [{
auto_delete: true,
boot: true,
type: :PERSISTENT,
initialize_params: {
source_image: source_image,
disk_size_gb: 10
}
}],
network_interfaces: [{ name: network_name }]
}
# Prepare a request to create the instance in the specified project and zone.
request = { project: project, zone: zone, instance_resource: instance }
puts "Creating the #{instance_name} instance in #{zone}..."
begin
# Send the insert request.
operation = client.insert request
# Wait for the create operation to complete.
operation = wait_until_done operation: operation.operation, project: project
if operation.error.nil?
warn "Warning during creation:", operation.warnings unless operation.warnings.empty?
puts "Instance #{instance_name} created."
else
warn "Error during creation:", operation.error
end
rescue ::Google::Cloud::Error => e
warn "Exception during creation:", e
end
end
Create a VM from a custom image
A custom image belongs only to your project. To create a VM with a
custom image, you must first
create a custom image
if you don't already have one.
Permissions required for this task
To perform this task, you must have the following
permissions:
compute.instances.create on the project
compute.instances.updateShieldedVmConfig if you plan to create a
Shielded VM instance and you want
to be able to change any of the Shielded VM settings
compute.networks.use on the project if using a legacy
network
compute.subnetworks.use either on the whole project or on the chosen subnet
(VPC networks)
compute.networks.useExternalIp on the project if you need to assign an external
IP address (either ephemeral or static) to the instance using a legacy network
compute.subnetworks.useExternalIp either on the whole project or on the chosen
subnet if you need to assign an external IP address (either ephemeral or static) to the instance
using a VPC network
compute.addresses.use on the project if specifying a static address in the
project
compute.instances.setMetadata if setting metadata
compute.instances.setTags on the instance if setting tags
compute.instances.setLabels on the instance if setting
labels
compute.images.useReadOnly on the image if creating a new root
persistent disk
compute.disks.create on the project if creating a new root
persistent disk with this instance
compute.disks.useReadOnly on the disk if attaching an existing
persistent disk in read-only mode
compute.disks.use on the disk if attaching an existing disk in
read/write mode
compute.disks.setLabels on the disk if setting
labels
compute.snapshots.create on the project to create a new
snapshot if creating an instance from a snapshot
compute.snapshots.useReadOnly on the snapshot if creating an instance
from a snapshot
Console
In the Google Cloud console, go to the VM instances page.
Optional: Change the Zone for this VM. Compute Engine
randomizes the list of zones within each region to encourage use across
multiple zones.
Select a Machine configuration for your VM.
In the Boot disk section, click Change, and then do the
following:
Select the Custom Images tab.
To select the image project, click Select a project, and then do
the following:
Select the project that contains the image.
Click Open.
In the Image list, click the image that you want to import.
Select the type and size of your boot disk.
Optional: For advanced configuration options, click Show advanced
configuration.
To confirm your boot disk options, click Select.
In the Firewall section, to permit HTTP or HTTPS traffic to the VM,
select Allow HTTP traffic or Allow HTTPS traffic.
The Cloud console adds a network tag to your VM and
creates the corresponding ingress firewall rule that allows all
incoming traffic on tcp:80 (HTTP) or tcp:443 (HTTPS). The network
tag associates the firewall rule with the VM. For more
information, see Firewall rules overview in
the Virtual Private Cloud documentation.
IMAGE_PROJECT: name of the project that
contains the image
IMAGE or IMAGE_FAMILY:
specify one of the following:
IMAGE: name of your custom image
For example, --image=my-debian-image-v2.
IMAGE_FAMILY: if you created your custom images
as part of a custom image family,
specify that custom image family.
This creates the VM from the most
recent, non-deprecated OS image and OS version in your custom image family.
For example, if you specify --image-family=my-debian-family,
Compute Engine creates a VM from the latest OS image in your custom
my-debian-family image family.
API
The process for creating a VM with a custom image in the API
is the same as if you were creating a VM with a
publicly available image.
IMAGE_PROJECT: name of the project that contains
the custom image
IMAGE or IMAGE_FAMILY:
specify one of the following:
IMAGE: name of your custom image
For example,
"sourceImage": "projects/my-project-1234/global/images/my-debian-image-v2".
IMAGE_FAMILY: if you created your custom images
as part of a custom image family,
specify that custom image family.
This creates the VM from the most
recent, non-deprecated OS image in your custom image family.
For example, if you specify
"sourceImage": "projects/my-project-1234/global/images/family/my-debian-family",
Compute Engine creates a VM from the latest version of the OS image
in the custom my-debian-family image family.
import com.google.api.gax.longrunning.OperationFuture;
import com.google.cloud.compute.v1.AttachedDisk;
import com.google.cloud.compute.v1.AttachedDisk.Type;
import com.google.cloud.compute.v1.AttachedDiskInitializeParams;
import com.google.cloud.compute.v1.Image;
import com.google.cloud.compute.v1.ImagesClient;
import com.google.cloud.compute.v1.InsertInstanceRequest;
import com.google.cloud.compute.v1.Instance;
import com.google.cloud.compute.v1.InstancesClient;
import com.google.cloud.compute.v1.NetworkInterface;
import com.google.cloud.compute.v1.Operation;
import java.io.IOException;
import java.util.Vector;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class CreateInstancesAdvanced {
/**
* Create an AttachedDisk object to be used in VM instance creation. Uses an image as the source
* for the new disk.
*
* @param diskType the type of disk you want to create. This value uses the following format:
* "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example:
* "zones/us-west3-b/diskTypes/pd-ssd"
* @param diskSizeGb size of the new disk in gigabytes
* @param boot boolean flag indicating whether this disk should be used as a boot disk of an
* instance
* @param sourceImage source image to use when creating this disk. You must have read access to
* this disk. This can be one of the publicly available images or an image from one of your
* projects. This value uses the following format:
* "projects/{project_name}/global/images/{image_name}"
* @return AttachedDisk object configured to be created using the specified image.
*/
private static AttachedDisk diskFromImage(String diskType, int diskSizeGb, boolean boot,
String sourceImage) {
AttachedDisk disk =
AttachedDisk.newBuilder()
.setBoot(boot)
// Remember to set auto_delete to True if you want the disk to be deleted when
// you delete your VM instance.
.setAutoDelete(true)
.setType(Type.PERSISTENT.toString())
.setInitializeParams(
AttachedDiskInitializeParams.newBuilder()
.setSourceImage(sourceImage)
.setDiskSizeGb(diskSizeGb)
.setDiskType(diskType)
.build())
.build();
return disk;
}
/**
* Send an instance creation request to the Compute Engine API and wait for it to complete.
*
* @param project project ID or project number of the Cloud project you want to use.
* @param zone name of the zone to create the instance in. For example: "us-west3-b"
* @param instanceName name of the new virtual machine (VM) instance.
* @param disks a list of compute_v1.AttachedDisk objects describing the disks you want to attach
* to your new instance.
* @param machineType machine type of the VM being created. This value uses the following format:
* "zones/{zone}/machineTypes/{type_name}".
* For example: "zones/europe-west3-c/machineTypes/f1-micro"
* @param network name of the network you want the new instance to use. For example:
* "global/networks/default" represents the network named "default", which is created
* automatically for each project.
* @param subnetwork name of the subnetwork you want the new instance to use. This value uses the
* following format: "regions/{region}/subnetworks/{subnetwork_name}"
* @return Instance object.
*/
private static Instance createWithDisks(String project, String zone, String instanceName,
Vector<AttachedDisk> disks, String machineType, String network, String subnetwork)
throws IOException, InterruptedException, ExecutionException, TimeoutException {
try (InstancesClient instancesClient = InstancesClient.create()) {
// Use the network interface provided in the networkName argument.
NetworkInterface networkInterface;
if (subnetwork != null) {
networkInterface = NetworkInterface.newBuilder()
.setName(network).setSubnetwork(subnetwork)
.build();
} else {
networkInterface = NetworkInterface.newBuilder()
.setName(network).build();
}
machineType = String.format("zones/%s/machineTypes/%s", zone, machineType);
// Bind `instanceName`, `machineType`, `disk`, and `networkInterface` to an instance.
Instance instanceResource =
Instance.newBuilder()
.setName(instanceName)
.setMachineType(machineType)
.addAllDisks(disks)
.addNetworkInterfaces(networkInterface)
.build();
System.out.printf("Creating instance: %s at %s ", instanceName, zone);
// Insert the instance in the specified project and zone.
InsertInstanceRequest insertInstanceRequest = InsertInstanceRequest.newBuilder()
.setProject(project)
.setZone(zone)
.setInstanceResource(instanceResource).build();
OperationFuture<Operation, Operation> operation = instancesClient.insertAsync(
insertInstanceRequest);
// Wait for the operation to complete.
Operation response = operation.get(3, TimeUnit.MINUTES);
if (response.hasError()) {
System.out.println("Instance creation failed ! ! " + response);
return null;
}
System.out.println("Operation Status: " + response.getStatus());
return instancesClient.get(project, zone, instanceName);
}
}
/**
* Create a new VM instance with custom image used as its boot disk.
*
* @param project project ID or project number of the Cloud project you want to use.
* @param zone name of the zone to create the instance in. For example: "us-west3-b"
* @param instanceName name of the new virtual machine (VM) instance.
* @param customImage link to the custom image you want to use in the form of:
* "projects/{project_name}/global/images/{image_name}"
* @return Instance object.
*/
public static Instance createFromCustomImage(String project, String zone, String instanceName,
String customImage)
throws IOException, InterruptedException, ExecutionException, TimeoutException {
String diskType = String.format("zones/%s/diskTypes/pd-standard", zone);
Vector<AttachedDisk> disks = new Vector<>();
disks.add(diskFromImage(diskType, 10, true, customImage));
return createWithDisks(project, zone, instanceName, disks, "n1-standard-1",
"global/networks/default", null);
}
import re
import sys
from typing import Any, List
from google.api_core.extended_operation import ExtendedOperation
from google.cloud import compute_v1
def get_image_from_family(project: str, family: str) -> compute_v1.Image:
"""
Retrieve the newest image that is part of a given family in a project.
Args:
project: project ID or project number of the Cloud project you want to get image from.
family: name of the image family you want to get image from.
Returns:
An Image object.
"""
image_client = compute_v1.ImagesClient()
# List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details
newest_image = image_client.get_from_family(project=project, family=family)
return newest_image
def disk_from_image(
disk_type: str,
disk_size_gb: int,
boot: bool,
source_image: str,
auto_delete: bool = True,
) -> compute_v1.AttachedDisk:
"""
Create an AttachedDisk object to be used in VM instance creation. Uses an image as the
source for the new disk.
Args:
disk_type: the type of disk you want to create. This value uses the following format:
"zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".
For example: "zones/us-west3-b/diskTypes/pd-ssd"
disk_size_gb: size of the new disk in gigabytes
boot: boolean flag indicating whether this disk should be used as a boot disk of an instance
source_image: source image to use when creating this disk. You must have read access to this disk. This can be one
of the publicly available images or an image from one of your projects.
This value uses the following format: "projects/{project_name}/global/images/{image_name}"
auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it
Returns:
AttachedDisk object configured to be created using the specified image.
"""
boot_disk = compute_v1.AttachedDisk()
initialize_params = compute_v1.AttachedDiskInitializeParams()
initialize_params.source_image = source_image
initialize_params.disk_size_gb = disk_size_gb
initialize_params.disk_type = disk_type
boot_disk.initialize_params = initialize_params
# Remember to set auto_delete to True if you want the disk to be deleted when you delete
# your VM instance.
boot_disk.auto_delete = auto_delete
boot_disk.boot = boot
return boot_disk
def wait_for_extended_operation(
operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300
) -> Any:
"""
This method will wait 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(
project_id: str,
zone: str,
instance_name: str,
disks: List[compute_v1.AttachedDisk],
machine_type: str = "n1-standard-1",
network_link: str = "global/networks/default",
subnetwork_link: str = None,
internal_ip: str = None,
external_access: bool = False,
external_ipv4: str = None,
accelerators: List[compute_v1.AcceleratorConfig] = None,
preemptible: bool = False,
custom_hostname: str = None,
delete_protection: bool = False,
) -> compute_v1.Instance:
"""
Send an instance creation request to the Compute Engine API and wait for it to complete.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
disks: a list of compute_v1.AttachedDisk objects describing the disks
you want to attach to your new instance.
machine_type: machine type of the VM being created. This value uses the
following format: "zones/{zone}/machineTypes/{type_name}".
For example: "zones/europe-west3-c/machineTypes/f1-micro"
network_link: name of the network you want the new instance to use.
For example: "global/networks/default" represents the network
named "default", which is created automatically for each project.
subnetwork_link: name of the subnetwork you want the new instance to use.
This value uses the following format:
"regions/{region}/subnetworks/{subnetwork_name}"
internal_ip: internal IP address you want to assign to the new instance.
By default, a free address from the pool of available internal IP addresses of
used subnet will be used.
external_access: boolean flag indicating if the instance should have an external IPv4
address assigned.
external_ipv4: external IPv4 address to be assigned to this instance. If you specify
an external IP address, it must live in the same region as the zone of the instance.
This setting requires `external_access` to be set to True to work.
accelerators: a list of AcceleratorConfig objects describing the accelerators that will
be attached to the new instance.
preemptible: boolean value indicating if the new instance should be preemptible
or not.
custom_hostname: Custom hostname of the new VM instance.
Custom hostnames must conform to RFC 1035 requirements for valid hostnames.
delete_protection: boolean value indicating if the new virtual machine should be
protected against deletion or not.
Returns:
Instance object.
"""
instance_client = compute_v1.InstancesClient()
# Use the network interface provided in the network_link argument.
network_interface = compute_v1.NetworkInterface()
network_interface.name = network_link
if subnetwork_link:
network_interface.subnetwork = subnetwork_link
if internal_ip:
network_interface.network_i_p = internal_ip
if external_access:
access = compute_v1.AccessConfig()
access.type_ = compute_v1.AccessConfig.Type.ONE_TO_ONE_NAT.name
access.name = "External NAT"
access.network_tier = access.NetworkTier.PREMIUM.name
if external_ipv4:
access.nat_i_p = external_ipv4
network_interface.access_configs = [access]
# Collect information into the Instance object.
instance = compute_v1.Instance()
instance.name = instance_name
instance.disks = disks
if re.match(r"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$", machine_type):
instance.machine_type = machine_type
else:
instance.machine_type = f"zones/{zone}/machineTypes/{machine_type}"
if accelerators:
instance.guest_accelerators = accelerators
instance.network_interfaces = [network_interface]
if preemptible:
# Set the preemptible setting
instance.scheduling = compute_v1.Scheduling()
instance.scheduling.preemptible = True
if custom_hostname is not None:
# Set the custom hostname for the instance
instance.hostname = custom_hostname
if delete_protection:
# Set the delete protection bit
instance.deletion_protection = True
# Prepare the request to insert an instance.
request = compute_v1.InsertInstanceRequest()
request.zone = zone
request.project = project_id
request.instance_resource = instance
# Wait for the create operation to complete.
print(f"Creating the {instance_name} instance in {zone}...")
operation = instance_client.insert(request=request)
wait_for_extended_operation(operation, "instance creation")
print(f"Instance {instance_name} created.")
return instance_client.get(project=project_id, zone=zone, instance=instance_name)
def create_from_custom_image(
project_id: str, zone: str, instance_name: str, custom_image_link: str
) -> compute_v1.Instance:
"""
Create a new VM instance with custom image used as its boot disk.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
custom_image_link: link to the custom image you want to use in the form of:
"projects/{project_name}/global/images/{image_name}"
Returns:
Instance object.
"""
disk_type = f"zones/{zone}/diskTypes/pd-standard"
disks = [disk_from_image(disk_type, 10, True, custom_image_link, True)]
instance = create_instance(project_id, zone, instance_name, disks)
return instance
Create a VM instance with additional non-boot disks
Console
In the Google Cloud console, go to the VM instances page.
Optional: Change the Zone for this VM. Compute Engine
randomizes the list of zones within each region to encourage use across
multiple zones.
Select a Machine configuration for your VM.
In the Boot disk section, click Change, and then do the
following:
In the Public images tab, choose the following:
Operating system
OS version
Boot disk type
Boot disk size
Optional: For advanced configuration options, click Show advanced
configuration.
To confirm your boot disk options, click Select.
In the Firewall section, to permit HTTP or HTTPS traffic to
the VM, select Allow HTTP
traffic or Allow HTTPS traffic. When you select one of these,
Compute Engine adds a network tag to your VM, which associates
the firewall rule with the VM. Then, Compute Engine creates the
corresponding ingress firewall rule that allows
all incoming traffic on tcp:80 (HTTP) or tcp:443 (HTTPS).
To add non-boot disks to your VM, expand the
Networking, disks, security, management, sole tenancy section, and then do the following:
Expand the Disks section.
Click Add new disk, and then do the following:
Specify a disk Name, Type, Source type, and Size.
In the Attachment settings section, select disk's attachment
Mode and the Deletion rule. For more information about
adding new disks, see Add a persistent disk to your VM.
You can add up to 128 non-boot disks while you're creating your
VM. Specify the --create-disk flag for each non-boot disk you
create.
To create non-boot disks from a public or stock image, specify the image
or image-family and image-project properties with the --create-disk
flag. To create a blank disk, don't include these properties. You can optionally
include properties for the disk size and type.
This creates the VM from the most recent, non-deprecated OS image. For
example, if you specify --image-family=debian-10,
Compute Engine creates a VM
from the latest version of the OS image in the Debian 10 image family.
DISK_IMAGE or
DISK_IMAGE_FAMILY: Specify one of the following:
DISK_IMAGE: name of the image
that you want to use as a non-boot disk
DISK_IMAGE_FAMILY: an image family
to use as a non-boot disk
DISK_IMAGE_PROJECT: an image project to which the
disk image belongs
SIZE_GB: Optional: size of the non-boot disk
DISK_TYPE: Optional: full or partial URL for
the type of the persistent disk
For example, https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/diskTypes/pd-ssd.
To view the available disk types,
run the gcloud compute disk-types list command.
For blank disks, don't specify the
DISK_IMAGE,
DISK_IMAGE_FAMILY, or
DISK_IMAGE_PROJECT parameters.
API
You can create up to 128 non-boot disks at the time you create a
VM by using the initializeParams property for each additional
disk. Create additional disks with a public or private image.
To add a blank disk, define the initializeParams entry with no
sourceImage value.
IMAGE_PROJECT: name of the project that
contains the custom image
IMAGE or IMAGE_FAMILY:
specify one of the following:
IMAGE: name of your custom image
For example, "sourceImage": "projects/my-project-1234/global/images/my-debian-image-v2".
IMAGE_FAMILY: if you created your custom images
as part of a custom image family,
specify that custom image family.
This creates the VM from the most
recent, non-deprecated OS image OS version in your custom image family.
For example, if you specify
"sourceImage": "projects/my-project-1234/global/images/family/my-debian-family",
Compute Engine creates a VM from the latest version of the OS image
in the custom my-debian-family image family.
For additional disks, replace the following:
SIZE_GB: disk size
DISK_IMAGE or
DISK_IMAGE_FAMILY: Specify either a source image
or image family for the non-boot disk:
DISK_IMAGE: name of the image that
you want to use as a non-boot disk
For example,
"sourceImage": "projects/DISK_IMAGE_PROJECT/global/images/DISK_IMAGE".
DISK_IMAGE_FAMILY: an image family
to use as a non-boot disk
For example,
"sourceImage": "projects/DISK_IMAGE_PROJECT/global/images/family/DISK_IMAGE_FAMILY".
DISK_TYPE: full or partial URL for the type
of the persistent disk
For example, https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/diskTypes/pd-ssd.
For blank disks, don't specify the
DISK_IMAGE,
DISK_IMAGE_FAMILY, or
DISK_IMAGE_PROJECT parameters.
import com.google.api.gax.longrunning.OperationFuture;
import com.google.cloud.compute.v1.AttachedDisk;
import com.google.cloud.compute.v1.AttachedDisk.Type;
import com.google.cloud.compute.v1.AttachedDiskInitializeParams;
import com.google.cloud.compute.v1.Image;
import com.google.cloud.compute.v1.ImagesClient;
import com.google.cloud.compute.v1.InsertInstanceRequest;
import com.google.cloud.compute.v1.Instance;
import com.google.cloud.compute.v1.InstancesClient;
import com.google.cloud.compute.v1.NetworkInterface;
import com.google.cloud.compute.v1.Operation;
import java.io.IOException;
import java.util.Vector;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class CreateInstancesAdvanced {
/**
* Create an AttachedDisk object to be used in VM instance creation. Uses an image as the source
* for the new disk.
*
* @param diskType the type of disk you want to create. This value uses the following format:
* "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example:
* "zones/us-west3-b/diskTypes/pd-ssd"
* @param diskSizeGb size of the new disk in gigabytes
* @param boot boolean flag indicating whether this disk should be used as a boot disk of an
* instance
* @param sourceImage source image to use when creating this disk. You must have read access to
* this disk. This can be one of the publicly available images or an image from one of your
* projects. This value uses the following format:
* "projects/{project_name}/global/images/{image_name}"
* @return AttachedDisk object configured to be created using the specified image.
*/
private static AttachedDisk diskFromImage(String diskType, int diskSizeGb, boolean boot,
String sourceImage) {
AttachedDisk disk =
AttachedDisk.newBuilder()
.setBoot(boot)
// Remember to set auto_delete to True if you want the disk to be deleted when
// you delete your VM instance.
.setAutoDelete(true)
.setType(Type.PERSISTENT.toString())
.setInitializeParams(
AttachedDiskInitializeParams.newBuilder()
.setSourceImage(sourceImage)
.setDiskSizeGb(diskSizeGb)
.setDiskType(diskType)
.build())
.build();
return disk;
}
/**
* Create an AttachedDisk object to be used in VM instance creation. The created disk contains no
* data and requires formatting before it can be used.
*
* @param diskType the type of disk you want to create. This value uses the following format:
* "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example:
* "zones/us-west3-b/diskTypes/pd-ssd"
* @param diskSizeGb size of the new disk in gigabytes
* @return AttachedDisk object configured to be created as an empty disk.
*/
private static AttachedDisk emptyDisk(String diskType, int diskSizeGb) {
AttachedDisk disk =
AttachedDisk.newBuilder()
.setBoot(false)
// Remember to set auto_delete to True if you want the disk to be deleted when
// you delete your VM instance.
.setAutoDelete(true)
.setType(Type.PERSISTENT.toString())
.setInitializeParams(
AttachedDiskInitializeParams.newBuilder()
.setDiskSizeGb(diskSizeGb)
.setDiskType(diskType)
.build())
.build();
return disk;
}
/**
* Send an instance creation request to the Compute Engine API and wait for it to complete.
*
* @param project project ID or project number of the Cloud project you want to use.
* @param zone name of the zone to create the instance in. For example: "us-west3-b"
* @param instanceName name of the new virtual machine (VM) instance.
* @param disks a list of compute_v1.AttachedDisk objects describing the disks you want to attach
* to your new instance.
* @param machineType machine type of the VM being created. This value uses the following format:
* "zones/{zone}/machineTypes/{type_name}".
* For example: "zones/europe-west3-c/machineTypes/f1-micro"
* @param network name of the network you want the new instance to use. For example:
* "global/networks/default" represents the network named "default", which is created
* automatically for each project.
* @param subnetwork name of the subnetwork you want the new instance to use. This value uses the
* following format: "regions/{region}/subnetworks/{subnetwork_name}"
* @return Instance object.
*/
private static Instance createWithDisks(String project, String zone, String instanceName,
Vector<AttachedDisk> disks, String machineType, String network, String subnetwork)
throws IOException, InterruptedException, ExecutionException, TimeoutException {
try (InstancesClient instancesClient = InstancesClient.create()) {
// Use the network interface provided in the networkName argument.
NetworkInterface networkInterface;
if (subnetwork != null) {
networkInterface = NetworkInterface.newBuilder()
.setName(network).setSubnetwork(subnetwork)
.build();
} else {
networkInterface = NetworkInterface.newBuilder()
.setName(network).build();
}
machineType = String.format("zones/%s/machineTypes/%s", zone, machineType);
// Bind `instanceName`, `machineType`, `disk`, and `networkInterface` to an instance.
Instance instanceResource =
Instance.newBuilder()
.setName(instanceName)
.setMachineType(machineType)
.addAllDisks(disks)
.addNetworkInterfaces(networkInterface)
.build();
System.out.printf("Creating instance: %s at %s ", instanceName, zone);
// Insert the instance in the specified project and zone.
InsertInstanceRequest insertInstanceRequest = InsertInstanceRequest.newBuilder()
.setProject(project)
.setZone(zone)
.setInstanceResource(instanceResource).build();
OperationFuture<Operation, Operation> operation = instancesClient.insertAsync(
insertInstanceRequest);
// Wait for the operation to complete.
Operation response = operation.get(3, TimeUnit.MINUTES);
if (response.hasError()) {
System.out.println("Instance creation failed ! ! " + response);
return null;
}
System.out.println("Operation Status: " + response.getStatus());
return instancesClient.get(project, zone, instanceName);
}
}
/**
* Create a new VM instance with Debian 10 operating system and a 11 GB additional empty disk.
*
* @param project project ID or project number of the Cloud project you want to use.
* @param zone name of the zone to create the instance in. For example: "us-west3-b"
* @param instanceName name of the new virtual machine (VM) instance.
* @return Instance object.
*/
public static Instance createWithAdditionalDisk(String project, String zone, String instanceName)
throws IOException, InterruptedException, ExecutionException, TimeoutException {
try (ImagesClient imagesClient = ImagesClient.create()) {
// List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details
Image image = imagesClient.getFromFamily("debian-cloud", "debian-10");
String diskType = String.format("zones/%s/diskTypes/pd-standard", zone);
Vector<AttachedDisk> disks = new Vector<>();
disks.add(diskFromImage(diskType, 10, true, image.getSelfLink()));
disks.add(emptyDisk(diskType, 11));
return createWithDisks(project, zone, instanceName, disks, "n1-standard-1",
"global/networks/default", null);
}
}
import re
import sys
from typing import Any, List
from google.api_core.extended_operation import ExtendedOperation
from google.cloud import compute_v1
def get_image_from_family(project: str, family: str) -> compute_v1.Image:
"""
Retrieve the newest image that is part of a given family in a project.
Args:
project: project ID or project number of the Cloud project you want to get image from.
family: name of the image family you want to get image from.
Returns:
An Image object.
"""
image_client = compute_v1.ImagesClient()
# List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details
newest_image = image_client.get_from_family(project=project, family=family)
return newest_image
def disk_from_image(
disk_type: str,
disk_size_gb: int,
boot: bool,
source_image: str,
auto_delete: bool = True,
) -> compute_v1.AttachedDisk:
"""
Create an AttachedDisk object to be used in VM instance creation. Uses an image as the
source for the new disk.
Args:
disk_type: the type of disk you want to create. This value uses the following format:
"zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".
For example: "zones/us-west3-b/diskTypes/pd-ssd"
disk_size_gb: size of the new disk in gigabytes
boot: boolean flag indicating whether this disk should be used as a boot disk of an instance
source_image: source image to use when creating this disk. You must have read access to this disk. This can be one
of the publicly available images or an image from one of your projects.
This value uses the following format: "projects/{project_name}/global/images/{image_name}"
auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it
Returns:
AttachedDisk object configured to be created using the specified image.
"""
boot_disk = compute_v1.AttachedDisk()
initialize_params = compute_v1.AttachedDiskInitializeParams()
initialize_params.source_image = source_image
initialize_params.disk_size_gb = disk_size_gb
initialize_params.disk_type = disk_type
boot_disk.initialize_params = initialize_params
# Remember to set auto_delete to True if you want the disk to be deleted when you delete
# your VM instance.
boot_disk.auto_delete = auto_delete
boot_disk.boot = boot
return boot_disk
def empty_disk(
disk_type: str, disk_size_gb: int, boot: bool = False, auto_delete: bool = True
) -> compute_v1.AttachedDisk():
"""
Create an AttachedDisk object to be used in VM instance creation. The created disk contains
no data and requires formatting before it can be used.
Args:
disk_type: the type of disk you want to create. This value uses the following format:
"zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".
For example: "zones/us-west3-b/diskTypes/pd-ssd"
disk_size_gb: size of the new disk in gigabytes
boot: boolean flag indicating whether this disk should be used as a boot disk of an instance
auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it
Returns:
AttachedDisk object configured to be created as an empty disk.
"""
disk = compute_v1.AttachedDisk()
initialize_params = compute_v1.AttachedDiskInitializeParams()
initialize_params.disk_type = disk_type
initialize_params.disk_size_gb = disk_size_gb
disk.initialize_params = initialize_params
# Remember to set auto_delete to True if you want the disk to be deleted when you delete
# your VM instance.
disk.auto_delete = auto_delete
disk.boot = boot
return disk
def wait_for_extended_operation(
operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300
) -> Any:
"""
This method will wait 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(
project_id: str,
zone: str,
instance_name: str,
disks: List[compute_v1.AttachedDisk],
machine_type: str = "n1-standard-1",
network_link: str = "global/networks/default",
subnetwork_link: str = None,
internal_ip: str = None,
external_access: bool = False,
external_ipv4: str = None,
accelerators: List[compute_v1.AcceleratorConfig] = None,
preemptible: bool = False,
custom_hostname: str = None,
delete_protection: bool = False,
) -> compute_v1.Instance:
"""
Send an instance creation request to the Compute Engine API and wait for it to complete.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
disks: a list of compute_v1.AttachedDisk objects describing the disks
you want to attach to your new instance.
machine_type: machine type of the VM being created. This value uses the
following format: "zones/{zone}/machineTypes/{type_name}".
For example: "zones/europe-west3-c/machineTypes/f1-micro"
network_link: name of the network you want the new instance to use.
For example: "global/networks/default" represents the network
named "default", which is created automatically for each project.
subnetwork_link: name of the subnetwork you want the new instance to use.
This value uses the following format:
"regions/{region}/subnetworks/{subnetwork_name}"
internal_ip: internal IP address you want to assign to the new instance.
By default, a free address from the pool of available internal IP addresses of
used subnet will be used.
external_access: boolean flag indicating if the instance should have an external IPv4
address assigned.
external_ipv4: external IPv4 address to be assigned to this instance. If you specify
an external IP address, it must live in the same region as the zone of the instance.
This setting requires `external_access` to be set to True to work.
accelerators: a list of AcceleratorConfig objects describing the accelerators that will
be attached to the new instance.
preemptible: boolean value indicating if the new instance should be preemptible
or not.
custom_hostname: Custom hostname of the new VM instance.
Custom hostnames must conform to RFC 1035 requirements for valid hostnames.
delete_protection: boolean value indicating if the new virtual machine should be
protected against deletion or not.
Returns:
Instance object.
"""
instance_client = compute_v1.InstancesClient()
# Use the network interface provided in the network_link argument.
network_interface = compute_v1.NetworkInterface()
network_interface.name = network_link
if subnetwork_link:
network_interface.subnetwork = subnetwork_link
if internal_ip:
network_interface.network_i_p = internal_ip
if external_access:
access = compute_v1.AccessConfig()
access.type_ = compute_v1.AccessConfig.Type.ONE_TO_ONE_NAT.name
access.name = "External NAT"
access.network_tier = access.NetworkTier.PREMIUM.name
if external_ipv4:
access.nat_i_p = external_ipv4
network_interface.access_configs = [access]
# Collect information into the Instance object.
instance = compute_v1.Instance()
instance.name = instance_name
instance.disks = disks
if re.match(r"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$", machine_type):
instance.machine_type = machine_type
else:
instance.machine_type = f"zones/{zone}/machineTypes/{machine_type}"
if accelerators:
instance.guest_accelerators = accelerators
instance.network_interfaces = [network_interface]
if preemptible:
# Set the preemptible setting
instance.scheduling = compute_v1.Scheduling()
instance.scheduling.preemptible = True
if custom_hostname is not None:
# Set the custom hostname for the instance
instance.hostname = custom_hostname
if delete_protection:
# Set the delete protection bit
instance.deletion_protection = True
# Prepare the request to insert an instance.
request = compute_v1.InsertInstanceRequest()
request.zone = zone
request.project = project_id
request.instance_resource = instance
# Wait for the create operation to complete.
print(f"Creating the {instance_name} instance in {zone}...")
operation = instance_client.insert(request=request)
wait_for_extended_operation(operation, "instance creation")
print(f"Instance {instance_name} created.")
return instance_client.get(project=project_id, zone=zone, instance=instance_name)
def create_with_additional_disk(
project_id: str, zone: str, instance_name: str
) -> compute_v1.Instance:
"""
Create a new VM instance with Debian 10 operating system on a 20 GB disk
and a 25 GB additional empty disk.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
Returns:
Instance object.
"""
newest_debian = get_image_from_family(project="debian-cloud", family="debian-10")
disk_type = f"zones/{zone}/diskTypes/pd-standard"
disks = [
disk_from_image(disk_type, 20, True, newest_debian.self_link),
empty_disk(disk_type, 25),
]
instance = create_instance(project_id, zone, instance_name, disks)
return instance
To perform this task, you must have the following
permissions:
compute.instances.create on the project
compute.instances.updateShieldedVmConfig if you plan to create a
Shielded VM instance and you want
to be able to change any of the Shielded VM settings
compute.networks.use on the project if using a legacy
network
compute.subnetworks.use either on the whole project or on the chosen subnet
(VPC networks)
compute.networks.useExternalIp on the project if you need to assign an external
IP address (either ephemeral or static) to the instance using a legacy network
compute.subnetworks.useExternalIp either on the whole project or on the chosen
subnet if you need to assign an external IP address (either ephemeral or static) to the instance
using a VPC network
compute.addresses.use on the project if specifying a static address in the
project
compute.instances.setMetadata if setting metadata
compute.instances.setTags on the instance if setting tags
compute.instances.setLabels on the instance if setting
labels
compute.images.useReadOnly on the image if creating a new root
persistent disk
compute.disks.create on the project if creating a new root
persistent disk with this instance
compute.disks.useReadOnly on the disk if attaching an existing
persistent disk in read-only mode
compute.disks.use on the disk if attaching an existing disk in
read/write mode
compute.disks.setLabels on the disk if setting
labels
compute.snapshots.create on the project to create a new
snapshot if creating an instance from a snapshot
compute.snapshots.useReadOnly on the snapshot if creating an instance
from a snapshot
Restoring a non-boot disk: If you backed up a non-boot disk with a
snapshot, you can restore the snapshot to a new non-boot disk when you create
a VM. For instructions, see Creating a VM with a non-boot disk based on a
snapshot.
To deploy and launch a container on a Compute Engine VM, specify
a container image name and optional configuration parameters when you
create the VM. Compute Engine creates the VM by using the
latest version of the
Container-optimized OS public image, which has
Docker installed. Then, Compute Engine launches the container when
the VM starts. For more information, see
Deploying containers on VMs.
To create a VM from a container image, you must use the Cloud console or gcloud.
Permissions required for this task
To perform this task, you must have the following
permissions:
compute.instances.create on the project
compute.instances.updateShieldedVmConfig if you plan to create a
Shielded VM instance and you want
to be able to change any of the Shielded VM settings
compute.networks.use on the project if using a legacy
network
compute.subnetworks.use either on the whole project or on the chosen subnet
(VPC networks)
compute.networks.useExternalIp on the project if you need to assign an external
IP address (either ephemeral or static) to the instance using a legacy network
compute.subnetworks.useExternalIp either on the whole project or on the chosen
subnet if you need to assign an external IP address (either ephemeral or static) to the instance
using a VPC network
compute.addresses.use on the project if specifying a static address in the
project
compute.instances.setMetadata if setting metadata
compute.instances.setTags on the instance if setting tags
compute.instances.setLabels on the instance if setting
labels
compute.images.useReadOnly on the image if creating a new root
persistent disk
compute.disks.create on the project if creating a new root
persistent disk with this instance
compute.disks.useReadOnly on the disk if attaching an existing
persistent disk in read-only mode
compute.disks.use on the disk if attaching an existing disk in
read/write mode
compute.disks.setLabels on the disk if setting
labels
compute.snapshots.create on the project to create a new
snapshot if creating an instance from a snapshot
compute.snapshots.useReadOnly on the snapshot if creating an instance
from a snapshot
Console
In the Google Cloud console, go to the VM instances page.
To deploy an Apache container image from Docker Hub, always specify
the full Docker image name:
docker.io/httpd:2.4.
Create a VM instance with access to other Google Cloud Services
If you plan to run an application on your VM that needs access to other
Google Cloud services,
create a service account
before creating the VM, and then
set up the VM to run as a service account.
A service account is a special account whose credentials you can use in your
application code to access other Google Cloud services.
To perform this task, you must have the following
permissions:
compute.instances.create on the project
compute.instances.updateShieldedVmConfig if you plan to create a
Shielded VM instance and you want
to be able to change any of the Shielded VM settings
compute.networks.use on the project if using a legacy
network
compute.subnetworks.use either on the whole project or on the chosen subnet
(VPC networks)
compute.networks.useExternalIp on the project if you need to assign an external
IP address (either ephemeral or static) to the instance using a legacy network
compute.subnetworks.useExternalIp either on the whole project or on the chosen
subnet if you need to assign an external IP address (either ephemeral or static) to the instance
using a VPC network
compute.addresses.use on the project if specifying a static address in the
project
compute.instances.setMetadata if setting metadata
compute.instances.setTags on the instance if setting tags
compute.instances.setLabels on the instance if setting
labels
compute.images.useReadOnly on the image if creating a new root
persistent disk
compute.disks.create on the project if creating a new root
persistent disk with this instance
compute.disks.useReadOnly on the disk if attaching an existing
persistent disk in read-only mode
compute.disks.use on the disk if attaching an existing disk in
read/write mode
compute.disks.setLabels on the disk if setting
labels
compute.snapshots.create on the project to create a new
snapshot if creating an instance from a snapshot
compute.snapshots.useReadOnly on the snapshot if creating an instance
from a snapshot
By default, Google Cloud creates an
auto mode VPC network called default for each project.
To use a different network or a subnet that you manually created in an auto mode
or custom mode VPC network, you must specify the subnet when you create the VM.
While creating a VM in a subnet, consider these rules:
If you don't specify a network or subnet, Compute Engine
uses the default VPC network and the auto subnet that's in the same region as the VM.
If you don't specify a network, Compute Engine infers the network
from the subnet specified.
If you specify a network, you must specify a subnet and it must belong
to the same network. Otherwise, VM creation fails.
Console
In the Google Cloud console, go to the VM instances page.
Optional: Change the Zone for this VM. Compute Engine
randomizes the list of zones within each region to encourage use across
multiple zones.
In the Firewall section, to permit HTTP or HTTPS traffic to
the VM, select Allow HTTP traffic or Allow HTTPS traffic.
The Cloud console adds a network tag to your VM and
creates the corresponding ingress firewall rule that allows all
incoming traffic on tcp:80 (HTTP) or tcp:443 (HTTPS). The network
tag associates the firewall rule with the VM. For more
information, see Firewall rules overview in
the Virtual Private Cloud documentation.
Expand the Networking, disks, security, management, sole tenancy section.
Expand the Networking section.
For Network interfaces, specify the network details:
In the Network field, select the VPC network that contains
the subnet you created.
In the Subnet field, select the subnet for the VM to
use.
ZONE: zone where the VM is created,
such as europe-west1-b
The VM's region is inferred from the zone.
API
Follow the API instructions to
create a VM from an image or a
snapshot, but specify the subnet field in the request
body. To add blank disks, do not add a source image. You can optionally
specify the diskSizeGb, diskType, and
labels properties.
import com.google.api.gax.longrunning.OperationFuture;
import com.google.cloud.compute.v1.AttachedDisk;
import com.google.cloud.compute.v1.AttachedDisk.Type;
import com.google.cloud.compute.v1.AttachedDiskInitializeParams;
import com.google.cloud.compute.v1.Image;
import com.google.cloud.compute.v1.ImagesClient;
import com.google.cloud.compute.v1.InsertInstanceRequest;
import com.google.cloud.compute.v1.Instance;
import com.google.cloud.compute.v1.InstancesClient;
import com.google.cloud.compute.v1.NetworkInterface;
import com.google.cloud.compute.v1.Operation;
import java.io.IOException;
import java.util.Vector;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class CreateInstancesAdvanced {
/**
* Create an AttachedDisk object to be used in VM instance creation. Uses an image as the source
* for the new disk.
*
* @param diskType the type of disk you want to create. This value uses the following format:
* "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example:
* "zones/us-west3-b/diskTypes/pd-ssd"
* @param diskSizeGb size of the new disk in gigabytes
* @param boot boolean flag indicating whether this disk should be used as a boot disk of an
* instance
* @param sourceImage source image to use when creating this disk. You must have read access to
* this disk. This can be one of the publicly available images or an image from one of your
* projects. This value uses the following format:
* "projects/{project_name}/global/images/{image_name}"
* @return AttachedDisk object configured to be created using the specified image.
*/
private static AttachedDisk diskFromImage(String diskType, int diskSizeGb, boolean boot,
String sourceImage) {
AttachedDisk disk =
AttachedDisk.newBuilder()
.setBoot(boot)
// Remember to set auto_delete to True if you want the disk to be deleted when
// you delete your VM instance.
.setAutoDelete(true)
.setType(Type.PERSISTENT.toString())
.setInitializeParams(
AttachedDiskInitializeParams.newBuilder()
.setSourceImage(sourceImage)
.setDiskSizeGb(diskSizeGb)
.setDiskType(diskType)
.build())
.build();
return disk;
}
/**
* Send an instance creation request to the Compute Engine API and wait for it to complete.
*
* @param project project ID or project number of the Cloud project you want to use.
* @param zone name of the zone to create the instance in. For example: "us-west3-b"
* @param instanceName name of the new virtual machine (VM) instance.
* @param disks a list of compute_v1.AttachedDisk objects describing the disks you want to attach
* to your new instance.
* @param machineType machine type of the VM being created. This value uses the following format:
* "zones/{zone}/machineTypes/{type_name}".
* For example: "zones/europe-west3-c/machineTypes/f1-micro"
* @param network name of the network you want the new instance to use. For example:
* "global/networks/default" represents the network named "default", which is created
* automatically for each project.
* @param subnetwork name of the subnetwork you want the new instance to use. This value uses the
* following format: "regions/{region}/subnetworks/{subnetwork_name}"
* @return Instance object.
*/
private static Instance createWithDisks(String project, String zone, String instanceName,
Vector<AttachedDisk> disks, String machineType, String network, String subnetwork)
throws IOException, InterruptedException, ExecutionException, TimeoutException {
try (InstancesClient instancesClient = InstancesClient.create()) {
// Use the network interface provided in the networkName argument.
NetworkInterface networkInterface;
if (subnetwork != null) {
networkInterface = NetworkInterface.newBuilder()
.setName(network).setSubnetwork(subnetwork)
.build();
} else {
networkInterface = NetworkInterface.newBuilder()
.setName(network).build();
}
machineType = String.format("zones/%s/machineTypes/%s", zone, machineType);
// Bind `instanceName`, `machineType`, `disk`, and `networkInterface` to an instance.
Instance instanceResource =
Instance.newBuilder()
.setName(instanceName)
.setMachineType(machineType)
.addAllDisks(disks)
.addNetworkInterfaces(networkInterface)
.build();
System.out.printf("Creating instance: %s at %s ", instanceName, zone);
// Insert the instance in the specified project and zone.
InsertInstanceRequest insertInstanceRequest = InsertInstanceRequest.newBuilder()
.setProject(project)
.setZone(zone)
.setInstanceResource(instanceResource).build();
OperationFuture<Operation, Operation> operation = instancesClient.insertAsync(
insertInstanceRequest);
// Wait for the operation to complete.
Operation response = operation.get(3, TimeUnit.MINUTES);
if (response.hasError()) {
System.out.println("Instance creation failed ! ! " + response);
return null;
}
System.out.println("Operation Status: " + response.getStatus());
return instancesClient.get(project, zone, instanceName);
}
}
import re
import sys
from typing import Any, List
from google.api_core.extended_operation import ExtendedOperation
from google.cloud import compute_v1
def get_image_from_family(project: str, family: str) -> compute_v1.Image:
"""
Retrieve the newest image that is part of a given family in a project.
Args:
project: project ID or project number of the Cloud project you want to get image from.
family: name of the image family you want to get image from.
Returns:
An Image object.
"""
image_client = compute_v1.ImagesClient()
# List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details
newest_image = image_client.get_from_family(project=project, family=family)
return newest_image
def disk_from_image(
disk_type: str,
disk_size_gb: int,
boot: bool,
source_image: str,
auto_delete: bool = True,
) -> compute_v1.AttachedDisk:
"""
Create an AttachedDisk object to be used in VM instance creation. Uses an image as the
source for the new disk.
Args:
disk_type: the type of disk you want to create. This value uses the following format:
"zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".
For example: "zones/us-west3-b/diskTypes/pd-ssd"
disk_size_gb: size of the new disk in gigabytes
boot: boolean flag indicating whether this disk should be used as a boot disk of an instance
source_image: source image to use when creating this disk. You must have read access to this disk. This can be one
of the publicly available images or an image from one of your projects.
This value uses the following format: "projects/{project_name}/global/images/{image_name}"
auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it
Returns:
AttachedDisk object configured to be created using the specified image.
"""
boot_disk = compute_v1.AttachedDisk()
initialize_params = compute_v1.AttachedDiskInitializeParams()
initialize_params.source_image = source_image
initialize_params.disk_size_gb = disk_size_gb
initialize_params.disk_type = disk_type
boot_disk.initialize_params = initialize_params
# Remember to set auto_delete to True if you want the disk to be deleted when you delete
# your VM instance.
boot_disk.auto_delete = auto_delete
boot_disk.boot = boot
return boot_disk
def wait_for_extended_operation(
operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300
) -> Any:
"""
This method will wait 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(
project_id: str,
zone: str,
instance_name: str,
disks: List[compute_v1.AttachedDisk],
machine_type: str = "n1-standard-1",
network_link: str = "global/networks/default",
subnetwork_link: str = None,
internal_ip: str = None,
external_access: bool = False,
external_ipv4: str = None,
accelerators: List[compute_v1.AcceleratorConfig] = None,
preemptible: bool = False,
custom_hostname: str = None,
delete_protection: bool = False,
) -> compute_v1.Instance:
"""
Send an instance creation request to the Compute Engine API and wait for it to complete.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
disks: a list of compute_v1.AttachedDisk objects describing the disks
you want to attach to your new instance.
machine_type: machine type of the VM being created. This value uses the
following format: "zones/{zone}/machineTypes/{type_name}".
For example: "zones/europe-west3-c/machineTypes/f1-micro"
network_link: name of the network you want the new instance to use.
For example: "global/networks/default" represents the network
named "default", which is created automatically for each project.
subnetwork_link: name of the subnetwork you want the new instance to use.
This value uses the following format:
"regions/{region}/subnetworks/{subnetwork_name}"
internal_ip: internal IP address you want to assign to the new instance.
By default, a free address from the pool of available internal IP addresses of
used subnet will be used.
external_access: boolean flag indicating if the instance should have an external IPv4
address assigned.
external_ipv4: external IPv4 address to be assigned to this instance. If you specify
an external IP address, it must live in the same region as the zone of the instance.
This setting requires `external_access` to be set to True to work.
accelerators: a list of AcceleratorConfig objects describing the accelerators that will
be attached to the new instance.
preemptible: boolean value indicating if the new instance should be preemptible
or not.
custom_hostname: Custom hostname of the new VM instance.
Custom hostnames must conform to RFC 1035 requirements for valid hostnames.
delete_protection: boolean value indicating if the new virtual machine should be
protected against deletion or not.
Returns:
Instance object.
"""
instance_client = compute_v1.InstancesClient()
# Use the network interface provided in the network_link argument.
network_interface = compute_v1.NetworkInterface()
network_interface.name = network_link
if subnetwork_link:
network_interface.subnetwork = subnetwork_link
if internal_ip:
network_interface.network_i_p = internal_ip
if external_access:
access = compute_v1.AccessConfig()
access.type_ = compute_v1.AccessConfig.Type.ONE_TO_ONE_NAT.name
access.name = "External NAT"
access.network_tier = access.NetworkTier.PREMIUM.name
if external_ipv4:
access.nat_i_p = external_ipv4
network_interface.access_configs = [access]
# Collect information into the Instance object.
instance = compute_v1.Instance()
instance.name = instance_name
instance.disks = disks
if re.match(r"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$", machine_type):
instance.machine_type = machine_type
else:
instance.machine_type = f"zones/{zone}/machineTypes/{machine_type}"
if accelerators:
instance.guest_accelerators = accelerators
instance.network_interfaces = [network_interface]
if preemptible:
# Set the preemptible setting
instance.scheduling = compute_v1.Scheduling()
instance.scheduling.preemptible = True
if custom_hostname is not None:
# Set the custom hostname for the instance
instance.hostname = custom_hostname
if delete_protection:
# Set the delete protection bit
instance.deletion_protection = True
# Prepare the request to insert an instance.
request = compute_v1.InsertInstanceRequest()
request.zone = zone
request.project = project_id
request.instance_resource = instance
# Wait for the create operation to complete.
print(f"Creating the {instance_name} instance in {zone}...")
operation = instance_client.insert(request=request)
wait_for_extended_operation(operation, "instance creation")
print(f"Instance {instance_name} created.")
return instance_client.get(project=project_id, zone=zone, instance=instance_name)
def create_with_subnet(
project_id: str, zone: str, instance_name: str, network_link: str, subnet_link: str
) -> compute_v1.Instance:
"""
Create a new VM instance with Debian 10 operating system in specified network and subnetwork.
Args:
project_id: project ID or project number of the Cloud project you want to use.
zone: name of the zone to create the instance in. For example: "us-west3-b"
instance_name: name of the new virtual machine (VM) instance.
network_link: name of the network you want the new instance to use.
For example: "global/networks/default" represents the network
named "default", which is created automatically for each project.
subnetwork_link: name of the subnetwork you want the new instance to use.
This value uses the following format:
"regions/{region}/subnetworks/{subnetwork_name}"
Returns:
Instance object.
"""
newest_debian = get_image_from_family(project="debian-cloud", family="debian-10")
disk_type = f"zones/{zone}/diskTypes/pd-standard"
disks = [disk_from_image(disk_type, 10, True, newest_debian.self_link)]
instance = create_instance(
project_id,
zone,
instance_name,
disks,
network_link=network_link,
subnetwork_link=subnet_link,
)
return instance
If you're new to Google Cloud, create an account to evaluate how
Compute Engine performs in real-world
scenarios. New customers also get $300 in free credits to run, test, and
deploy workloads.