glance/doc/source/user/common-image-properties.rst
zhangbailin 345b9e77fe Add description to common image properties
Add the 'description' attribute to common image properties to allow
users to record the purpose of the image in a human-readable format
in an interoperable way.

Co-authored-by: zhangbailin <zhangbailin@inspur.com>
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Change-Id: Id0b148190cfa5fb9851ad2085a6b1ac1e0e7e352
Blueprint: add-description-field-to-image
2019-03-20 11:51:47 -04:00

2.0 KiB

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.

architecture

Operating system architecture as specified in https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html

instance_uuid

Metadata which can be used to record which instance this image is associated with. (Informational only, does not create an instance snapshot.)

kernel_id

The ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.

ramdisk_id

The ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.

os_distro

The common name of the operating system distribution as specified in https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html

os_version

The operating system version as specified by the distributor.

description

A brief human-readable string, suitable for display in a user interface, describing the image.