Common Image Properties¶
When adding an image to Glance, you may specify some common image properties that may prove useful to consumers of your image.
This document explains the names of these properties and the expected values.
The common image properties are also described in a JSON schema, found in
/etc/glance/schema-image.json in the Glance source code.
The ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.
The ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.
Metadata which can be used to record which instance this image is associated with. (Informational only, does not create an instance snapshot.)
Operating system architecture as specified in https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html
The common name of the operating system distribution as specified in https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html
The operating system version as specified by the distributor.
A brief human-readable string, suitable for display in a user interface, describing the image.
Identifier in the OpenStack Key Management Service for the encryption key for the Block Storage Service to use when mounting a volume created from this image.
States the condition under which the Image Service will delete the object associated with the ‘cinder_encryption_key_id’ image property. If this property is missing, the Image Service will take no action.
This file is the default schema. An operator can modify
/etc/schema-image.json to include arbitrary properties.
Do not delete existing properties from this default schema because this will affect interoperability
typeof each property in this JSON schema, specified by the
typekey, must have value
stringeven if the property you are adding is not a string in common sense. For example, if you want to add a property named
is_removableand want its type to be
boolean. However, you must give the
typekey the value
string. Otherwise, when an end-user makes a call that sets a value on one of these, they will gets a 500. This is because everything in the image_properties table must be a string in the database. The API, however, won’t accept a string value when the schema says it is boolean or some other non-string JSON data type
If your need is more complicated, we recommend using metadefs instead of modifying this image schema