Creating and starting a VM instance

This document explains how to create a virtual machine (VM) instance using a boot disk image, a boot disk snapshot, or a container image. When creating a VM instance from a boot disk image, you can use either a regular image or a Shielded VM image. Shielded VM images offer security features like UEFI-compliant firmware, Secure Boot, and vTPM-protected Measured Boot. Compute Engine automatically starts the VM instance after you create it.

You can create multiple disks for your VM instance during the creation process. You can also add more disks to the instance after it is created.

This document explains basic ways to create an instance. For more specific or complicated instance configurations, see the following resources:

If you are bringing an existing license, see Bringing your own license with sole-tenant nodes.

Before you begin

Creating an instance from an image

This section explains how to create an instance from an image of a specific operating system. A boot disk image contains the bootloader, boot filesystem, and an operating system that runs on the instance.

For advanced users, you can create a custom image to use in place of the public images offered by Compute Engine.

You can create an instance with an image in the Google Cloud Console, the gcloud command-line tool, or the API.

Creating an instance from a public image

Public images are provided and maintained by Google, open-source communities, and third-party vendors. By default, all projects have access to these images and can use them to create instances with common operating system images.

To create an instance, specify the image family for the operating system that you need. Compute Engine offers multiple Linux distributions, some of which are available as both regular and Shielded VM images. If you choose local SSD storage for your instance, you can't use the integrity monitoring features of Shielded VM, and you can't use the vTPM for shielding data. For a list of the available image families, see public images.

Console

  1. Go to the VM instances page.

    Go to the VM instances page

  2. Select your project and click Continue.
  3. Click the Create instance button.
  4. Specify a Name for your instance.

  5. Optionally, change the Zone for this instance.

    Note: The list of zones is randomized within each region to encourage use across multiple zones.

  6. Select a Machine configuration for your instance.

  7. In the Boot disk section, click Change to configure your boot disk.
    Create a boot disk no larger than 2 TB to account for the limitations of MBR partitions.

  8. In the Public images tab, choose an operating system and version.
    Select Show images with Shielded VM features to see only Shielded VM images.

  9. Click Save to confirm your boot disk options.

  10. To permit HTTP or HTTPS traffic to the VM instance, select Allow HTTP traffic or Allow HTTPS traffic.

    The Cloud Console adds a network tag to your instance 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 instance. For more information, see Firewall rules overview in the Virtual Private Cloud documentation.

  11. To add secondary non-boot disks to your VM instance:

    1. Click the Management, security, disks, networking, sole tenancy section.
    2. Click the Disks tab.
    3. Under Additional disks click Add new disk.
    4. Specify a disk Name, Type, Source type, Mode, and Deletion rule.
    5. Click Done.
    6. Add additional disks as needed.

  12. Optionally, change the instance's Shielded VM settings, if you chose an image that supports Shielded VM:

    1. Click the Security tab in the Management, security, disks, networking, sole tenancy section.
    2. If you want to disable Secure Boot, uncheck Turn on Secure Boot. Secure Boot helps protect your VM instances against boot-level and kernel-level malware and rootkits. For more information, see Secure boot.

    3. If you want to disable the virtual trusted platform module (vTPM), uncheck Turn on vTPM. The vTPM enables Measured Boot, which validates the VM pre-boot and boot integrity. For more information, see Virtual Trusted Platform Module (vTPM).

    4. If you want to disable integrity monitoring, clear the Turn on Integrity Monitoring checkbox. Integrity monitoring lets you monitor the boot integrity of your Shielded VM instances using Stackdriver Monitoring. For more information, see Integrity monitoring.

  13. Click the Create button to create and start the instance.

gcloud

Before you create an instance, select an operating system image to use for the boot disk of your instance. For a list of non-Shielded VM public images with their image IDs, image families, and image projects, run the gcloud compute images list command without any flags:

gcloud compute images list

For a list of Shielded VM public images, run the gcloud compute images list command with the following flags:

gcloud compute images list --project gce-uefi-images --no-standard-images

After you select an image, create an instance using the gcloud compute instances create command.

To use the latest version of an operating system image, specify the --image-family and --image-project flags. For example, debian-9 is an image family that returns the most recent version of the Debian 9 image that is not deprecated, and debian-cloud is the image project.

Create an instance with the latest image from an image family:

gcloud compute instances create [INSTANCE_NAME] \
--image-family [IMAGE_FAMILY] \
--image-project [IMAGE_PROJECT]

where:

Example response:

