images

class pulumi_openstack.images.GetImageResult(checksum=None, container_format=None, created_at=None, disk_format=None, file=None, member_status=None, metadata=None, min_disk_gb=None, min_ram_mb=None, most_recent=None, name=None, owner=None, properties=None, protected=None, region=None, schema=None, size_bytes=None, size_max=None, size_min=None, sort_direction=None, sort_key=None, tag=None, tags=None, updated_at=None, visibility=None, id=None)

A collection of values returned by getImage.

checksum = None

The checksum of the data associated with the image.

created_at = None

The date the image was created.

  • container_format: The format of the image’s container.
  • disk_format: The format of the image’s disk.
file = None

the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.

metadata = None

The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.

min_disk_gb = None

The minimum amount of disk space required to use the image.

min_ram_mb = None

The minimum amount of ram required to use the image.

properties = None

Freeform information about the image.

protected = None

Whether or not the image is protected.

schema = None

The path to the JSON-schema that represent the image or image

size_bytes = None

The size of the image (in bytes).

tags = None

The tags list of the image.

updated_at = None

The date the image was last updated.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.images.Image(resource_name, opts=None, container_format=None, disk_format=None, image_cache_path=None, image_source_url=None, local_file_path=None, min_disk_gb=None, min_ram_mb=None, name=None, properties=None, protected=None, region=None, tags=None, verify_checksum=None, visibility=None, __name__=None, __opts__=None)

Manages a V2 Image resource within OpenStack Glance.

This resource supports the ability to add properties to a resource during creation as well as add, update, and delete properties during an update of this resource.

Newer versions of OpenStack are adding some read-only properties to each image. These properties start with the prefix os_. If these properties are detected, this resource will automatically reconcile these with the user-provided properties.

In addition, the direct_url property is also automatically reconciled if the Image Service set it.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • container_format (pulumi.Input[str]) – The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.
  • disk_format (pulumi.Input[str]) – The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.
  • image_cache_path (pulumi.Input[str]) – This is the directory where the images will be downloaded. Images will be stored with a filename corresponding to the url’s md5 hash. Defaults to “$HOME/.terraform/image_cache”
  • image_source_url (pulumi.Input[str]) – This is the url of the raw image that will be downloaded in the image_cache_path before being uploaded to Glance. Glance is able to download image from internet but the gophercloud library does not yet provide a way to do so. Conflicts with local_file_path.
  • local_file_path (pulumi.Input[str]) – This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url.
  • min_disk_gb (pulumi.Input[float]) – Amount of disk space (in GB) required to boot image. Defaults to 0.
  • min_ram_mb (pulumi.Input[float]) – Amount of ram (in MB) required to boot image. Defauts to 0.
  • name (pulumi.Input[str]) – The name of the image.
  • properties (pulumi.Input[dict]) – A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.
  • protected (pulumi.Input[bool]) – If true, image will not be deletable. Defaults to false.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
  • tags (pulumi.Input[list]) – The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
  • verify_checksum (pulumi.Input[bool]) – If false, the checksum will not be verified once the image is finished uploading. Defaults to true.
  • visibility (pulumi.Input[str]) – The visibility of the image. Must be one of “public”, “private”, “community”, or “shared”. The ability to set the visibility depends upon the configuration of the OpenStack cloud.
checksum = None

The checksum of the data associated with the image.

container_format = None

The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.

created_at = None

The date the image was created.

disk_format = None

The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.

file = None

the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.

image_cache_path = None

This is the directory where the images will be downloaded. Images will be stored with a filename corresponding to the url’s md5 hash. Defaults to “$HOME/.terraform/image_cache”

image_source_url = None

This is the url of the raw image that will be downloaded in the image_cache_path before being uploaded to Glance. Glance is able to download image from internet but the gophercloud library does not yet provide a way to do so. Conflicts with local_file_path.

local_file_path = None

This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url.

metadata = None

The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.

min_disk_gb = None

Amount of disk space (in GB) required to boot image. Defaults to 0.

min_ram_mb = None

Amount of ram (in MB) required to boot image. Defauts to 0.

name = None

The name of the image.

owner = None

The id of the openstack user who owns the image.

properties = None

A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.

protected = None

If true, image will not be deletable. Defaults to false.

region = None

The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.

schema = None

The path to the JSON-schema that represent the image or image

size_bytes = None

The size in bytes of the data associated with the image.

status = None

The status of the image. It can be “queued”, “active” or “saving”.

tags = None

The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.

update_at = None

(Deprecated - use updated_at instead)

updated_at = None

The date the image was last updated.

verify_checksum = None

If false, the checksum will not be verified once the image is finished uploading. Defaults to true.

visibility = None

The visibility of the image. Must be one of “public”, “private”, “community”, or “shared”. The ability to set the visibility depends upon the configuration of the OpenStack cloud.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_openstack.images.get_image(member_status=None, most_recent=None, name=None, owner=None, properties=None, region=None, size_max=None, size_min=None, sort_direction=None, sort_key=None, tag=None, visibility=None, opts=None)

Use this data source to get the ID of an available OpenStack image.