Image

Manages a V2 Image resource within OpenStack Glance.

Notes

Properties

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.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var rancheros = new OpenStack.Images.Image("rancheros", new OpenStack.Images.ImageArgs
        {
            ContainerFormat = "bare",
            DiskFormat = "qcow2",
            ImageSourceUrl = "https://releases.rancher.com/os/latest/rancheros-openstack.img",
            Properties = 
            {
                { "key", "value" },
            },
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

rancheros = openstack.images.Image("rancheros",
    container_format="bare",
    disk_format="qcow2",
    image_source_url="https://releases.rancher.com/os/latest/rancheros-openstack.img",
    properties={
        "key": "value",
    })

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const rancheros = new openstack.images.Image("rancheros", {
    containerFormat: "bare",
    diskFormat: "qcow2",
    imageSourceUrl: "https://releases.rancher.com/os/latest/rancheros-openstack.img",
    properties: {
        key: "value",
    },
});

Create a Image Resource

new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);

def 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, web_download=None, __props__=None);

func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)

public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Image Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Image resource accepts the following input properties:

ContainerFormat string: The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.
DiskFormat string: The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.
ImageCachePath string
ImageSourceUrl string: 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 before being uploaded to Glance. Conflicts with local_file_path.
LocalFilePath string: This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
MinDiskGb int: Amount of disk space (in GB) required to boot image. Defaults to 0.
MinRamMb int: Amount of ram (in MB) required to boot image. Defauts to 0.
Name string: The name of the image.
Properties Dictionary<string, object>: A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.
Protected bool: If true, image will not be deletable. Defaults to false.
Region string: 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 List<string>: 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.
VerifyChecksum bool: If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
Visibility string: 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.
WebDownload bool: If true, the “web-download” import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

ContainerFormat string: The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.
DiskFormat string: The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.
ImageCachePath string
ImageSourceUrl string: 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 before being uploaded to Glance. Conflicts with local_file_path.
LocalFilePath string: This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
MinDiskGb int: Amount of disk space (in GB) required to boot image. Defaults to 0.
MinRamMb int: Amount of ram (in MB) required to boot image. Defauts to 0.
Name string: The name of the image.
Properties map[string]interface{}: A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.
Protected bool: If true, image will not be deletable. Defaults to false.
Region string: 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 []string: 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.
VerifyChecksum bool: If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
Visibility string: 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.
WebDownload bool: If true, the “web-download” import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

containerFormat string: The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.
diskFormat string: The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.
imageCachePath string
imageSourceUrl string: 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 before being uploaded to Glance. Conflicts with local_file_path.
localFilePath string: This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
minDiskGb number: Amount of disk space (in GB) required to boot image. Defaults to 0.
minRamMb number: Amount of ram (in MB) required to boot image. Defauts to 0.
name string: The name of the image.
properties {[key: string]: any}: A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.
protected boolean: If true, image will not be deletable. Defaults to false.
region string: 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 string[]: 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.
verifyChecksum boolean: If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
visibility string: 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.
webDownload boolean: If true, the “web-download” import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

container_format str: The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.
disk_format str: The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.
image_cache_path str
image_source_url str: 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 before being uploaded to Glance. Conflicts with local_file_path.
local_file_path str: This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
min_disk_gb float: Amount of disk space (in GB) required to boot image. Defaults to 0.
min_ram_mb float: Amount of ram (in MB) required to boot image. Defauts to 0.
name str: The name of the image.
properties Dict[str, Any]: A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.
protected bool: If true, image will not be deletable. Defaults to false.
region 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 List[str]: 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 bool: If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
visibility 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.
web_download bool: If true, the “web-download” import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the Image resource produces the following output properties:

Checksum string

The checksum of the data associated with the image.

CreatedAt string

The date the image was created.

File string

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

Id string

The provider-assigned unique ID for this managed resource.

Metadata Dictionary<string, object>

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.

Owner string

The id of the openstack user who owns the image.

Schema string

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

SizeBytes int

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

Status string

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

UpdateAt string

(Deprecated - use updated_at instead)

Deprecated: Use updated_at instead

UpdatedAt string

The date the image was last updated.

Checksum string

The checksum of the data associated with the image.

CreatedAt string

The date the image was created.

File string

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

Id string

The provider-assigned unique ID for this managed resource.

Metadata map[string]interface{}

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.

Owner string

The id of the openstack user who owns the image.

Schema string

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

SizeBytes int

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

Status string

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

UpdateAt string

(Deprecated - use updated_at instead)

Deprecated: Use updated_at instead

UpdatedAt string

The date the image was last updated.

checksum string

The checksum of the data associated with the image.

createdAt string

The date the image was created.

file string

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

id string

The provider-assigned unique ID for this managed resource.

metadata {[key: string]: any}

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.

owner string

The id of the openstack user who owns the image.