Created [https://compute.googleapis.com/compute/v1/projects/myproject/zones/[ZONE]/instances/[INSTANCE_NAME]].
NAME            ZONE   MACHINE_TYPE  INTERNAL_IP   EXTERNAL_IP    STATUS
[INSTANCE_NAME] [ZONE] n1-standard-1 10.105.155.92 173.255.114.53 RUNNING

If you need to use a specific image version instead of the latest version, specify the --image and --image-project flags. For example, to create an instance that uses the debian-9-stretch-v20170619 Debian image, specify --image debian-9-stretch-v20170619 and --image-project debian-cloud.

Create an instance with a specific version of an image:

gcloud compute instances create [INSTANCE_NAME] \
    --image [IMAGE_ID] \
    --image-project [IMAGE_PROJECT]

where:

  • [INSTANCE_NAME] is the name for the new instance.
  • [IMAGE_ID] is a specific image.
  • [IMAGE_PROJECT] is the image project to which that image belongs.

You can add up to 128 secondary non-boot disks while you are creating your instance. Specify the --create-disk flag for each secondary disk you create. To create secondary disks from a public or stock image, specify the image and image-project properties in the --create-disk flag. To create a blank disk, do not include these properties. Optionally, include properties for the disk size and type.

gcloud compute instances create [INSTANCE_NAME] \
  --image-family [IMAGE_FAMILY] \
  --image-project [IMAGE_PROJECT] \
  --create-disk image=[DISK_IMAGE],image-project=[DISK_IMAGE_PROJECT],size=[SIZE_GB],type=[DISK_TYPE]

where:

  • [INSTANCE_NAME] is the name for the new instance.
  • [IMAGE_FAMILY] is one of the available image families.
  • [IMAGE_PROJECT] is the image project to which the image belongs.
  • [DISK_IMAGE] is the source image for the secondary disk. For a list of available images, run gcloud compute images list. For blanks disks, do not specify a disk image or image project.
  • [DISK_IMAGE_PROJECT] is the image project to which the disk image belongs. For blank disks, do not specify a disk image or image project.
  • [SIZE_GB] is the size of the secondary disk.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd.

Format and mount the disks before using them.

If you chose an image that supports Shielded VM, you can optionally change the instance's Shielded VM settings using one of the following flags:

  • --no-shielded-secure-boot: Disable Secure Boot. Secure Boot helps protect your VM instances against boot-level and kernel-level malware and rootkits. For more information, see Secure Boot.

  • --no-shielded-vtpm: Disable the virtual trusted platform module (vTPM). The vTPM enables Measured Boot, which validates the VM pre-boot and boot integrity. For more information, see Virtual Trusted Platform Module (vTPM).

  • --no-shielded-integrity-monitoring: Disable integrity monitoring. Integrity monitoring lets you monitor the boot integrity of your Shielded VM instances using Stackdriver Monitoring. For more information, see Integrity monitoring.

The following example creates an Ubuntu Shielded VM instance with Secure Boot disabled:

gcloud beta compute instances create my-instance \
  --image-family ubuntu-1804-lts --image-project gce-uefi-images \
  --no-shielded-secure-boot

API

To start an instance in the API, send a request and specify the following properties:

  • Source image
  • Network interface
  • Machine type
  • If your VPC network is a custom mode VPC network, you must also specify the subnet where you want the instance to be created.

  • If you chose an image that supports Shielded VM, you can optionally change the instance's Shielded VM settings by using the following Boolean request body items:

    • enableSecureBoot: Enable or disable Secure Boot. Secure Boot helps protect your VM instances against boot-level and kernel-level malware and rootkits. For more information, see Secure Boot.

    • enableVtpm: Enable or disable the virtual trusted platform module (vTPM). The vTPM enables Measured Boot, which validates the VM pre-boot and boot integrity. For more information, see Virtual Trusted Platform Module (vTPM).

    • enableIntegrityMonitoring: Enable or disable integrity monitoring. Integrity monitoring lets you monitor and verify the runtime boot integrity of your Shielded VM instances using Stackdriver Monitoring reports. For more information, see Integrity monitoring.

After you decide on your resource properties, create a request body and make your API request. To learn more about constructing API requests and handling API responses, see Creating API requests and handling responses.

Making the API request

If you use the API client library, you can start a new instance by directly calling the REST API or using the instances().insert method. Here is an example of each option:

REST

In the API, construct a POST request to the instances URI with the same request body. You can add up to 128 secondary non-boot disks at the time you create a VM instance by using the initializeParams property for each additional disk. Create additional disks with a public or a private image. To add blank disks, do not specify an image source. Optionally, you can include the diskSizeGb, diskType, and labels properties.

def addInstance(http, listOfHeaders):
  url = "https://compute.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances"

  body = {
    "name": "[INSTANCE_NAME]",
    "machineType": "machineTypes/[MACHINE_TYPE]",
    "networkInterfaces": [{
      "accessConfigs": [{
        "type": "ONE_TO_ONE_NAT",
        "name": "External NAT"
       }],
      "network": "global/networks/default"
    }],
    "disks": [{
       "autoDelete": "true",
       "boot": "true",
       "type": "PERSISTENT",
       "initializeParams": {
         "sourceImage": "projects/[IMAGE_PROJECT]/global/images/family/[IMAGE]",
         "labels": {
           "key": "[LABEL_KEY]",
           "value": "[LABEL_VALUE]",
         }
       }
     },
     {
       "initializeParams": {
          "diskSizeGb": "[SIZE_GB]",
          "sourceImage":"[IMAGE]"
       },
       {
       "initializeParams": {
          "diskSizeGb": "[SIZE_GB]"
       }
     }]

  bodyContentURLEncoded = urllib.urlencode(bodyContent)
  resp, content = http.request(uri=url, method="POST", body=dumps(bodyContent), headers=listOfHeaders)

  print resp
  print content

where:

  • [INSTANCE_NAME] is the name of the instance.
  • [PROJECT_ID] is your project ID.
  • [ZONE] is the zone for this instance.
  • [MACHINE_TYPE] is the machine type of the instance.
  • [IMAGE_PROJECT] is the image project that the image belongs to, such as debian-cloud, ubuntu-os-cloud, and so on.
  • [IMAGE] is one of the available public image families. For example, family/debian-9 uses the latest version of the Debian 9 image. Alternatively, you can use a specific image version such as debian-9-stretch-v20170619 without the family/ path. For blank disks do not specify an image source.
  • [LABEL_KEY] and [LABEL_VALUE] are labels to apply to the disk. The labels field is optional.
  • [SIZE_GB] is the disk size.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd.

If you create an instance with blank secondary disks, format and mount those disks so that your guest operating system can use them.

Cloud Client Libraries for Python

compute/api/create_instance.py 
def create_instance(compute, project, zone, name, bucket):
    # Get the latest Debian Jessie image.
    image_response = compute.images().getFromFamily(
        project='debian-cloud', family='debian-9').execute()
    source_disk_image = image_response['selfLink']

    # Configure the machine
    machine_type = "zones/%s/machineTypes/n1-standard-1" % zone
    startup_script = open(
        os.path.join(
            os.path.dirname(__file__), 'startup-script.sh'), 'r').read()
    image_url = "http://storage.googleapis.com/gce-demo-input/photo.jpg"
    image_caption = "Ready for dessert?"

    config = {
        'name': name,
        'machineType': machine_type,

        # Specify the boot disk and the image to use as a source.
        'disks': [
            {
                'boot': True,
                'autoDelete': True,
                'initializeParams': {
                    'sourceImage': source_disk_image,
                }
            }
        ],

        # Specify a network interface with NAT to access the public
        # internet.
        'networkInterfaces': [{
            'network': 'global/networks/default',
            'accessConfigs': [
                {'type': 'ONE_TO_ONE_NAT', 'name': 'External NAT'}
            ]
        }],

        # Allow the instance to access cloud storage and logging.
        'serviceAccounts': [{
            'email': 'default',
            'scopes': [
                'https://www.googleapis.com/auth/devstorage.read_write',
                'https://www.googleapis.com/auth/logging.write'
            ]
        }],

        # Metadata is readable from the instance and allows you to
        # pass configuration from deployment scripts to instances.
        'metadata': {
            'items': [{
                # Startup script is automatically executed by the
                # instance upon startup.
                'key': 'startup-script',
                'value': startup_script
            }, {
                'key': 'url',
                'value': image_url
            }, {
                'key': 'text',
                'value': image_caption
            }, {
                'key': 'bucket',
                'value': bucket
            }]
        }
    }

    return compute.instances().insert(
        project=project,
        zone=zone,
        body=config).execute()

Creating an instance from a custom image

A custom image belongs only to your project. To create an instance with a custom image, you must first have a custom image. To learn how to create a custom image, read Creating a custom image.

Console

  1. Go to the VM instances page.

    Go to the VM Instances page

  2. Select your project and click Continue.
  3. Click the Create instance button.
  4. Specify a Name for your instance.

  5. Optionally, change the Zone for this instance.

    Note: The list of zones is randomized within each region to encourage use across multiple zones.

  6. Select a Machine configuration for your instance.

  7. In the Boot disk section, click Change to configure your boot disk.
    Create a boot disk no larger than 2 TB to account for the limitations of MBR partitions.

  8. Select the Custom Images tab.

  9. Make sure your project is selected in the drop-down list.

  10. Choose the image you want and click the Select button.

  11. To permit HTTP or HTTPS traffic to the VM instance, select Allow HTTP traffic or Allow HTTPS traffic.

    The Cloud Console adds a network tag to your instance 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 instance. For more information, see Firewall rules overview in the Virtual Private Cloud documentation.

  12. To add secondary non-boot disks to your VM instance:

    1. Click Management, security, disks, networking, sole tenancy.
    2. Select the Disks tab.
    3. Under Additional disks, click Add new disk.
    4. Specify a disk Name, Type, Source type, Mode, and Deletion rule.
    5. Click Done.
    6. Add additional disks as needed.

  13. Click the Create button to create and start the instance.

gcloud

Run the gcloud compute instances create command to create an instance with a custom image:

gcloud compute instances create [INSTANCE_NAME] \
--image [IMAGE_NAME] \
--image-family [IMAGE_FAMILY]

where:

  • [INSTANCE_NAME] is the instance name.
  • [IMAGE_NAME] is the name of the image.
  • [IMAGE] is an optional field. Use a private or public image. If no image is specified, the disk is blank.

If you created your custom images as part of an image family, specify that image family instead of the image name. By doing so, the instance automatically uses the most recent, non-deprecated image in the image family.

You can add up to 128 secondary non-boot disks while you're creating your instance. Specify the --create-disk flag for each secondary disk you create. To create secondary disks from a public or stock image, specify the image and image-project properties in the --create-disk flag. To create a blank disk, don't include these properties. Optionally, include properties for the disk size and type.

gcloud compute instances create [INSTANCE_NAME] \
  --image-family [IMAGE_FAMILY] \
  --image-project [IMAGE_PROJECT] \
  --create-disk image=[DISK_IMAGE],image-project=[DISK_IMAGE_PROJECT],size=[SIZE_GB],type=[DISK_TYPE]

where:

  • [INSTANCE_NAME] is the name for the new instance.
  • [IMAGE_FAMILY] is one of the available image families.
  • [IMAGE_PROJECT] is the image project to which the image belongs.
  • [DISK_IMAGE] is the source image for the secondary disk. For a list of available images, run gcloud compute images list. For blanks disks, do not specify a disk image or image project.
  • [DISK_IMAGE_PROJECT] is the image project to which the disk image belongs. For blank disks, do not specify a disk image or image project.
  • [SIZE_GB] is the size of the secondary disk.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd.

Format and mount the disks before using them.

API

The process for creating an instance with a custom image in the API is the same as if you were creating an instance with a publicly available image. In the sourceImage URI, provide your own project ID and the image name.

You can create up to 128 secondary non-boot disks at the time you create a VM instance 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.

...
"initializeParams" :{
   "sourceImage": "global/images/[IMAGE_NAME]"
},
{
"initializeParams": {
   "diskSizeGb": "[SIZE_GB]",
   "sourceImage": "[IMAGE]",
   "diskType": "[DISK_TYPE]"
 },
 {
 "initializeParams": {
 "diskSizeGb": "[SIZE_GB]",
 "diskType": "[DISK_TYPE]"
 }
}...]

where:

  • [PROJECT_ID] is your project ID.
  • [IMAGE_NAME] is the specific image such as debian-9-stretch-v20170619. Alternatively, you can specify an image family. For example, family/debian-9 returns the latest version of the Debian 9 image.
  • [IMAGE] is the source image for the secondary disk. For blank disks do not specify an image source.
  • [SIZE_GB] is the disk size.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd.

Format and mount the disks before using them.

Creating an instance with an image shared with you

If another user has shared an image with you, you can use the image to create a new instance.

Console

  1. Go to the VM instances page.

    Go to the VM instances page

  2. Select your project and click Continue.
  3. Click the Create instance button.
  4. Specify a Name for your instance.

  5. Optionally, change the Zone for this instance.

  6. Select a Machine configuration for your instance.

  7. In the Boot disk section, click Change to configure your boot disk.

    Create a boot disk no larger than 2 TB to account for the limitations of MBR partitions.

  8. Select the Custom Images tab.

  9. Select the image project from the drop-down list.

  10. Choose the image you want and click the Select button.

  11. To permit HTTP or HTTPS traffic to the VM instance, select Allow HTTP traffic or Allow HTTPS traffic.

    The Cloud Console adds a network tag to your instance 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 instance. For more information, see Firewall rules overview in the Virtual Private Cloud documentation.

  12. To add secondary non-boot disks to your VM instance:

    1. Click Management, security, disks, networking, sole tenancy.
    2. Select the Disks tab.
    3. Under Additional disks, click Add new disk.
    4. Specify a disk Name, Type, Source type, Mode, and Deletion rule.
    5. Click Done.
    6. Add additional disks as needed.

  13. Click the Create button to create and start the instance.

gcloud

Create an instance by using the gcloud compute instances create command, and use the --image and --image-project flag to specify the image name and the project where the image resides:

gcloud compute instances create [INSTANCE_NAME] \
    --image [IMAGE] \
    --image-project [IMAGE_PROJECT]

where:

  • [INSTANCE_NAME] is the name for the new instance.
  • [IMAGE] is the name of the image.
  • [IMAGE_PROJECT] is the project to which the image belongs.

If the command is successful, gcloud responds with the properties of the new instance:

Created [https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-b/instances/example-instance].
NAME                 ZONE           MACHINE_TYPE   PREEMPTIBLE  INTERNAL_IP  EXTERNAL_IP    STATUS
example-instance     us-central1-b  n1-standard-1               10.240.0.4   104.198.53.60  RUNNING

You can add up to 128 secondary non-boot disks while you are creating your instance. Specify the --create-disk flag for each secondary disk you create. To create secondary disks from a public or stock image, specify the image and image-project properties in the --create-disk flag. To create a blank disk, do not include these properties. Optionally, include properties for the disk size and type.

gcloud compute instances create [INSTANCE_NAME] \
--image-family [IMAGE_FAMILY] \
--image-project [IMAGE_PROJECT] \
--create-disk image=[DISK_IMAGE],image-project=[DISK_IMAGE_PROJECT],size=[SIZE_GB],type=[DISK_TYPE]

where:

  • [INSTANCE_NAME] is the name for the new instance.
  • [IMAGE_FAMILY] is one of the available image families.
  • [IMAGE_PROJECT] is the image project to which the image belongs.
  • [DISK_IMAGE] is the source image for the secondary disk. For a list of available images, run gcloud compute images list. For blanks disks, do not specify a disk image or image project.
  • [DISK_IMAGE_PROJECT] is the image project to which the disk image belongs. For blanks disks, do not specify a disk image or image project.
  • [SIZE_GB] is the size of the secondary disk.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd.

Format and mount the disks before using them.

API

Follow the API instructions to create an instance from a public image but specify the image field in the request body. You can add up to 128 secondary non-boot disks by specifying the initializeParams field for every additional disk. To add blank disks, do not specify an image source. Optionally, you can specify the diskSizeGb, diskType, and labels properties.

...
image: "projects/[PROJECT_ID]/global/images/[IMAGE]

{
 "initializeParams": {
    "diskSizeGb": "[SIZE_GB]",
    "sourceImage": "[IMAGE]"
       }
   {
  "initializeParams": {
  "diskSizeGb": "[SIZE_GB]"
   }
 }...]

where:

  • [PROJECT_ID] is the project containing the image.
  • [IMAGE] is the source image.
  • [SIZE_GB] is the disk size.
  • [IMAGE] is the source image for the secondary disk. For blank disks do not specify an image source.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd.

Format and mount the disks before using them.

Creating a VM instance from a snapshot

If you backed up a boot persistent disk with a snapshot, you can use that snapshot to create an instance.

Keep in mind that if you plan to create many instances from the same boot disk snapshot, consider creating a custom image and creating instances from that image instead. Custom images can create the boot disks for your instances more quickly and efficiently than snapshots.

Creating a new VM instance boot disk from a snapshot

You can restore a snapshot of a boot disk to a new boot disk when you create a new instance.

Console

  1. Go to the VM instances page.

    Go to the VM instances page

  2. Select your project and click Continue.
  3. Click the Create instance button.
  4. Specify a Name for your instance.

  5. Optionally, change the Zone for this instance.

  6. Select a Machine configuration for your instance.

  7. In the Boot disk section, click Change to configure your boot disk.

    Create a boot disk no larger than 2 TB to account for the limitations of MBR partitions.

  8. Click the Snapshots tab and choose a snapshot from the list.

  9. Click Select.

  10. To permit HTTP or HTTPS traffic to the VM instance, select Allow HTTP traffic or Allow HTTPS traffic.

    The Cloud Console adds a network tag to your instance 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 instance. For more information, see Firewall rules overview in the Virtual Private Cloud documentation.

  11. To add secondary non-boot disks to your VM instance:

    1. Click Management, security, disks, networking, sole tenancy.
    2. Select the Disks tab.
    3. Under Additional disks, click Add new disk.
    4. Specify a disk Name, Type, Source type, Mode, and Deletion rule.
    5. Click Done.
    6. Add additional disks as needed.

  12. Click the Create button to create and start the instance.

gcloud

Use the gcloud compute instances create command and include the --source-snapshot flag:

gcloud compute instances create [INSTANCE_NAME] \
    --source-snapshot [BOOT_SNAPSHOT_NAME] \
    --boot-disk-size [BOOT_DISK_SIZE] \
    --boot-disk-type [BOOT_DISK_TYPE] \
    --boot-disk-device-name [BOOT_DISK_NAME]

where:

  • [INSTANCE_NAME] is the name for the new instance.
  • [BOOT_SNAPSHOT_NAME] is the name of the boot disk snapshot that you want to restore to the boot disk of the new instance.
  • [BOOT_DISK_NAME] is the name of the new boot disk for this instance.
  • [BOOT_DISK_SIZE] is the size, in gigabytes, of the new boot disk. The size must be equal to or larger than the size of the source disk from which the snapshot was made. This property is optional.
  • [BOOT_DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd. This flag is optional.

Optionally, if you also want to a restore non-boot snapshot, append the --create-disk flag and specify a source-snapshot. Repeat the --create-disk flag to create a non-boot disk for each snapshot that you want to restore. When creating an instance, you can add up to 15 non-boot disks.

--create-disk source-snapshot=[SNAPSHOT_NAME],name=[DISK_NAME],size=[DISK_SIZE],type=[DISK_TYPE]

where:

  • [SNAPSHOT_NAME] is the name of a non-boot snapshot that you want to restore.
  • [DISK_NAME] is the name of a new non-boot disk for this instance.
  • [DISK_SIZE] is the size, in gigabytes, of the new disk. The size must be equal to or larger than the size of the source disk from which the snapshot was made. This property is optional.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd. This flag is optional.

API

When you use the API to create an instance from a snapshot, the following restrictions apply:

  • Only one persistent disk can be used as the boot persistent disk.
  • You must attach the boot persistent disk as the first disk for that instance.

  • If you specify the source property, you cannot also specify the initializeParams property. Providing a source indicates that the boot persistent disk exists already, but the initializeParams property indicates that Compute Engine should create a new boot persistent disk.

    To create an instance from a boot disk snapshot, specify the sourceSnapshot field under the disks property. Optionally, specify the diskSizeGb and diskType properties for the new boot disk:

POST https://compute.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances
{
  "name": "[INSTANCE_NAME]",
  "machineType": "machineTypes/[MACHINE_TYPE]"
  "networkInterfaces": [{
    "accessConfigs": [{
      "type": "ONE_TO_ONE_NAT",
      "name": "External NAT"
    }],
    "network": "global/networks/default"
  }],
  "disks": [{
     "boot": true,
     "initializeParams": {
       "sourceSnapshot": "global/snapshots/[BOOT_SNAPSHOT_NAME]",
       "diskSizeGb": "[BOOT_DISK_SIZE]",
       "diskType": "[BOOT_DISK_TYPE]"
    }
   }],
 }

where:

  • [PROJECT_ID] is your project ID.
  • [ZONE] is the zone where you want to create the new instance.
  • [INSTANCE_NAME] is the name of the instance that you want to restore a snapshot to.
  • [MACHINE_TYPE] is the machine type of the instance.
  • [BOOT_SNAPSHOT_NAME] is the name of the snapshot that you want to use to create the boot disk of a new instance.
  • [BOOT_DISK_SIZE] is the size, in gigabytes, for the new boot disk. The size must be equal to or larger than the size of the source disk from which the snapshot was made. This property is optional.
  • [BOOT_DISK_TYPE] is the type of the boot disk, either pd-standard or pd-ssd. This property is optional.

Restore non-boot snapshots to a new instance

Non-boot snapshots are backups of secondary persistent disks that your instance uses only for data storage. You can restore non-boot snapshots to new disks whenever you create a new instance. Alternatively, you can also restore non-boot snapshots to an existing instance.

To restore non-boot snapshots to a new instance, follow these additional steps when you create an instance.

Console

When restoring non-boot snapshots to a new instance from the console, first create a disk from each snapshot. Then, attach the new disks when you create the new instance.

  1. Restore each non-boot snapshot to a new disk.

    1. Go to the Disks page.

      Go to the Disks page

    2. Click Create disk.
    3. Specify a Name for your disk.

    4. Select the Region and Zone for this disk.

      Note: You can only attach a disk to an instance if both are located in the same zone.

    5. Select a disk Type.

    6. Under Source type, select Snapshot.

    7. Under the new Source snapshot field, select a non-boot snapshot that you want to restore to the new disk.

    8. Click Create to create the disk.

    9. Repeat these steps to create a disk from each snapshot that you want to restore. When creating an instance, you can add up to 15 secondary non-boot disks.

  2. Go to the VM instances page.

    Go to the VM instances page

  3. Click Create instance.

  4. Specify a Name for your instance.

  5. Select the Region and Zone for this instance.

    Note: You can only attach a disk to an instance if both are located in the same zone.

  6. Select a Machine type for your instance.

  7. If you want to allow incoming external traffic, change the Firewall rules for the instance.

  8. To attach disks to the instance:

    1. Click Management, security, disks, networking, sole tenancy.
    2. Select the Disks tab.
    3. Under Additional disks, click Attach existing disk.
    4. Under the new Disk field, select a disk to attach to this instance.
    5. Specify a Mode and Deletion rule for the disk.
    6. Click Done.
    7. Repeat these steps for each disk that you want to attach. When creating an instance, you can add up to 15 secondary non-boot disks.

  9. Click Create to create and start the instance.

  10. Format and mount the attached disks before using them.

gcloud

Create a new instance using the gcloud compute instances create command. For each non-boot snapshot that you want to restore, include the --create-disk flag, and specify a source-snapshot. When creating an instance, you can add up to 15 secondary non-boot disks.

For example, to restore two non-boot snapshots to a new instance, use the following command:

gcloud compute instances create \
    --create-disk source-snapshot=[SNAPSHOT_1_NAME],name=[DISK_1_NAME],size=[DISK_1_SIZE],type=[DISK_1_TYPE] \
    --create-disk source-snapshot=[SNAPSHOT_2_NAME],name=[DISK_2_NAME],size=[DISK_2_SIZE],type=[DISK_2_TYPE]

where:

  • [SNAPSHOT_1_NAME] and [SNAPSHOT_2_NAME] are the names of non-boot snapshots that you want to restore.
  • [DISK_1_NAME] and [DISK_2_NAME] are the names of the new non-boot disks for this instance.
  • [DISK_1_SIZE] and [DISK_2_SIZE] are the sizes, in gigabytes, of each new non-boot disk. The size must be equal to or larger than the size of the source disk from which the snapshot was made. This property is optional.
  • [DISK_1_TYPE] and [DISK_2_TYPE] are the types of persistent disks, either pd-standard or pd-ssd. This flag is optional.

API

When using the API to restore a non-boot snapshot to a new instance, the following restrictions apply:

  • Only one persistent disk can be the boot persistent disk.
  • You must attach the boot persistent disk as the first disk for that instance.
  • If you specify the source property, you can't also specify the initializeParams property. Providing a source indicates that the boot persistent disk exists already, but the initializeParams property indicates that Compute Engine should create a new boot persistent disk.

Using the beta API, specify the sourceSnapshot field under the initializeParams property. You can add up to 15 secondary non-boot disks by repeating the initializeParams property for every non-boot disk that you want to create. Optionally, you can specify the diskSizeGb and diskType properties for any of the disks that you create.

For example, to restore two non-boot snapshots to a new instance, make the following request:

POST https://compute.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances
{
  "name": "[INSTANCE_NAME]",
  "machineType": "machineTypes/[MACHINE_TYPE]"
  "networkInterfaces": [{
    "accessConfigs": [{
      "type": "ONE_TO_ONE_NAT",
      "name": "External NAT"
    }],
    "network": "global/networks/default"
  }],
  "disks": [{
     "autoDelete": "true",
     "boot": "true",
     "type": "PERSISTENT",
     "diskSizeGb": "[DISK_SIZE]",
     "diskType": "[DISK_TYPE]"
   },
   {
     "initializeParams": {
        "sourceSnapshot": "global/snapshots/[SNAPSHOT_1_NAME]",
        "diskSizeGb": "[DISK_SIZE]",
        "diskType": "[DISK_TYPE]"
     }
   },
   {
     "initializeParams": {
        "sourceSnapshot": "global/snapshots/[SNAPSHOT_2_NAME]",
        "diskSizeGb": "[DISK_SIZE]",
        "diskType": "[DISK_TYPE]"
     }
  }]
 }

where:

  • [PROJECT_ID] is your project ID.
  • [ZONE] is the zone where you want to create the new instance.
  • [INSTANCE_NAME] is the name of the instance that you want to restore a snapshot to.
  • [MACHINE_TYPE] is the machine type of the instance.
  • [SNAPSHOT_1_NAME] and [SNAPSHOT_2_NAME] are the names of the non-boot snapshots that you want to restore to new, non-boot disks on the new instance.
  • [DISK_SIZE] is the size, in gigabytes, of the corresponding disk. This property is optional, but must be equal to or larger than the size of the source disk from which the snapshot was made.
  • [DISK_TYPE] is the type of the corresponding persistent disk, either pd-standard or pd-ssd. This property is optional.

Creating an instance from a container image

To deploy and launch a container on a Compute Engine instance, specify a container image name and optional configuration parameters when you create the instance. Compute Engine creates the instance 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. See Deploying containers on VMs for more information.

Console

  1. Go to the VM instances page.

    Go to the VM instances page

  2. Click Create instance.
  3. Specify a Name for your instance.
  4. In the Container section, select the Deploy a container image to this VM instance checkbox.
  5. Specify the Container image to use.
    • For example, you can specify gcr.io/cloud-marketplace/google/nginx1:1.12 to select an NGINX 1.12 container image from Cloud Launcher.
    • If you use a container image from Docker Hub, always specify the full Docker image name. For example, specify the following image name to deploy an Apache container image: docker.io/httpd:2.4.
  6. Optionally, click Advanced container options. For more information, see Configuring options to run your container.
  7. Click Create to create the instance, boot the instance, and launch the container.

gcloud

Run the gcloud compute instances create-with-container command:

gcloud compute instances create-with-container [INSTANCE_NAME] \
     --container-image [CONTAINER_IMAGE]

where:

  • [INSTANCE_NAME] is the name for the new instance.
  • [CONTAINER_IMAGE] is the name of the container image.

For example, the following command creates a VM instance named nginx-vm, which launches and runs the container image, gcr.io/cloud-marketplace/google/nginx1:1.12.

gcloud compute instances create-with-container nginx-vm \
    --container-image gcr.io/cloud-marketplace/google/nginx1:1.12

When using a container image from Docker Hub, you must always specify a full Docker image name. For example, specify the following image name to deploy an Apache container image: docker.io/httpd:2.4.

Creating an instance with access to other Google Cloud Services

If you plan to run an app on your VM instance that needs access to other Google Cloud services, create a service account before creating the instance, and then follow the instructions to set up an instance 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.

For more information about service accounts, read the Service accounts overview.

Creating an instance in a specific subnet

By default, Google Cloud creates an auto mode VPC network called default for each project. If you create an instance without specifying its network details, Compute Engine uses the default VPC network and the auto subnet that is in the same region as the instance.

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 instance.

Console

  1. Go to the VM instances page.

    Go to the VM Instances page

  2. Select your project and click Continue.
  3. Click the Create instance button.
  4. Specify a Name for your instance.

  5. Optionally, change the Zone for this instance.

  6. To permit HTTP or HTTPS traffic to the VM instance, select Allow HTTP traffic or Allow HTTPS traffic.

    The Cloud Console adds a network tag to your instance 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 instance. For more information, see Firewall rules overview in the Virtual Private Cloud documentation.

  7. Expand the Management, security, disks, networking, sole tenancy section.

  8. Under Network interfaces in the Networking tab, specify the network details.

    1. In the Network field, select the VPC network that contains the subnet you created.
    2. In the Subnet field, select the subnet that the instance will use.

  9. To add secondary non-boot disks to your VM instance:

    1. Click Management, security, disks, networking, sole tenancy.
    2. Select the Disks tab.
    3. Under Additional disks, click Add new disk.
    4. Specify a disk Name, Type, Source type, Mode, and Deletion rule.
    5. Click Done.
    6. Add additional disks as needed.

  10. Click the Create button to create and start the instance.

gcloud

Using the gcloud command-line tool, follow the same instructions to create an instance from an image or a snapshot, and add the --subnet [SUBNET_NAME] and --zone [ZONE_NAME] flags when you run the gcloud compute instances create command:

gcloud compute instances create [INSTANCE_NAME] --subnet [SUBNET_NAME] \
--zone [ZONE_NAME]

where:

  • [INSTANCE_NAME] is the name of the instance.
  • [SUBNET_NAME] is the name of the subnet. The network is inferred from the specified subnet.
  • [ZONE_NAME] is the name of the zone where the instance is created, such as europe-west1-b. The instance's region is inferred from the zone.

You can add up to 128 secondary non-boot disks while you are creating your instance. Specify the --create-disk flag for each secondary disk you create. To create secondary disks from a public or stock image, specify the image and image-project properties in the --create-disk flag. To create a blank disk, do not include these properties. Optionally, include properties for the disk size and type.

gcloud compute instances create [INSTANCE_NAME] \
--subnet [SUBNET_NAME] \
--zone [ZONE_NAME] \
--image-family [IMAGE_FAMILY] \
--image-project [IMAGE_PROJECT] \
--create-disk image=[DISK_IMAGE],image-project=[DISK_IMAGE_PROJECT],size=[SIZE_GB],type=[DISK_TYPE]

where:

  • [INSTANCE_NAME] is the name for the new instance.
  • [SUBNET_NAME] is the name of the subnet.
  • [ZONE_NAME] is the name of the zone where the instance is created, such as europe-west1-b.
  • [IMAGE_FAMILY] is one of the available image families.
  • [IMAGE_PROJECT] is the image project to which the image belongs.
  • [DISK_IMAGE] is the source image for the secondary disk. For a list of available images, run gcloud compute images list. For blank disks, do not specify a disk image or image project.
  • [DISK_IMAGE_PROJECT] is the image project to which the disk image belongs. For blank disks, do not specify a disk image or image project.
  • [SIZE_GB] is the size of the secondary disk.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd.

Format and mount the disks before using them.

API

Follow the API instructions to create an instance from an image or a snapshot, but specify the subnet field in the request body. To add up to 128 secondary non-boot disks, use the initializeParams property for every disk you create. To add blank disks, do not add a source image. Optionally, you can specify the diskSizeGb, diskType, and labels properties.

...
"networkInterfaces": [
{
  "network": "global/networks/[NETWORK_NAME]",
  "subnetwork": "regions/[REGION]/subnetworks/[SUBNET_NAME]",
  "accessConfigs":
    {
      "name": "External NAT",
      "type": "ONE_TO_ONE_NAT"
    }
    {
      "initializeParams": {
         "diskSizeGb": "[SIZE_GB]",
         "sourceImage": "[IMAGE]"
    {
      "initializeParams": {
      "diskSizeGb": "[SIZE_GB]"
     }
 }...]

where:

  • [IMAGE] is the source image for the secondary disk. For blank disks don't specify an image source.
  • [SIZE_GB] is the disk size.
  • [DISK_TYPE] is the type of persistent disk, either pd-standard or pd-ssd.

Format and mount the disks before using them.

What's next?