gcp_compute_image - Creates a GCP Image¶

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

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		Choices/Defaults	Comments
auth_kind required		Choices: machineaccount serviceaccount application	The type of credential used.
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).
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.
	type	Choices: VIRTIO_SCSI_MULTIQUEUE	The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property 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.
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) .
	raw_key		Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
	sha256		The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
licenses			Any applicable license URI.
name 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			The Google Cloud Platform project to use.
raw_disk			The parameters of the raw disk image.
	source		The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.
	container_type	Choices: TAR	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.
	sha1_checksum		An optional SHA1 checksum of the disk image before unpackaging. This is provided by the client when the disk image is created.
scopes required			Array of scopes to be used.
service_account_email			An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file			The path of a Service Account JSON file if serviceaccount is selected as type.
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.
	raw_key		Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
	sha256		The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
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		Choices: RAW	The type of the image used to create this disk. The default and only value is RAW .
state required		Choices: present ← absent	Whether the given object should exist in GCP

Notes ¶

Note

For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE 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
  gcp_compute_disk:
      name: 'disk-image'
      zone: us-central1-a
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      scopes:
        - https://www.googleapis.com/auth/compute
      state: present
  register: disk
- name: create a image
  gcp_compute_image:
      name: testObject
      source_disk: "{{ disk }}"
      project: testProject
      auth_kind: service_account
      service_account_file: /tmp/auth.pem
      scopes:
        - https://www.googleapis.com/auth/compute
      state: present

Return Values ¶

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

Key		Returned	Description
archive_size_bytes int		success	Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
creation_timestamp str		success	Creation timestamp in RFC3339 text format.
deprecated complex		success	The deprecation status associated with this image.
	deleted str	success	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.
	deprecated str	success	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.
	state str	success	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.
	obsolete str	success	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.
	replacement str	success	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.
description str		success	An optional description of this resource. Provide this property when you create the resource.
disk_size_gb int		success	Size of the image when restored onto a persistent disk (in GB).
family str		success	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 complex		success	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.
	type str	success	The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property 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 int		success	The unique identifier for the resource. This identifier is defined by the server.
image_encryption_key complex		success	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 str	success	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
	sha256 str	success	The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
licenses list		success	Any applicable license URI.
name str		success	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.
raw_disk complex		success	The parameters of the raw disk image.
	source str	success	The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.
	container_type str	success	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.
	sha1_checksum str	success	An optional SHA1 checksum of the disk image before unpackaging. This is provided by the client when the disk image is created.
source_disk dict		success	A reference to Disk resource.
source_disk_encryption_key complex		success	The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
	raw_key str	success	Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
	sha256 str	success	The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
source_disk_id str		success	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 str		success	The type of the image used to create this disk. The default and only value is RAW .

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.