schema string

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

sizeBytes number

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

status string

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

updateAt string

(Deprecated - use updated_at instead)

Deprecated: Use updated_at instead

updatedAt string

The date the image was last updated.

checksum str

The checksum of the data associated with the image.

created_at str

The date the image was created.

file str

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

id str

The provider-assigned unique ID for this managed resource.

metadata Dict[str, Any]

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.

owner str

The id of the openstack user who owns the image.

schema str

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

size_bytes float

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

status str

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

update_at str

(Deprecated - use updated_at instead)

Deprecated: Use updated_at instead

updated_at str

The date the image was last updated.

Look up an Existing Image Resource

Get an existing Image resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ImageState, opts?: CustomResourceOptions): Image

static get(resource_name, id, opts=None, checksum=None, container_format=None, created_at=None, disk_format=None, file=None, image_cache_path=None, image_source_url=None, local_file_path=None, metadata=None, min_disk_gb=None, min_ram_mb=None, name=None, owner=None, properties=None, protected=None, region=None, schema=None, size_bytes=None, status=None, tags=None, update_at=None, updated_at=None, verify_checksum=None, visibility=None, web_download=None, __props__=None);

func GetImage(ctx *Context, name string, id IDInput, state *ImageState, opts ...ResourceOption) (*Image, error)

public static Image Get(string name, Input<string> id, ImageState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Checksum string

The checksum of the data associated with the image.

ContainerFormat string

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

CreatedAt string

The date the image was created.

DiskFormat string

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

File string

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

ImageCachePath string

ImageSourceUrl string

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 before being uploaded to Glance. Conflicts with local_file_path.

LocalFilePath string

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

Metadata Dictionary<string, object>

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.

MinDiskGb int

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

MinRamMb int

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

Name string

The name of the image.

Owner string

The id of the openstack user who owns the image.

Properties Dictionary<string, object>

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

Protected bool

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

Region string

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 string

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

SizeBytes int

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

Status string

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

Tags List<string>

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.

UpdateAt string

(Deprecated - use updated_at instead)

Deprecated: Use updated_at instead

UpdatedAt string

The date the image was last updated.

VerifyChecksum bool

If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.

Visibility string

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.

WebDownload bool

If true, the “web-download” import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

Checksum string

The checksum of the data associated with the image.

ContainerFormat string

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

CreatedAt string

The date the image was created.

DiskFormat string

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

File string

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

ImageCachePath string

ImageSourceUrl string

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 before being uploaded to Glance. Conflicts with local_file_path.

LocalFilePath string

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

Metadata map[string]interface{}

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.

MinDiskGb int

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

MinRamMb int

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

Name string

The name of the image.

Owner string

The id of the openstack user who owns the image.

Properties map[string]interface{}

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

Protected bool

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

Region string

Schema string

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

SizeBytes int

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

Status string

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

Tags []string

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.

UpdateAt string

(Deprecated - use updated_at instead)

Deprecated: Use updated_at instead

UpdatedAt string

The date the image was last updated.

VerifyChecksum bool

If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.

Visibility string

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.

WebDownload bool

If true, the “web-download” import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

checksum string

The checksum of the data associated with the image.

containerFormat string

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

createdAt string

The date the image was created.

diskFormat string

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

file string

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

imageCachePath string

imageSourceUrl string

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 before being uploaded to Glance. Conflicts with local_file_path.

localFilePath string

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

metadata {[key: string]: any}

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.

minDiskGb number

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

minRamMb number

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

name string

The name of the image.

owner string

The id of the openstack user who owns the image.

properties {[key: string]: any}

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

protected boolean

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

region string

schema string

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

sizeBytes number

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

status string

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

tags string[]

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.

updateAt string

(Deprecated - use updated_at instead)

Deprecated: Use updated_at instead

updatedAt string

The date the image was last updated.

verifyChecksum boolean

If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.

visibility string

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.

webDownload boolean

If true, the “web-download” import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

checksum str

The checksum of the data associated with the image.

container_format str

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

created_at str

The date the image was created.

disk_format str

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

file str

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

image_cache_path str

image_source_url str

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 before being uploaded to Glance. Conflicts with local_file_path.

local_file_path str

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

metadata Dict[str, Any]

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 float

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

min_ram_mb float

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

name str

The name of the image.

owner str

The id of the openstack user who owns the image.

properties Dict[str, Any]

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

protected bool

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

region str

schema str

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

size_bytes float

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

status str

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

tags List[str]

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 str

(Deprecated - use updated_at instead)

Deprecated: Use updated_at instead

updated_at str

The date the image was last updated.

verify_checksum bool

If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.

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

web_download bool

If true, the “web-download” import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Image

Notes

Properties

Example Usage

Create a Image Resource

Image Resource Properties

Inputs

Outputs

Look up an Existing Image Resource

Package Details

On This Page