\n \n \n \n \n \n\n \n \n \n\n \n\n \n

\n Create custom images\n
\n\n \n \n\n \n \n Stay organized with collections\n \n \n \n Save and categorize content based on your preferences.\n \n
\n \n

\n \n\n \n \n \n \n \n\n

\n\n \n \n \n\n \n \n

\n \n \n \n \n \n \n\n \n Linux\n\n \n\n \n \n

\n \n

\n \n\n \n\n \n\n \n\n \n \n\n \n\n\n\n\n\n

You can create custom images from source disks, images, snapshots, or images\nstored in Cloud Storage and use these images to create virtual machine (VM)\ninstances. Custom images are ideal for situations where you have created and\nmodified a persistent boot disk or specific image to a certain state and need to\nsave that state for creating VMs.

\n\n

Alternatively, you can use the virtual disk import\ntool to import boot disk images\nto Compute Engine from your existing systems and add them to your custom\nimages list.

\n\n\n\n \n \n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n

Before you begin

Read the Images document.
\n \n If you haven\'t already, then set up authentication.\n Authentication is\n the process by which your identity is verified for access to Google Cloud services and APIs.\n To run code or samples from a local development environment, you can authenticate to\n Compute Engine by selecting one of the following options:
\n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n \n \n
Select the tab for how you plan to use the samples on this page:
\n \n \n\n \n
\n \n\n \n \n \n
\n
Console
\n \n
\n When you use the Google Cloud console to access Google Cloud services and\n APIs, you don\'t need to set up authentication.\n
\n \n
\n \n \n\n \n \n \n
\n
gcloud
\n \n \n\n\n \n\n\n\n\n \n\n\n\n \n\n\n
1. \n\n \n \n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n \n \n
  \n After installing the Google Cloud CLI,\n initialize it by running the following command:\n
  \n
  gcloud init
  \n
  \n If you\'re using an external identity provider (IdP), you must first\n \n sign in to the gcloud CLI with your federated identity.\n
  \n \n \n \n\n\n\n\n\n\n
  \n Note: If you installed the gcloud CLI previously, make sure you have\n the latest version by running gcloud components update.\n
  \n\n\n\n\n \n \n\n \n\n \n \n\n\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n\n
  \n Note: If you installed the gcloud CLI previously, make sure you have\n the latest version by running gcloud components update.\n
  \n\n\n\n\n \n \n
2. \n Set a default region and zone.
\n \n\n\n\n \n \n
\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n \n \n
\n
Go
\n \n \n \n\n
\n To use the Go samples on this page in a local\n development environment, install and initialize the gcloud CLI, and\n then set up Application Default Credentials with your user credentials.\n
\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n\n\n\n\n \n \n
1. \n
  \n Install the Google Cloud CLI.\n
  \n \n \n\n\n\n\n\n\n
  \n Note: If you installed the gcloud CLI previously, make sure you have\n the latest version by running gcloud components update.\n
  \n\n\n\n
2. \n
  If you\'re using an external identity provider (IdP), you must first\n \n sign in to the gcloud CLI with your federated identity.\n
  \n
3. \n
  \n To initialize the gcloud CLI, run the following command:\n
  \n
  gcloud init
  \n
4. \n \n
  \n \n If you\'re using a local shell, then create local authentication credentials for your user\n account:\n \n
  \n
  gcloud auth application-default login
  \n \n
  You don\'t need to do this if you\'re using Cloud Shell.
  \n \n \n \n
  \n If an authentication error is returned, and you are using an external identity provider\n (IdP), confirm that you have\n \n signed in to the gcloud CLI with your federated identity.\n
  \n \n \n
\n \n \n \n\n \n \n \n \n
\n
Java
\n \n \n \n\n
\n To use the Java samples on this page in a local\n development environment, install and initialize the gcloud CLI, and\n then set up Application Default Credentials with your user credentials.\n
\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n\n\n\n\n \n \n
1. \n
  \n Install the Google Cloud CLI.\n
  \n \n \n\n\n\n\n\n\n
  \n Note: If you installed the gcloud CLI previously, make sure you have\n the latest version by running gcloud components update.\n
  \n\n\n\n
2. \n
  If you\'re using an external identity provider (IdP), you must first\n \n sign in to the gcloud CLI with your federated identity.\n
  \n
3. \n
  \n To initialize the gcloud CLI, run the following command:\n
  \n
  gcloud init
  \n
4. \n \n
  \n \n If you\'re using a local shell, then create local authentication credentials for your user\n account:\n \n
  \n
  gcloud auth application-default login
  \n \n
  You don\'t need to do this if you\'re using Cloud Shell.
  \n \n \n \n
  \n If an authentication error is returned, and you are using an external identity provider\n (IdP), confirm that you have\n \n signed in to the gcloud CLI with your federated identity.\n
  \n \n \n
\n \n \n \n\n \n \n \n \n
\n
Node.js
\n \n \n \n\n
\n To use the Node.js samples on this page in a local\n development environment, install and initialize the gcloud CLI, and\n then set up Application Default Credentials with your user credentials.\n
\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n\n\n\n\n \n \n
1. \n
  \n Install the Google Cloud CLI.\n
  \n \n \n\n\n\n\n\n\n
  \n Note: If you installed the gcloud CLI previously, make sure you have\n the latest version by running gcloud components update.\n
  \n\n\n\n
2. \n
  If you\'re using an external identity provider (IdP), you must first\n \n sign in to the gcloud CLI with your federated identity.\n
  \n
3. \n
  \n To initialize the gcloud CLI, run the following command:\n
  \n
  gcloud init
  \n
4. \n \n
  \n \n If you\'re using a local shell, then create local authentication credentials for your user\n account:\n \n
  \n
  gcloud auth application-default login
  \n \n
  You don\'t need to do this if you\'re using Cloud Shell.
  \n \n \n \n
  \n If an authentication error is returned, and you are using an external identity provider\n (IdP), confirm that you have\n \n signed in to the gcloud CLI with your federated identity.\n
  \n \n \n
\n \n \n \n\n \n \n\n \n \n \n \n
\n
Python
\n \n \n \n\n
\n To use the Python samples on this page in a local\n development environment, install and initialize the gcloud CLI, and\n then set up Application Default Credentials with your user credentials.\n
\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n\n\n\n\n \n \n
1. \n
  \n Install the Google Cloud CLI.\n
  \n \n \n\n\n\n\n\n\n
  \n Note: If you installed the gcloud CLI previously, make sure you have\n the latest version by running gcloud components update.\n
  \n\n\n\n
2. \n
  If you\'re using an external identity provider (IdP), you must first\n \n sign in to the gcloud CLI with your federated identity.\n
  \n
3. \n
  \n To initialize the gcloud CLI, run the following command:\n
  \n
  gcloud init
  \n
