openstack
/
glance
Code Issues Proposed changes

Update 'common image properties' doc 

Update doc/source/user/common-image-properties.rst (live link [1]) to be
in sync with etc/schema-image.json

This patch does 2 actions:
1. Add the missing properties that are in etc/schema-image.json to
   the doc
2. Rearrange the order of appearance of properties in the doc to be
   the same as they appear in etc/schema-image.json

[1] docs.openstack.org/glance/latest/user/common-image-properties.html

Change-Id: I840f3cbeda28da8b02dd141fde582c9110aeb21e
Closes-bug: #1870336
This commit is contained in:
khashf 2020-04-07 17:44:39 -07:00
parent 2f2e118a58
commit 984e844c6a
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/source/user/common-image-properties.rst
View File

@ -25,14 +25,6 @@ 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.
@ -41,6 +33,14 @@ ramdisk_id
The ID of image stored in Glance that should be used as the ramdisk when
booting an AMI-style image.
instance_uuid
Metadata which can be used to record which instance this image is associated
with. (Informational only, does not create an instance snapshot.)
architecture
Operating system architecture as specified in
https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html
os_distro
The common name of the operating system distribution as specified in
https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html
@ -51,3 +51,13 @@ os_version
description
A brief human-readable string, suitable for display in a user interface,
describing the image.
cinder_encryption_key_id
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.
cinder_encryption_key_deletion_policy
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.