Resource Type: gcompute_image

Defined in:
lib/puppet/type/gcompute_image.rb
Providers:
google

Overview

Represents an Image resource. Google Compute Engine uses operating system images to create the root persistent disks for your instances. You specify an image when you create an instance. Images contain a boot loader, an operating system, and a root file system. Linux operating system images are also capable of running containers on Compute Engine. Images can be either public or custom. 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. Custom images are available only to your project. You can create a custom image from root persistent disks and other images. Then, use the custom image to create an instance.

Properties

  • archive_size_bytes

    Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). (output only)

  • creation_timestamp

    Creation timestamp in RFC3339 text format. (output only)

  • deprecated

    The deprecation status associated with this image. (output only)

  • description

    An optional description of this resource. Provide this property when you create the resource.

  • disk_size_gb

    Size of the image when restored onto a persistent disk (in GB).

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • family

    The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

  • guest_os_features

    A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.

  • id

    The unique identifier for the resource. This identifier is defined by the server. (output only)

  • image_encryption_key

    Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image)

  • licenses

    Any applicable license URI.

  • name (namevar)

    Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

  • raw_disk

    The parameters of the raw disk image.

  • source_disk

    A reference to Disk resource

  • source_disk_encryption_key

    The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

  • source_disk_id

    The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

  • source_type

    The type of the image used to create this disk. The default and only value is RAW

    Supported values:
    • RAW

Parameters

  • credential

    A gauth_credential name to be used to authenticate with Google Cloud Platform.

  • name

    The name of the Image.

  • project

    A Google Cloud Platform project to manage.

  • provider

    The specific backend to use for this ‘gcompute_image` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.