4. \n \n
  \n \n If you\'re using a local shell, then create local authentication credentials for your user\n account:\n \n
  \n
  gcloud auth application-default login
  \n \n
  You don\'t need to do this if you\'re using Cloud Shell.
  \n \n \n \n
  \n If an authentication error is returned, and you are using an external identity provider\n (IdP), confirm that you have\n \n signed in to the gcloud CLI with your federated identity.\n
  \n \n \n
\n \n \n \n\n \n \n\n \n \n\n \n\n \n \n \n
\n
REST
\n \n \n\n\n\n
\n To use the REST API samples on this page in a local development environment,\n you use the credentials you provide to the gcloud CLI.\n
\n\n
\n
\n For more information, see\n Authenticate for using REST\n in the Google Cloud authentication documentation.\n
\n\n \n\n \n
\n \n \n \n
\n \n\n \n \n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n

\n\n \n\n \n\n

Create a custom image

\n\n

This section describes how to create a custom image on a Linux VM. For\ninformation about creating a Windows image, see Creating a Windows\nimage.

\n\n

Select an image storage location

\n\n

When creating a custom image, you can specify the image's\nCloud Storage location, excluding dual-region\nlocations. By specifying the image storage location, you can meet your\nregulatory and compliance requirements for data locality as well as your high\navailability needs by ensuring redundancy across regions. To create, modify, and\ndelete images stored in Cloud Storage, you must have\nroles/compute.storageAdmin.

\n\n

The storage location feature is optional. If you don't select a location,\nCompute Engine stores your image in the multi-region closest to the\nimage source. For example, when you create an image from a source disk that is\nlocated in us-central1 and if you don't specify a location for the custom\nimage, then Compute Engine stores the image in the us multi-region.

\n\n

If the image is not available in a region where you are creating a\nVM, Compute Engine caches the image in that region the first time you\ncreate a VM.

\n\n

To see the location where an image is stored, use the\nimages describe\ncommand from gcloud compute:

\n\n

\ngcloud compute images describe IMAGE_NAME \\\n    --project=PROJECT_ID

\n\n

Replace the following:

\n\n

IMAGE_NAME: the name of your image.
PROJECT_ID: the project ID to which the image belongs.

\n\n

All of your existing images prior to this feature launch remain where they are,\nthe only change is that you can view the image location of all your images. If\nyou have an existing image you want to move, you must recreate it in the new\nlocation.

\n\n

Prepare your VM for an image

\n\n

You can create an image from a disk even while it is attached to a running\nVM. However, your image is more reliable if you put the VM\nin a state that is easier for the image to capture. This section describes how\nto prepare your boot disk for the image.

\n\n

Minimize writing data to the persistent disk

\n\n

Use one of the following processes to reduce the disk writes:

\n\n

Stop the VM\nso that it can shut down and stop writing any data to the persistent disk.
If you can't stop your VM before you create the image, minimize the\namount of writes to the disk and sync your file system. To minimize\nwriting to your persistent disk, follow these steps:
\n\n
1. Pause apps or operating system processes that write data to\nthat persistent disk.
2. Run an app flush to disk if necessary. For example, MySQL has a\nFLUSH \nstatement. Other apps might have similar processes.
3. Stop your apps from writing to your persistent disk.
4. Run sudo sync.

\n\n

Disable the auto-delete option for the disk

\n\n\nBy default, the auto-delete option is enabled on the boot disks. Before creating\nan image from a disk, disable auto-delete to ensure that the disk is not\nautomatically deleted when you delete the VM.

\n\n

Use one of the following methods to disable auto-delete for the disk.

Console

In the Google Cloud console, go to the VM instances page.
\n\n
Go to the VM instances page
Click the name of the VM that you're using as the source for creating\nan image.
\n\n
The VM instance details page displays.
Click Edit.
In the Boot disk section, for the Deletion rule, ensure that\nthe Keep disk option is selected.
Click Save.

gcloud

In the Google Cloud CLI, use the\ngcloud compute instances set-disk-auto-delete command\nto disable the auto-delete option for the disk.

\n\n

\ngcloud compute instances set-disk-auto-delete VM_NAME \\\n    --no-auto-delete \\\n    --disk=SOURCE_DISK\n

\n\n

Replace the following:

\n\n

VM_NAME: the name of your VM instance.
SOURCE_DISK: the name of the disk from which you want to create the image.

Go

\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n \n \n \n \n\n\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n\n\n \n \n \n\n\n\n \n\n\n

\n \n

Go

\n \n \n \n

\n \n \n Before trying this sample, follow the Go setup instructions in the\n Compute Engine quickstart using\n client libraries.\n \n \n \n For more information, see the\n Compute Engine Go API\n reference documentation.\n \n

\n To authenticate to Compute Engine, set up Application Default Credentials.\n For more information, see\n \n Set up authentication for a local development environment.\n \n

\n \n\n\n\n\n\n\n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n

\n\n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n \n\n\n

import (\n\t"context"\n\t"fmt"\n\t"io"\n\n\tcompute "cloud.google.com/go/compute/apiv1"\n\tcomputepb "cloud.google.com/go/compute/apiv1/computepb"\n)\n\n// setDiskAutodelete sets the autodelete flag of a disk to given value.\nfunc setDiskAutoDelete(\n\tw io.Writer,\n\tprojectID, zone, instanceName, diskName string, autoDelete bool,\n) error {\n\t// projectID := "your_project_id"\n\t// zone := "us-west3-b"\n\t// instanceName := "your_instance_name"\n\t// diskName := "your_disk_name"\n\t// autoDelete := true\n\n\tctx := context.Background()\n\tinstancesClient, err := compute.NewInstancesRESTClient(ctx)\n\tif err != nil {\n\t\treturn fmt.Errorf("NewInstancesRESTClient: %w", err)\n\t}\n\tdefer instancesClient.Close()\n\n\tgetInstanceReq := &computepb.GetInstanceRequest{\n\t\tProject:  projectID,\n\t\tZone:     zone,\n\t\tInstance: instanceName,\n\t}\n\n\tinstance, err := instancesClient.Get(ctx, getInstanceReq)\n\tif err != nil {\n\t\treturn fmt.Errorf("unable to get instance: %w", err)\n\t}\n\n\tdiskExists := false\n\n\tfor _, disk := range instance.GetDisks() {\n\t\tif disk.GetDeviceName() == diskName {\n\t\t\tdiskExists = true\n\t\t\tbreak\n\t\t}\n\t}\n\n\tif !diskExists {\n\t\treturn fmt.Errorf(\n\t\t\t"instance %s doesn\'t have a disk named %s attached",\n\t\t\tinstanceName,\n\t\t\tdiskName,\n\t\t)\n\t}\n\n\treq := &computepb.SetDiskAutoDeleteInstanceRequest{\n\t\tProject:    projectID,\n\t\tZone:       zone,\n\t\tInstance:   instanceName,\n\t\tDeviceName: diskName,\n\t\tAutoDelete: autoDelete,\n\t}\n\n\top, err := instancesClient.SetDiskAutoDelete(ctx, req)\n\tif err != nil {\n\t\treturn fmt.Errorf("unable to set disk autodelete field: %w", err)\n\t}\n\n\tif err = op.Wait(ctx); err != nil {\n\t\treturn fmt.Errorf("unable to wait for the operation: %w", err)\n\t}\n\n\tfmt.Fprintf(w, "disk autoDelete field updated.\\n")\n\n\treturn nil\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n

