google.cloud.gcp_compute_image module – Creates a GCP Image

Note

This module is part of the google.cloud collection (version 1.0.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_compute_image.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

Parameters

Parameter

Comments

auth_kind

string / required

The type of credential used.

Choices:

  • application

  • machineaccount

  • serviceaccount

description

string

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

disk_size_gb

integer

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

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

family

string

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

list / elements=dictionary

A list of features to enable on the guest operating system.

Applicable only for bootable images.

type

string / required

The type of supported feature.

Some valid choices include: “MULTI_IP_SUBNET”, “SECURE_BOOT”, “SEV_CAPABLE”, “UEFI_COMPATIBLE”, “VIRTIO_SCSI_MULTIQUEUE”, “WINDOWS”, “GVNIC”

image_encryption_key

dictionary

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

raw_key

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

labels

dictionary

Labels to apply to this Image.

licenses

list / elements=string

Any applicable license URI.

name

string / required

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]*[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.

project

string

The Google Cloud Platform project to use.

raw_disk

dictionary

The parameters of the raw disk image.

container_type

string

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

Some valid choices include: “TAR”

sha1_checksum

string

An optional SHA1 checksum of the disk image before unpackaging.

This is provided by the client when the disk image is created.

source

string / required

The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.

scopes

list / elements=string

Array of scopes to be used

service_account_contents

jsonarg

The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount is selected as type.

source_disk

dictionary

The source disk to create this image based on.

You must provide either this property or the rawDisk.source property but not both to create an image.

This field represents a link to a Disk resource in GCP. It can be specified in two ways. First, you can place a dictionary with key ‘selfLink’ and value of your resource’s selfLink Alternatively, you can add register: name-of-resource to a gcp_compute_disk task and then set this source_disk field to “{{ name-of-resource }}”

source_disk_encryption_key

dictionary

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

raw_key

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

source_disk_id

string

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_image

dictionary

URL of the source image used to create this image. In order to create an image, you must provide the full or partial URL of one of the following: * The selfLink URL * This property * The rawDisk.source URL * The sourceDisk URL .

This field represents a link to a Image resource in GCP. It can be specified in two ways. First, you can place a dictionary with key ‘selfLink’ and value of your resource’s selfLink Alternatively, you can add register: name-of-resource to a gcp_compute_image task and then set this source_image field to “{{ name-of-resource }}”

source_snapshot

dictionary

URL of the source snapshot used to create this image.

In order to create an image, you must provide the full or partial URL of one of the following: * The selfLink URL * This property * The sourceImage URL * The rawDisk.source URL * The sourceDisk URL .

This field represents a link to a Snapshot resource in GCP. It can be specified in two ways. First, you can place a dictionary with key ‘selfLink’ and value of your resource’s selfLink Alternatively, you can add register: name-of-resource to a gcp_compute_snapshot task and then set this source_snapshot field to “{{ name-of-resource }}”

source_type

string

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

Some valid choices include: “RAW”

state

string

Whether the given object should exist in GCP

Choices:

  • present ← (default)

  • absent

Notes

Note

  • API Reference: https://cloud.google.com/compute/docs/reference/v1/images

  • Official Documentation: https://cloud.google.com/compute/docs/images

  • for authentication, you can set service_account_file using the gcp_service_account_file env variable.

  • for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

  • For authentication, you can set scopes using the GCP_SCOPES env variable.

  • Environment variables values will only be used if the playbook values are not set.

  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: create a disk
  google.cloud.gcp_compute_disk:
    name: disk-image
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: disk

- name: create a image
  google.cloud.gcp_compute_image:
    name: test_object
    source_disk: "{{ disk }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

archiveSizeBytes

integer

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

Returned: success

creationTimestamp

string

Creation timestamp in RFC3339 text format.

Returned: success

deprecated

complex

The deprecation status associated with this image.

Returned: success

deleted

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

Returned: success

deprecated

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

Returned: success

obsolete

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

Returned: success

replacement

string

The URL of the suggested replacement for a deprecated resource.

The suggested replacement resource must be the same kind of resource as the deprecated resource.

Returned: success

state

string

The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

Returned: success

description

string

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

Returned: success

diskSizeGb

integer

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

Returned: success

family

string

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.

Returned: success

guestOsFeatures

complex

A list of features to enable on the guest operating system.

Applicable only for bootable images.

Returned: success

type

string

The type of supported feature.

Returned: success

id

integer

The unique identifier for the resource. This identifier is defined by the server.

Returned: success

imageEncryptionKey

complex

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

Returned: success

rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

Returned: success

sha256

string

The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Returned: success

labelFingerprint

string

The fingerprint used for optimistic locking of this resource. Used internally during updates.

Returned: success

labels

dictionary

Labels to apply to this Image.

Returned: success

licenses

list / elements=string

Any applicable license URI.

Returned: success

name

string

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]*[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.

Returned: success

rawDisk

complex

The parameters of the raw disk image.

Returned: success

containerType

string

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

Returned: success

sha1Checksum

string

An optional SHA1 checksum of the disk image before unpackaging.

This is provided by the client when the disk image is created.

Returned: success

source

string

The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.

Returned: success

sourceDisk

dictionary

The source disk to create this image based on.

You must provide either this property or the rawDisk.source property but not both to create an image.

Returned: success

sourceDiskEncryptionKey

complex

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

Returned: success

rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

Returned: success

sha256

string

The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Returned: success

sourceDiskId

string

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.

Returned: success

sourceImage

dictionary

URL of the source image used to create this image. In order to create an image, you must provide the full or partial URL of one of the following: * The selfLink URL * This property * The rawDisk.source URL * The sourceDisk URL .

Returned: success

sourceSnapshot

dictionary

URL of the source snapshot used to create this image.

In order to create an image, you must provide the full or partial URL of one of the following: * The selfLink URL * This property * The sourceImage URL * The rawDisk.source URL * The sourceDisk URL .

Returned: success

sourceType

string

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

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)