glance/doc/source/user/common-image-properties.rst
Akihiro Motoki b6ceda28a4 doc: Clean up unnecessary left vertical lines
In HTML documents with openstackdocstheme, vertical lines are shown
at the left side for literal blocks. Indented blocks are considered
as literal blocks in ReST text.
Unnecessary indented blocks are found in the glance document and
it leads to blocks with unexpected vertical left lines and
sometimes with unexpected fonts like [1].
Unexpected literal blocks are cleanup.

This commit also converts Definition lists in user/formats.rst and
user/common-image-properties.rst into the proper way in ReST text.

[1] https://docs.openstack.org/glance/latest/user/formats.html#container-format

Change-Id: I1b026f919bb22a59d23e3bb93bb7919d202a62fc
2019-12-23 13:58:32 +00:00

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