Documentation ¶
Index ¶
- type GetImageArgs
- type GetImageResult
- type Image
- func (r *Image) Checksum() *pulumi.StringOutput
- func (r *Image) ContainerFormat() *pulumi.StringOutput
- func (r *Image) CreatedAt() *pulumi.StringOutput
- func (r *Image) DiskFormat() *pulumi.StringOutput
- func (r *Image) File() *pulumi.StringOutput
- func (r *Image) ID() *pulumi.IDOutput
- func (r *Image) ImageCachePath() *pulumi.StringOutput
- func (r *Image) ImageSourceUrl() *pulumi.StringOutput
- func (r *Image) LocalFilePath() *pulumi.StringOutput
- func (r *Image) Metadata() *pulumi.MapOutput
- func (r *Image) MinDiskGb() *pulumi.IntOutput
- func (r *Image) MinRamMb() *pulumi.IntOutput
- func (r *Image) Name() *pulumi.StringOutput
- func (r *Image) Owner() *pulumi.StringOutput
- func (r *Image) Properties() *pulumi.MapOutput
- func (r *Image) Protected() *pulumi.BoolOutput
- func (r *Image) Region() *pulumi.StringOutput
- func (r *Image) Schema() *pulumi.StringOutput
- func (r *Image) SizeBytes() *pulumi.IntOutput
- func (r *Image) Status() *pulumi.StringOutput
- func (r *Image) Tags() *pulumi.ArrayOutput
- func (r *Image) URN() *pulumi.URNOutput
- func (r *Image) UpdateAt() *pulumi.StringOutput
- func (r *Image) UpdatedAt() *pulumi.StringOutput
- func (r *Image) VerifyChecksum() *pulumi.BoolOutput
- func (r *Image) Visibility() *pulumi.StringOutput
- type ImageArgs
- type ImageState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetImageArgs ¶
type GetImageArgs struct { // The status of the image. Must be one of // "accepted", "pending", "rejected", or "all". MemberStatus interface{} // If more than one result is returned, use the most // recent image. MostRecent interface{} // The name of the image. Name interface{} // The owner (UUID) of the image. Owner interface{} // a map of key/value pairs to match an image with. // All specified properties must be matched. Properties interface{} // 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. Region interface{} // The maximum size (in bytes) of the image to return. SizeMax interface{} // The minimum size (in bytes) of the image to return. SizeMin interface{} // Order the results in either `asc` or `desc`. SortDirection interface{} // Sort images based on a certain key. Defaults to `name`. SortKey interface{} // Search for images with a specific tag. Tag interface{} // The visibility of the image. Must be one of // "public", "private", "community", or "shared". Defaults to "private". Visibility interface{} }
A collection of arguments for invoking getImage.
type GetImageResult ¶
type GetImageResult struct { // The checksum of the data associated with the image. Checksum interface{} ContainerFormat interface{} // The date the image was created. // * `container_format`: The format of the image's container. // * `disk_format`: The format of the image's disk. CreatedAt interface{} DiskFormat interface{} // the trailing path after the glance endpoint that represent the // location of the image or the path to retrieve it. File 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. Metadata interface{} // The minimum amount of disk space required to use the image. MinDiskGb interface{} // The minimum amount of ram required to use the image. MinRamMb interface{} // Whether or not the image is protected. Protected interface{} Region interface{} // The path to the JSON-schema that represent // the image or image Schema interface{} // The size of the image (in bytes). SizeBytes interface{} // The tags list of the image. Tags interface{} // The date the image was last updated. UpdatedAt interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getImage.
func LookupImage ¶
func LookupImage(ctx *pulumi.Context, args *GetImageArgs) (*GetImageResult, error)
Use this data source to get the ID of an available OpenStack image.
type Image ¶
type Image struct {
// contains filtered or unexported fields
}
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.
func GetImage ¶
func GetImage(ctx *pulumi.Context, name string, id pulumi.ID, state *ImageState, opts ...pulumi.ResourceOpt) (*Image, error)
GetImage gets an existing Image resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewImage ¶
func NewImage(ctx *pulumi.Context, name string, args *ImageArgs, opts ...pulumi.ResourceOpt) (*Image, error)
NewImage registers a new resource with the given unique name, arguments, and options.
func (*Image) Checksum ¶
func (r *Image) Checksum() *pulumi.StringOutput
The checksum of the data associated with the image.
func (*Image) ContainerFormat ¶
func (r *Image) ContainerFormat() *pulumi.StringOutput
The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
func (*Image) CreatedAt ¶
func (r *Image) CreatedAt() *pulumi.StringOutput
The date the image was created.
func (*Image) DiskFormat ¶
func (r *Image) DiskFormat() *pulumi.StringOutput
The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
func (*Image) File ¶
func (r *Image) File() *pulumi.StringOutput
the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
func (*Image) ImageCachePath ¶
func (r *Image) ImageCachePath() *pulumi.StringOutput
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"
func (*Image) ImageSourceUrl ¶
func (r *Image) ImageSourceUrl() *pulumi.StringOutput
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`.
func (*Image) LocalFilePath ¶
func (r *Image) LocalFilePath() *pulumi.StringOutput
This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with `image_source_url`.
func (*Image) Metadata ¶
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.
func (*Image) Owner ¶
func (r *Image) Owner() *pulumi.StringOutput
The id of the openstack user who owns the image.
func (*Image) Properties ¶
A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
func (*Image) Protected ¶
func (r *Image) Protected() *pulumi.BoolOutput
If true, image will not be deletable. Defaults to false.
func (*Image) Region ¶
func (r *Image) Region() *pulumi.StringOutput
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.
func (*Image) Schema ¶
func (r *Image) Schema() *pulumi.StringOutput
The path to the JSON-schema that represent the image or image
func (*Image) Status ¶
func (r *Image) Status() *pulumi.StringOutput
The status of the image. It can be "queued", "active" or "saving".
func (*Image) Tags ¶
func (r *Image) Tags() *pulumi.ArrayOutput
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.
func (*Image) UpdateAt ¶
func (r *Image) UpdateAt() *pulumi.StringOutput
(**Deprecated** - use `updated_at` instead)
func (*Image) UpdatedAt ¶ added in v0.16.5
func (r *Image) UpdatedAt() *pulumi.StringOutput
The date the image was last updated.
func (*Image) VerifyChecksum ¶
func (r *Image) VerifyChecksum() *pulumi.BoolOutput
If false, the checksum will not be verified once the image is finished uploading. Defaults to true.
func (*Image) Visibility ¶
func (r *Image) Visibility() *pulumi.StringOutput
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.
type ImageArgs ¶
type ImageArgs struct { // The container format. Must be one of // "ami", "ari", "aki", "bare", "ovf". ContainerFormat interface{} // The disk format. Must be one of // "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso". DiskFormat interface{} // 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" ImageCachePath interface{} // 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`. ImageSourceUrl interface{} // This is the filepath of the raw image file // that will be uploaded to Glance. Conflicts with `image_source_url`. LocalFilePath interface{} // Amount of disk space (in GB) required to boot image. // Defaults to 0. MinDiskGb interface{} // Amount of ram (in MB) required to boot image. // Defauts to 0. MinRamMb interface{} // The name of the image. Name interface{} // A map of key/value pairs to set freeform // information about an image. See the "Notes" section for further // information about properties. Properties interface{} // If true, image will not be deletable. // Defaults to false. Protected interface{} // 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. Region interface{} // 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. Tags interface{} // If false, the checksum will not be verified // once the image is finished uploading. Defaults to true. VerifyChecksum interface{} // 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. Visibility interface{} }
The set of arguments for constructing a Image resource.
type ImageState ¶
type ImageState struct { // The checksum of the data associated with the image. Checksum interface{} // The container format. Must be one of // "ami", "ari", "aki", "bare", "ovf". ContainerFormat interface{} // The date the image was created. CreatedAt interface{} // The disk format. Must be one of // "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso". DiskFormat interface{} // the trailing path after the glance // endpoint that represent the location of the image // or the path to retrieve it. File interface{} // 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" ImageCachePath interface{} // 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`. ImageSourceUrl interface{} // This is the filepath of the raw image file // that will be uploaded to Glance. Conflicts with `image_source_url`. LocalFilePath 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. Metadata interface{} // Amount of disk space (in GB) required to boot image. // Defaults to 0. MinDiskGb interface{} // Amount of ram (in MB) required to boot image. // Defauts to 0. MinRamMb interface{} // The name of the image. Name interface{} // The id of the openstack user who owns the image. Owner interface{} // A map of key/value pairs to set freeform // information about an image. See the "Notes" section for further // information about properties. Properties interface{} // If true, image will not be deletable. // Defaults to false. Protected interface{} // 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. Region interface{} // The path to the JSON-schema that represent // the image or image Schema interface{} // The size in bytes of the data associated with the image. SizeBytes interface{} // The status of the image. It can be "queued", "active" // or "saving". Status interface{} // 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. Tags interface{} // (**Deprecated** - use `updated_at` instead) UpdateAt interface{} // The date the image was last updated. UpdatedAt interface{} // If false, the checksum will not be verified // once the image is finished uploading. Defaults to true. VerifyChecksum interface{} // 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. Visibility interface{} }
Input properties used for looking up and filtering Image resources.