Java

\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n \n \n \n \n \n\n\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n \n \n \n\n\n\n \n\n\n

\n \n

Java

\n \n \n \n

\n \n \n Before trying this sample, follow the Java setup instructions in the\n Compute Engine quickstart using\n client libraries.\n \n \n \n For more information, see the\n Compute Engine Java API\n reference documentation.\n \n

\n To authenticate to Compute Engine, set up Application Default Credentials.\n For more information, see\n \n Set up authentication for a local development environment.\n \n

\n \n\n\n\n\n\n\n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n

\n\n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n \n\n\n

\nimport com.google.cloud.compute.v1.Instance;\nimport com.google.cloud.compute.v1.InstancesClient;\nimport com.google.cloud.compute.v1.Operation;\nimport com.google.cloud.compute.v1.SetDiskAutoDeleteInstanceRequest;\nimport java.io.IOException;\nimport java.util.concurrent.ExecutionException;\nimport java.util.concurrent.TimeUnit;\nimport java.util.concurrent.TimeoutException;\n\npublic class SetDiskAutodelete {\n\n  public static void main(String[] args)\n      throws IOException, ExecutionException, InterruptedException, TimeoutException {\n    // TODO(developer): Replace these variables before running the sample.\n\n    // Project ID or project number of the Cloud project you want to use.\n    String projectId = "YOUR_PROJECT_ID";\n\n    // The zone of the disk that you want to modify.\n    String zone = "europe-central2-b";\n\n    // Name of the instance the disk is attached to.\n    String instanceName = "YOUR_INSTANCE_NAME";\n\n    // The name of the disk for which you want to modify the autodelete flag.\n    String diskName = "YOUR_DISK_NAME";\n\n    // The new value of the autodelete flag.\n    boolean autoDelete = true;\n\n    setDiskAutodelete(projectId, zone, instanceName, diskName, autoDelete);\n  }\n\n  // Sets the autodelete flag of a disk to given value.\n  public static void setDiskAutodelete(String projectId, String zone, String instanceName,\n      String diskName, boolean autoDelete)\n      throws IOException, ExecutionException, InterruptedException, TimeoutException {\n\n    // Initialize client that will be used to send requests. This client only needs to be created\n    // once, and can be reused for multiple requests. After completing all of your requests, call\n    // the `instancesClient.close()` method on the client to safely\n    // clean up any remaining background resources.\n    try (InstancesClient instancesClient = InstancesClient.create()) {\n\n      // Retrieve the instance given by the instanceName.\n      Instance instance = instancesClient.get(projectId, zone, instanceName);\n\n      // Check if the instance contains a disk that matches the given diskName.\n      boolean diskNameMatch = instance.getDisksList()\n          .stream()\n          .anyMatch(disk -> disk.getDeviceName().equals(diskName));\n\n      if (!diskNameMatch) {\n        throw new Error(\n            String.format("Instance %s doesn\'t have a disk named %s attached", instanceName,\n                diskName));\n      }\n\n      // Create the request object.\n      SetDiskAutoDeleteInstanceRequest request = SetDiskAutoDeleteInstanceRequest.newBuilder()\n          .setProject(projectId)\n          .setZone(zone)\n          .setInstance(instanceName)\n          .setDeviceName(diskName)\n          // Update the autodelete property.\n          .setAutoDelete(autoDelete)\n          .build();\n\n      // Wait for the update instance operation to complete.\n      Operation response = instancesClient.setDiskAutoDeleteAsync(request)\n          .get(3, TimeUnit.MINUTES);\n\n      if (response.hasError()) {\n        System.out.println("Failed to update Disk autodelete field!" + response);\n        return;\n      }\n      System.out.println(\n          "Disk autodelete field updated. Operation Status: " + response.getStatus());\n    }\n  }\n}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n

Node.js

\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n \n \n \n \n \n\n\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n \n \n \n\n\n\n \n\n\n

\n \n

Node.js

\n \n \n \n

\n \n \n Before trying this sample, follow the Node.js setup instructions in the\n Compute Engine quickstart using\n client libraries.\n \n \n \n For more information, see the\n Compute Engine Node.js API\n reference documentation.\n \n

\n To authenticate to Compute Engine, set up Application Default Credentials.\n For more information, see\n \n Set up authentication for a local development environment.\n \n

\n \n\n\n\n\n\n\n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n

\n\n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n \n\n\n

/**\n * TODO(developer): Uncomment and replace these variables before running the sample.\n */\n// const projectId = \'YOUR_PROJECT_ID\';\n// const zone = \'europe-central2-b\';\n// const instanceName = \'YOUR_INSTANCE_NAME\';\n// const diskName = \'YOUR_DISK_NAME\';\n// const autoDelete = true;\n\nconst compute = require(\'@google-cloud/compute\');\n\nasync function setDiskAutodelete() {\n  const instancesClient = new compute.InstancesClient();\n\n  const [instance] = await instancesClient.get({\n    project: projectId,\n    zone,\n    instance: instanceName,\n  });\n\n  if (!instance.disks.some(disk => disk.deviceName === diskName)) {\n    throw new Error(\n      `Instance ${instanceName} doesn\'t have a disk named ${diskName} attached.`\n    );\n  }\n\n  const [response] = await instancesClient.setDiskAutoDelete({\n    project: projectId,\n    zone,\n    instance: instanceName,\n    deviceName: diskName,\n    autoDelete,\n  });\n  let operation = response.latestResponse;\n  const operationsClient = new compute.ZoneOperationsClient();\n\n  // Wait for the update instance operation to complete.\n  while (operation.status !== \'DONE\') {\n    [operation] = await operationsClient.wait({\n      operation: operation.name,\n      project: projectId,\n      zone: operation.zone.split(\'/\').pop(),\n    });\n  }\n\n  console.log(\'Disk autoDelete field updated.\');\n}\n\nsetDiskAutodelete();

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n

Python

\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n \n \n \n \n \n\n\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n \n \n \n\n\n\n \n\n\n

\n \n

Python

\n \n \n \n

\n \n \n Before trying this sample, follow the Python setup instructions in the\n Compute Engine quickstart using\n client libraries.\n \n \n \n For more information, see the\n Compute Engine Python API\n reference documentation.\n \n

\n To authenticate to Compute Engine, set up Application Default Credentials.\n For more information, see\n \n Set up authentication for a local development environment.\n \n

\n \n\n\n\n\n\n\n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n

\n\n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n \n\n\n

from __future__ import annotations\n\nimport sys\nfrom typing import Any\n\nfrom google.api_core.extended_operation import ExtendedOperation\nfrom google.cloud import compute_v1\n\n\ndef wait_for_extended_operation(\n    operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300\n) -> Any:\n    """\n    Waits for the extended (long-running) operation to complete.\n\n    If the operation is successful, it will return its result.\n    If the operation ends with an error, an exception will be raised.\n    If there were any warnings during the execution of the operation\n    they will be printed to sys.stderr.\n\n    Args:\n        operation: a long-running operation you want to wait on.\n        verbose_name: (optional) a more verbose name of the operation,\n            used only during error and warning reporting.\n        timeout: how long (in seconds) to wait for operation to finish.\n            If None, wait indefinitely.\n\n    Returns:\n        Whatever the operation.result() returns.\n\n    Raises:\n        This method will raise the exception received from `operation.exception()`\n        or RuntimeError if there is no exception set, but there is an `error_code`\n        set for the `operation`.\n\n        In case of an operation taking longer than `timeout` seconds to complete,\n        a `concurrent.futures.TimeoutError` will be raised.\n    """\n    result = operation.result(timeout=timeout)\n\n    if operation.error_code:\n        print(\n            f"Error during {verbose_name}: [Code: {operation.error_code}]: {operation.error_message}",\n            file=sys.stderr,\n            flush=True,\n        )\n        print(f"Operation ID: {operation.name}", file=sys.stderr, flush=True)\n        raise operation.exception() or RuntimeError(operation.error_message)\n\n    if operation.warnings:\n        print(f"Warnings during {verbose_name}:\\n", file=sys.stderr, flush=True)\n        for warning in operation.warnings:\n            print(f" - {warning.code}: {warning.message}", file=sys.stderr, flush=True)\n\n    return result\n\n\ndef set_disk_autodelete(\n    project_id: str, zone: str, instance_name: str, disk_name: str, autodelete: bool\n) -> None:\n    """\n    Set the autodelete flag of a disk to given value.\n\n    Args:\n        project_id: project ID or project number of the Cloud project you want to use.\n        zone: name of the zone in which is the disk you want to modify.\n        instance_name: name of the instance the disk is attached to.\n        disk_name: the name of the disk which flag you want to modify.\n        autodelete: the new value of the autodelete flag.\n    """\n    instance_client = compute_v1.InstancesClient()\n    instance = instance_client.get(\n        project=project_id, zone=zone, instance=instance_name\n    )\n\n    for disk in instance.disks:\n        if disk.device_name == disk_name:\n            break\n    else:\n        raise RuntimeError(\n            f"Instance {instance_name} doesn\'t have a disk named {disk_name} attached."\n        )\n\n    disk.auto_delete = autodelete\n\n    operation = instance_client.update(\n        project=project_id,\n        zone=zone,\n        instance=instance_name,\n        instance_resource=instance,\n    )\n\n    wait_for_extended_operation(operation, "disk update")\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n

REST

To set the auto-delete option of a disk, make a POST request to the\ninstances.setDiskAutoDelete method.

\n\n

\nPOST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME/setDiskAutoDelete?autoDelete=false&deviceName=SOURCE_DISK\n

\n\n

Replace the following:

\n\n

PROJECT_ID: the project ID to which the source VM belongs.
ZONE: the zone where the source VM is located.
VM_NAME: the name of the source VM.
SOURCE_DISK: the device name of the disk from which\nyou want to create the image.

After you prepare the VM, create the image.

\n\n

Create the image

\n\n\nYou can create disk images from the following sources:

\n\n

A persistent disk, even while that disk is attached to a VM
A snapshot of a persistent disk
Another image in your project
An image that is shared from another project
A compressed RAW image\nin Cloud Storage

\n\n

You can create a disk image once every 10 minutes. If you want to issue\na burst of requests to create a disk image, you can issue at most 6 requests\nin 60 minutes. For more information, see\nSnapshot frequency limits.

Console

In the Google Cloud console, go to the Create an image page.
\n\n
Go to Create an image
Specify the Name of your image.
Specify the Source from which you want to create an image. This\ncan be a persistent disk, a snapshot, another image, or a disk.raw file\nin Cloud Storage.
If you are creating an image from a disk attached to a running VM,\ncheck Keep instance running to confirm that you want to create the\nimage while the VM is running. You can prepare your VM\nbefore creating the image.
In the Based on source disk location (default) drop-down list,\nspecify the location to store the image. For example, specify us to\nstore the image in the us multi-region, or us-central1 to store it in\nthe us-central1 region. If you don't make a selection,\nCompute Engine stores the image in the multi-region closest to\nyour image's source location.
Optional: specify the properties for your image.
\n\n
- Family: the image family\nthis new image belongs to.
- Description: a description for your custom image.
- Label: a label to group\ntogether resources.
Specify the encryption key. You can choose between a Google-owned and Google-managed encryption key,\na Cloud Key Management Service (Cloud KMS) key or a customer-\nsupplied encryption (CSEK)\nkey. If no encryption key is specified, images are encrypted\nusing a Google-owned and Google-managed encryption key.
Click Create to create the image.

gcloud

In the Google Cloud CLI, use the\ngcloud compute images create command\nto create a custom image.

\n\n

Create an image from a source disk:

\n\n

The --force flag is an optional flag that lets you create the\nimage from a running instance. By default, you cannot create images from running\ninstances. Specify this flag only if you are sure that you want to create\nthe image while the instance is running.

\n\n

\ngcloud compute images create IMAGE_NAME \\\n    --source-disk=SOURCE_DISK \\\n    --source-disk-zone=ZONE \\\n    [--family=IMAGE_FAMILY] \\\n    [--storage-location=LOCATION] \\\n    [--force]\n

\n\n

Replace the following:

\n\n

IMAGE_NAME: a name for the new image
SOURCE_DISK: the disk from which you want to create\n the image
ZONE: the zone where the disk is located
IMAGE_FAMILY: Optional: a flag that specifies which\n image family this image\n belongs to
LOCATION: Optional: a flag that lets you designate\n the region or multi-region where your image is stored. For example,\n specify us to store the image in the us\n multi-region, or us-central1 to store it in the\n us-central1 region. If you don\'t make a selection,\n Compute Engine stores the image in the multi-region closest to\n your image\'s source location.

\n\n

Create an image from a source image:

\n\n

\ngcloud compute images create IMAGE_NAME \\\n  --source-image=SOURCE_IMAGE \\\n  [--source-image-project=IMAGE_PROJECT] \\\n  [--family=IMAGE_FAMILY] \\\n  [--storage-location=LOCATION]\n

\n\n

Replace the following:

\n\n

IMAGE_NAME: a name for the new image.
SOURCE_IMAGE: the image from which you want to\ncreate the new image.
IMAGE_PROJECT: Optional: the project the source\nimage is located in. Use this parameter if you want to copy an image from\nanother project.
IMAGE_FAMILY: Optional: the\nimage family this new image\nbelongs to.
LOCATION: Optional: lets you designate the region\nor multi-region where your image is stored. For example, specify us to\nstore the image in the us multi-region, or us-central1 to store it in\nthe us-central1 region. If you don't make a selection,\nCompute Engine stores the image in the multi-region closest to\nyour image's source location.

\n\n

Create an image from a snapshot:

\n\n\n\n

\ngcloud compute images create IMAGE_NAME \\\n    --source-snapshot=SOURCE_SNAPSHOT \\\n    [--storage-location=LOCATION]\n

\n\n

Replace the following:

\n\n

IMAGE_NAME: a name for the new image
SOURCE_SNAPSHOT: the snapshot from which you want\n to create the image
LOCATION: Optional: a flag that lets you designate\n the region or multi-region where your image is stored. For example,\n specify us to store the image in the us\n multi-region, or us-central1 to store it in the\n us-central1 region. If you don\'t make a selection,\n Compute Engine stores the image in the multi-region closest to\n your image\'s source location.

\n\n

View an image location:

\n\n

Use the\ngcloud compute images describe command\nto view an image location.\n

\ngcloud compute images describe IMAGE_NAME

\n\n

Replace IMAGE_NAME with the name of your image that\nyou want to review.

Go

\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n \n \n \n \n\n\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n \n \n \n\n\n\n \n\n\n

\n \n

Go

\n \n \n \n

\n To authenticate to Compute Engine, set up Application Default Credentials.\n For more information, see\n \n Set up authentication for a local development environment.\n \n

\n \n\n\n\n\n\n\n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n

\n\n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n \n\n\n

import (\n\t"context"\n\t"fmt"\n\t"io"\n\n\tcompute "cloud.google.com/go/compute/apiv1"\n\tcomputepb "cloud.google.com/go/compute/apiv1/computepb"\n)\n\n// Creates a disk image from an existing disk\nfunc createImageFromDisk(\n\tw io.Writer,\n\tprojectID, zone, sourceDiskName, imageName string,\n\tstorageLocations []string,\n\tforceCreate bool,\n) error {\n\t// projectID := "your_project_id"\n\t// zone := "us-central1-a"\n\t// sourceDiskName := "your_disk_name"\n\t// imageName := "my_image"\n\t// // If storageLocations empty, automatically selects the closest one to the source\n\t// storageLocations = []string{}\n\t// // If forceCreate is set to `true`, proceeds even if the disk is attached to\n\t// // a running instance. This may compromise integrity of the image!\n\t// forceCreate = false\n\n\tctx := context.Background()\n\tdisksClient, err := compute.NewDisksRESTClient(ctx)\n\tif err != nil {\n\t\treturn fmt.Errorf("NewDisksRESTClient: %w", err)\n\t}\n\tdefer disksClient.Close()\n\timagesClient, err := compute.NewImagesRESTClient(ctx)\n\tif err != nil {\n\t\treturn fmt.Errorf("NewImagesRESTClient: %w", err)\n\t}\n\tdefer imagesClient.Close()\n\n\t// Get the source disk\n\tsource_req := &computepb.GetDiskRequest{\n\t\tDisk:    sourceDiskName,\n\t\tProject: projectID,\n\t\tZone:    zone,\n\t}\n\n\tdisk, err := disksClient.Get(ctx, source_req)\n\tif err != nil {\n\t\treturn fmt.Errorf("unable to get source disk: %w", err)\n\t}\n\n\t// Create the image\n\treq := computepb.InsertImageRequest{\n\t\tForceCreate: &forceCreate,\n\t\tImageResource: &computepb.Image{\n\t\t\tName:             &imageName,\n\t\t\tSourceDisk:       disk.SelfLink,\n\t\t\tStorageLocations: storageLocations,\n\t\t},\n\t\tProject: projectID,\n\t}\n\n\top, err := imagesClient.Insert(ctx, &req)\n\n\tif err = op.Wait(ctx); err != nil {\n\t\treturn fmt.Errorf("unable to wait for the operation: %w", err)\n\t}\n\n\tfmt.Fprintf(w, "Disk image %s created\\n", imageName)\n\n\treturn nil\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n

Java

\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n \n \n \n \n \n\n\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n \n \n \n\n\n\n \n\n\n

\n \n

Java

\n \n \n \n

\n To authenticate to Compute Engine, set up Application Default Credentials.\n For more information, see\n \n Set up authentication for a local development environment.\n \n

\n \n\n\n\n\n\n\n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n

\n\n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n \n\n\n

\nimport com.google.cloud.compute.v1.Disk;\nimport com.google.cloud.compute.v1.DisksClient;\nimport com.google.cloud.compute.v1.Image;\nimport com.google.cloud.compute.v1.ImagesClient;\nimport com.google.cloud.compute.v1.InsertImageRequest;\nimport com.google.cloud.compute.v1.Instance;\nimport com.google.cloud.compute.v1.InstancesClient;\nimport com.google.cloud.compute.v1.Operation;\nimport java.io.IOException;\nimport java.util.Arrays;\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.concurrent.ExecutionException;\nimport java.util.concurrent.TimeUnit;\nimport java.util.concurrent.TimeoutException;\n\npublic class CreateImage {\n\n  public static void main(String[] args)\n      throws IOException, ExecutionException, InterruptedException, TimeoutException {\n    // TODO(developer): Replace these variables before running the sample.\n\n    // Project ID or project number of the Cloud project you use.\n    String project = "your-project-id";\n    // Zone of the disk you copy from.\n    String zone = "europe-central2-b";\n    // Name of the source disk you copy from.\n    String sourceDiskName = "source-disk-name";\n    // Name of the image you want to create.\n    String imageName = "your-image-name";\n    // Storage location for the image. If the value is undefined,\n    // function will store the image in the multi-region closest to your image\'s source location.\n    String storageLocation = "eu";\n    // Create the image even if the source disk is attached to a running instance.\n    boolean forceCreate = false;\n\n    createImage(project, zone, sourceDiskName, imageName, storageLocation, forceCreate);\n  }\n\n  // Creates a new disk image from the specified source disk.\n  public static void createImage(String project, String zone, String sourceDiskName,\n      String imageName, String storageLocation, boolean forceCreate)\n      throws IOException, ExecutionException, InterruptedException, TimeoutException {\n    // Initialize client that will be used to send requests. This client only needs to be created\n    // once, and can be reused for multiple requests. After completing all of your requests, call\n    // the `client.close()` method on the client to safely\n    // clean up any remaining background resources.\n    try (ImagesClient imagesClient = ImagesClient.create();\n        InstancesClient instancesClient = InstancesClient.create();\n        DisksClient disksClient = DisksClient.create()) {\n\n      Disk disk = disksClient.get(project, zone, sourceDiskName);\n\n      // Getting instances where source disk is attached.\n      for (String fullInstanceName : disk.getUsersList()) {\n        Map<String, String> instanceInfo = parseInstanceName(fullInstanceName);\n        Instance instance = instancesClient.get(instanceInfo.get("instanceProjectId"),\n            instanceInfo.get("instanceZone"), instanceInfo.get("instanceName"));\n\n        // \xd0\xa1heck whether the instances are stopped.\n        if (!Arrays.asList("TERMINATED", "STOPPED").contains(instance.getStatus())\n            && !forceCreate) {\n          throw new IllegalStateException(\n              String.format(\n                  "Instance %s should be stopped. For Windows instances please stop the instance "\n                      + "using GCESysprep command. For Linux instances just shut it down normally."\n                      + " You can suppress this error and create an image of the disk by setting "\n                      + "\'forceCreate\' parameter to true (not recommended). "\n                      + "More information here: "\n                      + "* https://cloud.google.com/compute/docs/instances/windows/creating-windows-os-image#api"\n                      + "* https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#prepare_instance_for_image",\n                  instanceInfo.get("instanceName")));\n        }\n      }\n\n      if (forceCreate) {\n        System.out.println(\n            "Warning: forceCreate option compromise the integrity of your image. "\n                + "Stop the instance before you create the image if possible.");\n      }\n\n      // Create Image.\n      Image image = Image.newBuilder()\n          .setName(imageName)\n          .setSourceDisk(String.format("/zones/%s/disks/%s", zone, sourceDiskName))\n          .addStorageLocations(storageLocation.isEmpty() ? "" : storageLocation)\n          .build();\n\n      InsertImageRequest insertImageRequest = InsertImageRequest.newBuilder()\n          .setProject(project)\n          .setForceCreate(forceCreate)\n          .setImageResource(image)\n          .build();\n\n      Operation response = imagesClient.insertAsync(insertImageRequest).get(5, TimeUnit.MINUTES);\n\n      if (response.hasError()) {\n        System.out.println("Image creation failed ! ! " + response);\n        return;\n      }\n\n      System.out.println("Image created.");\n    }\n  }\n\n\n  public static Map<String, String> parseInstanceName(String name) {\n    String[] parsedName = name.split("/");\n    int splitLength = parsedName.length;\n\n    if (splitLength < 5) {\n      throw new IllegalArgumentException(\n          "Provide correct instance name in the following format: "\n              + "https://www.googleapis.com/compute/v1/projects/PROJECT/zones/ZONE/instances/INSTANCE_NAME");\n    }\n\n    return new HashMap<>() {\n      {\n        put("instanceName", parsedName[splitLength - 1]);\n        put("instanceZone", parsedName[splitLength - 3]);\n        put("instanceProjectId", parsedName[splitLength - 5]);\n      }\n    };\n  }\n\n}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n

Python

\n\n\n\n\n\n\n\n\n \n \n\n\n\n\n\n \n \n \n \n \n\n\n\n\n \n\n\n\n \n\n\n\n\n\n\n\n \n \n \n\n\n\n \n\n\n

\n \n

Python

\n \n \n \n

\n To authenticate to Compute Engine, set up Application Default Credentials.\n For more information, see\n \n Set up authentication for a local development environment.\n \n

\n \n\n\n\n\n\n\n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n

\n\n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n \n\n\n\n\n \n\n\n\n \n\n\n

from __future__ import annotations\n\nimport sys\nfrom typing import Any\nimport warnings\n\nfrom google.api_core.extended_operation import ExtendedOperation\nfrom google.cloud import compute_v1\n\n\ndef wait_for_extended_operation(\n    operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300\n) -> Any:\n    """\n    Waits for the extended (long-running) operation to complete.\n\n    If the operation is successful, it will return its result.\n    If the operation ends with an error, an exception will be raised.\n    If there were any warnings during the execution of the operation\n    they will be printed to sys.stderr.\n\n    Args:\n        operation: a long-running operation you want to wait on.\n        verbose_name: (optional) a more verbose name of the operation,\n            used only during error and warning reporting.\n        timeout: how long (in seconds) to wait for operation to finish.\n            If None, wait indefinitely.\n\n    Returns:\n        Whatever the operation.result() returns.\n\n    Raises:\n        This method will raise the exception received from `operation.exception()`\n        or RuntimeError if there is no exception set, but there is an `error_code`\n        set for the `operation`.\n\n        In case of an operation taking longer than `timeout` seconds to complete,\n        a `concurrent.futures.TimeoutError` will be raised.\n    """\n    result = operation.result(timeout=timeout)\n\n    if operation.error_code:\n        print(\n            f"Error during {verbose_name}: [Code: {operation.error_code}]: {operation.error_message}",\n            file=sys.stderr,\n            flush=True,\n        )\n        print(f"Operation ID: {operation.name}", file=sys.stderr, flush=True)\n        raise operation.exception() or RuntimeError(operation.error_message)\n\n    if operation.warnings:\n        print(f"Warnings during {verbose_name}:\\n", file=sys.stderr, flush=True)\n        for warning in operation.warnings:\n            print(f" - {warning.code}: {warning.message}", file=sys.stderr, flush=True)\n\n    return result\n\n\nSTOPPED_MACHINE_STATUS = (\n    compute_v1.Instance.Status.TERMINATED.name,\n    compute_v1.Instance.Status.STOPPED.name,\n)\n\n\ndef create_image_from_disk(\n    project_id: str,\n    zone: str,\n    source_disk_name: str,\n    image_name: str,\n    storage_location: str | None = None,\n    force_create: bool = False,\n) -> compute_v1.Image:\n    """\n    Creates a new disk image.\n\n    Args:\n        project_id: project ID or project number of the Cloud project you use.\n        zone: zone of the disk you copy from.\n        source_disk_name: name of the source disk you copy from.\n        image_name: name of the image you want to create.\n        storage_location: storage location for the image. If the value is undefined,\n            function will store the image in the multi-region closest to your image\'s\n            source location.\n        force_create: create the image even if the source disk is attached to a\n            running instance.\n\n    Returns:\n        An Image object.\n    """\n    image_client = compute_v1.ImagesClient()\n    disk_client = compute_v1.DisksClient()\n    instance_client = compute_v1.InstancesClient()\n\n    # Get source disk\n    disk = disk_client.get(project=project_id, zone=zone, disk=source_disk_name)\n\n    for disk_user in disk.users:\n        instance_name = disk_user.split("/")[-1]\n        instance = instance_client.get(\n            project=project_id, zone=zone, instance=instance_name\n        )\n        if instance.status in STOPPED_MACHINE_STATUS:\n            continue\n        if not force_create:\n            raise RuntimeError(\n                f"Instance {disk_user} should be stopped. For Windows instances please "\n                f"stop the instance using `GCESysprep` command. For Linux instances just "\n                f"shut it down normally. You can supress this error and create an image of"\n                f"the disk by setting `force_create` parameter to true (not recommended). \\n"\n                f"More information here: \\n"\n                f" * https://cloud.google.com/compute/docs/instances/windows/creating-windows-os-image#api \\n"\n                f" * https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#prepare_instance_for_image"\n            )\n        else:\n            warnings.warn(\n                f"Warning: The `force_create` option may compromise the integrity of your image. "\n                f"Stop the {disk_user} instance before you create the image if possible."\n            )\n\n    # Create image\n    image = compute_v1.Image()\n    image.source_disk = disk.self_link\n    image.name = image_name\n    if storage_location:\n        image.storage_locations = [storage_location]\n\n    operation = image_client.insert(project=project_id, image_resource=image)\n\n    wait_for_extended_operation(operation, "image creation from disk")\n\n    return image_client.get(project=project_id, image=image_name)\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n

REST

Make a POST request to the\nimages().insert method,\na URL in the request body that points to the source object from which\nyou want to create the image. Specify URLs to your resources using your\nown project ID and resource names.

\n\n

Create an image from a persistent disk:

\n\n

\nPOST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/images\n\n{\n  "name": "IMAGE_NAME",\n  "sourceDisk": "/zones/ZONE/disks/SOURCE_DISK",\n  ("storageLocations": "LOCATION",)\n  ("forceCreate": "TRUE")\n}\n

\n\n

Replace the following:

\n\n

PROJECT_ID: the project ID to which the image belongs.
IMAGE_NAME: a name for the new image that you want\nto create.
ZONE: the zone where the source disk is located.
SOURCE_DISK: the disk from which you want to create\nthe image.
LOCATION: Optional: the storage location of your\nimage. For example, specify us to store the image in the us\nmulti-region, or us-central1 to store it in the us-central1 region.\nIf you don't make a selection, Compute Engine stores the\nimage in the multi-region closest to your image's source location.

\n\n

The optional forceCreate parameter lets you create the image from a\nrunning VM. Specify TRUE only if you are sure that you want to\ncreate the image from a running VM. The forceCreate default setting\nis FALSE.

\n\n

Create an image from another image:

\n\n

\nPOST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/images\n\n{\n  "name": "IMAGE_NAME",\n  "sourceImage": "/global/images/SOURCE_IMAGE",\n  ("storageLocations": "LOCATION")\n}\n

\n\n

Replace the following:

\n\n

PROJECT_ID: the project to which the image\nbelongs.
IMAGE_NAME: a name for the new image that you\nwant to create.
SOURCE_IMAGE: the image from which you want to\ncreate the image.
LOCATION: Optional: the storage location of your\nimage. For example, specify us to store the image in the\nus multi-region, or us-central1 to store it in the us-central1\nregion. If you don't make a selection, Compute Engine stores\nthe image in the multi-region closest to your image's source location.

\n\n

Create an image from a snapshot:

\n\n

\nPOST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/images\n{\n  "name": "IMAGE_NAME",\n  "sourceSnapshot": "(/SOURCE_PROJECT_ID)/global/snapshots/SOURCE_SNAPSHOT",\n  ("storageLocations": "LOCATION")\n}\n

\n\n

Replace the following:

\n\n

PROJECT_ID: the project to which the image belongs.
IMAGE_NAME: a name for the new image that you want\nto create.
SOURCE_PROJECT_ID: Optional: the project the\nsnapshot is located in. You must have permission to access the snapshot\nresource in that project.
SOURCE_SNAPSHOT: the snapshot from which you want\nto create the image.
LOCATION: Optional: the storage location of your\nimage. For example, specify us to store the image in the us\nmulti-region, or us-central1 to store it in the us-central1 region.\nIf you don't make a selection, Compute Engine stores the\nimage in the multi-region closest to your image's source location.

For more information about adding images, see the\nimages reference.

\n\n

Share the image

\n\n

After creating a custom image, you can share it across\nprojects. If you allow users from another project to use your custom\nimages, then they can access these images by specifying the image\nproject in\ntheir request.

\n\n

Enable guest operating system features

\n\n

Use guest operating system (OS) features to configure the following networking,\nsecurity, storage, and OS options on custom images. Custom images\nwith these configured features are used as boot disks.

gcloud

Use the gcloud compute images\ncreate command with the\n--guest-os-features flag to create a new custom image from an existing\ncustom image.

\n\n

\ngcloud compute images create IMAGE_NAME \\\n    --source-image=SOURCE_IMAGE \\\n    [--source-image-project=IMAGE_PROJECT] \\\n    --guest-os-features="FEATURES,..." \\\n    [--storage-location=LOCATION]\n

\n\n

Replace the following:

\n\n

IMAGE_NAME: the name for the new image
SOURCE_IMAGE: an image to base the new image on
IMAGE_PROJECT: Optional: the project containing\nthe source image
\n\n
Use this parameter to copy an image from another\nproject.
FEATURES: guest OS tags to enable features for VMs\nthat you create from images
\n\n
To add multiple values, use commas to separate values. Set to one or\nmore of the following values:
\n\n
- \n
  VIRTIO_SCSI_MULTIQUEUE. Use on local SSD devices as an alternative to\n NVMe. For more information about images that support SCSI, see\n Choosing an interface.
  \n\n
  For Linux images, you can enable multi-queue SCSI on local SSD devices on images with kernel\n versions 3.17 or later. For Windows images, you can enable multi-queue SCSI on local SSD\n devices on images with Compute Engine Windows driver\n \n version 1.2.\n
  \n
- \n WINDOWS. Tag Windows Server custom boot images as Windows images.\n
- \n MULTI_IP_SUBNET. Configure interfaces with a netmask other than\n /32. For more information about multiple network interfaces and how they work, see\n \n Multiple network interfaces overview and examples.\n
- \n UEFI_COMPATIBLE. Boot with\n \n UEFI firmware and the following\n \n Shielded VM features:\n
  - \n \n Secure Boot: disabled by default\n
  - \n \n Virtual Trusted Platform Module (vTPM): enabled by default\n
  - \n \n Integrity monitoring: enabled by default\n
  \n
- \n GVNIC. Support higher network bandwidths of up to\n \n 50 Gbps to 100 Gbps speeds. For\n more information, see\n \n Using Google Virtual NIC.\n
- \n IDPF. Support Intel Infrastructure Data Path\n Function (IDPF) network interfaces. \n
- \n SEV_CAPABLE or SEV_SNP_CAPABLE. Use these tags if you want to\n use your image on a\n \n Confidential VM instance with AMD Secure Encrypted Virtualization (SEV) or AMD\n Secure Encrypted Virtualization-Secure Nested Paging (SEV-SNP) support. To check if your kernel\n supports AMD SEV or AMD SEV-SNP, see\n \n Linux kernel details.\n
- \n SEV_LIVE_MIGRATABLE_V2. Use this tag if you want to use your image on a\n \n Confidential VM instance that supports\n \n live migration on AMD SEV. To check if your kernel supports live migration, see\n \n Linux kernel details.\n
- \n TDX_CAPABLE. Use this tag if you want to use your image on a\n \n Confidential VM instance with Intel Trust Domain Extensions (TDX) support. To\n check if your kernel supports Intel TDX, see\n \n Linux kernel details.\n
LOCATION: Optional: region or multi-region in\nwhich to store the image
\n\n
For example, specify us to store the image\nin the us multi-region, or us-central1 to store it in the\nus-central1 region. If you don't make a selection,\nCompute Engine stores the image in the multi-region closest to\nyour image's source location.

REST

Use the images().insert method\nwith the guestOsFeatures flag to create a new custom image from an\nexisting custom image.

\n\n

\n\nPOST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/images\n\n{\n "name": "IMAGE_NAME",\n "sourceImage": "(projects/IMAGE_PROJECT)/global/images/SOURCE_IMAGE",\n ("storageLocations": "LOCATION",)\n "guestOsFeatures": [\n  {\n   "type": "FEATURES"\n  }\n ]\n}\n

\n\n

Replace the following:

\n\n

PROJECT_ID: the ID of the project in which to\ncreate the new image
IMAGE_NAME: a name for the new image
IMAGE_PROJECT: Optional: the project containing\nthe source image
\n\n
Use this parameter to copy an image from another\nproject.
SOURCE_IMAGE: the image to base the new image on
LOCATION: Optional: a region or multi-region in\nwhich to store the image
\n\n
For example, specify us to store the image in\nthe us multi-region, or us-central1 to store it in the us-central1\nregion. If you don't make a selection, Compute Engine stores the\nimage in the multi-region closest to your image's source location.
FEATURES: guest OS tags to enable features for VMs\nthat you create from images
\n\n
To add multiple values, use commas to separate values. Set to one or\nmore of the following values:
\n\n
- \n
  VIRTIO_SCSI_MULTIQUEUE. Use on local SSD devices as an alternative to\n NVMe. For more information about images that support SCSI, see\n Choosing an interface.
  \n\n
  For Linux images, you can enable multi-queue SCSI on local SSD devices on images with kernel\n versions 3.17 or later. For Windows images, you can enable multi-queue SCSI on local SSD\n devices on images with Compute Engine Windows driver\n \n version 1.2.\n
  \n
- \n WINDOWS. Tag Windows Server custom boot images as Windows images.\n
- \n MULTI_IP_SUBNET. Configure interfaces with a netmask other than\n /32. For more information about multiple network interfaces and how they work, see\n \n Multiple network interfaces overview and examples.\n
- \n UEFI_COMPATIBLE. Boot with\n \n UEFI firmware and the following\n \n Shielded VM features:\n
  - \n \n Secure Boot: disabled by default\n
  - \n \n Virtual Trusted Platform Module (vTPM): enabled by default\n
  - \n \n Integrity monitoring: enabled by default\n
  \n
- \n GVNIC. Support higher network bandwidths of up to\n \n 50 Gbps to 100 Gbps speeds. For\n more information, see\n \n Using Google Virtual NIC.\n
- \n IDPF. Support Intel Infrastructure Data Path\n Function (IDPF) network interfaces. \n
- \n SEV_CAPABLE or SEV_SNP_CAPABLE. Use these tags if you want to\n use your image on a\n \n Confidential VM instance with AMD Secure Encrypted Virtualization (SEV) or AMD\n Secure Encrypted Virtualization-Secure Nested Paging (SEV-SNP) support. To check if your kernel\n supports AMD SEV or AMD SEV-SNP, see\n \n Linux kernel details.\n
- \n SEV_LIVE_MIGRATABLE_V2. Use this tag if you want to use your image on a\n \n Confidential VM instance that supports\n \n live migration on AMD SEV. To check if your kernel supports live migration, see\n \n Linux kernel details.\n
- \n TDX_CAPABLE. Use this tag if you want to use your image on a\n \n Confidential VM instance with Intel Trust Domain Extensions (TDX) support. To\n check if your kernel supports Intel TDX, see\n \n Linux kernel details.\n

Avoid sensitive information in UEFI variables

\n\n

Unified Extensible Firmware Interface (UEFI) variables are key-value pair variables\nused by the UEFI firmware during boot time to boot the operating system of a VM.\nUnlike physical machines, where the variables are stored on a hardware chip,\nCompute Engine virtualizes storage of these variables. As such, in\nmany operating systems, all applications and users can reach these variables and\naccess this information.

\n\n

Because of this reason, Google strongly recommends that you don't write or store\nsensitive or personal identifiable information such as passwords or private keys\nto UEFI variables.

\n\n

Considerations for Arm images

\n\n

Google offers the C4A and Tau T2A\nmachine series, which run on Arm CPU platforms. You can start a VM with one of\nthese machine series and then use that source VM to create an Arm image. The\nprocess for creating a custom Arm image is identical to creating an x86 image.

\n\n

To help your users differentiate between Arm and x86 images, Arm images will\nhave an architecture field set to ARM64. Possible values for this\nfield are:

\n\n

ARCHITECTURE_UNSPECIFIED
X86_64
ARM64

\n\n

Image users can then filter on this field to find x86 or Arm-based images.

\n\n

What\'s next

\n\n

Share your private image\nwith other projects.
Learn how to import disks, images, and VM instances.
Learn how to\nexport an image to Cloud Storage.
Learn how to\nstart a VM from a custom image.
Learn how to set the image version in an image family.
Learn how to deprecate a custom image.
Learn how to delete a custom image.

\n\n\n\n \n \n \n\n \n \n \n\n \n

\n\n \n\n \n \n \n \n \n \n \n \n \n\n \n\n \n \n \n \n\n \n

\n \n \n

\n Create custom images\n \n\n \n \n\n \n \n Stay organized with collections\n \n \n \n Save and categorize content based on your preferences.\n \n \n \n

Before you begin

Console

gcloud

Go

Java

Node.js

Python

REST

Create a custom image

Select an image storage location

Prepare your VM for an image

Minimize writing data to the persistent disk

Disable the auto-delete option for the disk

Console

gcloud

Go

Go

Java

Java

Node.js

Node.js

Python

Python

REST

Create the image

Console

gcloud

Go

Go

Java

Java

Python

Python

REST

Share the image

Enable guest operating system features

gcloud

REST

Avoid sensitive information in UEFI variables

Considerations for Arm images

What\'s next

\n Create custom images\n
\n\n \n \n\n \n \n Stay organized with collections\n \n \n \n Save and categorize content based on your preferences.\n \n
\n \n