Skip to main content
openstack_images_image_v2
Last update:

openstack_images_image_v2

For your information

These instructions are a copy of the official OpenStack Terraform provider documentation in the Terraform Registry.

Manages a V2 Image resource within OpenStack Glance.

carefully

All arguments including the source image URL password will be stored in the raw state as plain-text. Read more about sensitive data in state.

Example Usage⁠

resource "openstack_images_image_v2" "rancheros" {
  name             = "RancherOS"
  image_source_url = "https://releases.rancher.com/os/latest/rancheros-openstack.img"
  container_format = "bare"
  disk_format      = "qcow2"

  properties = {
    key = "value"
  }
}

Argument Reference⁠

The following arguments are supported:

  • container_format — (Required) The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".

  • disk_format — (Required) The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".

  • local_file_path — (Optional) This is the filepath of the raw image filethat will be uploaded to Glance. Conflicts with image_source_url and web_download.

  • image_cache_path — (Optional) This is the directory where the images willbe downloaded. Images will be stored with a filename corresponding tothe url's md5 hash. Defaults to "$HOME/.terraform/image_cache"

  • image_source_url — (Optional) This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path beforebeing uploaded to Glance.Conflicts with local_file_path.

  • image_source_username — (Optional) The username of basic auth to download image_source_url.

  • image_source_password — (Optional) The password of basic auth to download image_source_url.

  • min_disk_gb — (Optional) Amount of disk space (in GB) required to boot image.Defaults to 0.

  • min_ram_mb — (Optional) Amount of ram (in MB) required to boot image.Defauts to 0.

  • name — (Required) The name of the image.

  • image_id — (Optional) Unique ID (valid UUID) of image to create. Changingthis creates a new image.

  • properties — (Optional) A map of key/value pairs to set freeforminformation about an image. See the "Notes" section for furtherinformation about properties.

  • protected — (Optional) If true, image will not be deletable.Defaults to false.

  • hidden — (Optional) If true, image will be hidden from public list.Defaults to false.

  • region — (Optional) The region in which to obtain the V2 Glance client.A Glance client is needed to create an Image that can be used witha compute instance. If omitted, the region argument of the provideris used. Changing this creates a new Image.

  • tags — (Optional) 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 — (Optional) If false, the checksum will not be verifiedonce the image is finished uploading. Conflicts with web_download.Defaults to true when not using web_download.

  • visibility — (Optional) The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set thevisibility depends upon the configuration of the OpenStack cloud.

  • web_download — (Optional) If true, the "web-download" import method willbe used to let Openstack download the image directly from the remote source.Conflicts with local_file_path. Defaults to false.

  • decompress — (Optional) If true, this provider will decompress downloadedimage before uploading it to OpenStack. Decompression algorithm is chosen bychecking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz.Defaults to false. Changing this creates a new Image.

Attributes Reference⁠

The following attributes are exported:

  • checksum — The checksum of the data associated with the image.
  • container_format — See Argument Reference above.
  • created_at — The date the image was created.
  • disk_format — See Argument Reference above.
  • file — the trailing path after the glanceendpoint that represents the location of the imageor the path to retrieve it.
  • id — A unique ID assigned by Glance.
  • metadata — The metadata associated with the image.Image metadata allow for meaningfully define the image propertiesand tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
  • min_disk_gb — See Argument Reference above.
  • min_ram_mb — See Argument Reference above.
  • name — See Argument Reference above.
  • owner — The id of the openstack user who owns the image.
  • properties — See Argument Reference above.
  • protected — See Argument Reference above.
  • hidden — See Argument Reference above.
  • region — See Argument Reference above.
  • schema — The path to the JSON-schema that representsthe image or image
  • size_bytes — The size in bytes of the data associated with the image.
  • status — The status of the image. It can be "queued", "active" or "saving".
  • tags — See Argument Reference above.
  • updated_at — The date the image was last updated.
  • update_at — ( Deprecated — use updated_at instead)
  • visibility — See Argument Reference above.

Notes⁠

Properties⁠

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

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

In addition, the direct_url and stores properties are also automatically reconciled if theImage Service sets it.

Import⁠

Images can be imported using the id, e.g.

$ terraform import openstack_images_image_v2.rancheros 89c60255-9bd6-460c-822a-e2b959ede9d2