diff options
Diffstat (limited to 'api-guide')
| -rw-r--r-- | api-guide/source/conf.py | 1 | ||||
| -rw-r--r-- | api-guide/source/extra_specs_and_properties.rst | 38 | ||||
| -rw-r--r-- | api-guide/source/general_info.rst | 4 | ||||
| -rw-r--r-- | api-guide/source/index.rst | 6 |
4 files changed, 37 insertions, 12 deletions
diff --git a/api-guide/source/conf.py b/api-guide/source/conf.py index 8774e047d1..af340a3552 100644 --- a/api-guide/source/conf.py +++ b/api-guide/source/conf.py @@ -285,6 +285,7 @@ pdf_documents = [ # -- Options for openstackdocstheme ------------------------------------------- openstack_projects = [ + 'glance', 'nova', 'neutron', 'placement', diff --git a/api-guide/source/extra_specs_and_properties.rst b/api-guide/source/extra_specs_and_properties.rst index 29a9ffe942..cd5411789a 100644 --- a/api-guide/source/extra_specs_and_properties.rst +++ b/api-guide/source/extra_specs_and_properties.rst @@ -2,16 +2,44 @@ Flavor Extra Specs and Image Properties ======================================= -TODO: Generic description about Flavor Extra Specs and Image Properties. +Flavor extra specs and image properties are used to control certain aspects +or scheduling behavior for a server. + +The flavor of a server can be changed during a +:nova-doc:`resize </user/resize>` operation. + +The image of a server can be changed during a +:nova-doc:`rebuild </contributor/evacuate-vs-rebuild>` operation. + +By default, flavor extra specs are controlled by administrators of the cloud. +If users are authorized to upload their own images to the image service, they +may be able to specify their own image property requirements. + +There are many cases of flavor extra specs and image properties that are for +the same functionality. In many cases the image property takes precedence over +the flavor extra spec if both are used in the same server. Flavor Extra Specs ================== -TODO: List the extra specs which we supported at here. The best is the extra -specs can auto-gen from the nova code. +Refer to the :nova-doc:`user guide </user/flavors.html#extra-specs>` for a +list of official extra specs. + +While there are standard extra specs, deployments can define their own extra +specs to be used with host aggregates and custom scheduler filters as +necessary. See the +:nova-doc:`reference guide </reference/scheduler-hints-vs-flavor-extra-specs>` +for more details. Image Properties ================ -TODO: List the properties which affect the server creation. The best is the -properties can auto-gen from the image properties object. +Refer to the image service documentation for a list of official +:glance-doc:`image properties </admin/useful-image-properties>` and +:glance-doc:`metadata definition concepts </user/metadefs-concepts>`. + +Unlike flavor extra specs, image properties are standardized in the compute +service and thus they must be `registered`_ within the compute service before +they can be used. + +.. _registered: https://opendev.org/openstack/nova/src/branch/master/nova/objects/image_meta.py diff --git a/api-guide/source/general_info.rst b/api-guide/source/general_info.rst index 52df65aebc..dce73a3d9b 100644 --- a/api-guide/source/general_info.rst +++ b/api-guide/source/general_info.rst @@ -42,7 +42,7 @@ several key concepts: - **Flavor Extra Specs** Key and value pairs that can be used to describe the specification of - the server which more than just about CPU, disk and RAM. For example, + the server which is more than just about CPU, disk and RAM. For example, it can be used to indicate that the server created by this flavor has PCI devices, etc. @@ -60,7 +60,7 @@ several key concepts: - **Image Properties** Key and value pairs that can help end users to determine the requirements - of the guest os in the image. + of the guest operating system in the image. For more details, please see: :doc:`extra_specs_and_properties` diff --git a/api-guide/source/index.rst b/api-guide/source/index.rst index 7d82f7b5ec..6763b73c08 100644 --- a/api-guide/source/index.rst +++ b/api-guide/source/index.rst @@ -79,6 +79,7 @@ Contents general_info server_concepts authentication + extra_specs_and_properties faults limits links_and_references @@ -87,8 +88,3 @@ Contents request_and_response_formats down_cells port_with_resource_request - -.. toctree:: - :hidden: - - extra_specs_and_properties |