ac1e0f8afe
In the top index page of the document, some sections had actual contents and some had only links to the contents. However, this makes it difficult for readers to get what is in the document and what isn't at a glance. This patch cleans it up to simplify the top index. This patch also renames some of the directories to follow the doc layout rules[1]. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Note that the following ToDo is left for further cleanup: * Publish the api guide and move the microversion history to the `/api-guide` directory Change-Id: Ideb1d5e7c74d1d564d07bac1a1e7c86c55ede873
96 lines
2.5 KiB
ReStructuredText
96 lines
2.5 KiB
ReStructuredText
..
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
===========
|
|
Placement
|
|
===========
|
|
|
|
The placement API service was introduced in the 14.0.0 Newton release within
|
|
the nova repository and extracted to the `placement repository`_ in the 19.0.0
|
|
Stein release. This is a REST API stack and data model used to track resource
|
|
provider inventories and usages, along with different classes of resources.
|
|
For example, a resource provider can be a compute node, a shared storage pool,
|
|
or an IP allocation pool. The placement service tracks the inventory and usage
|
|
of each provider. For example, an instance created on a compute node may be a
|
|
consumer of resources such as RAM and CPU from a compute node resource
|
|
provider, disk from an external shared storage pool resource provider and IP
|
|
addresses from an external IP pool resource provider.
|
|
|
|
The types of resources consumed are tracked as **classes**. The service
|
|
provides a set of standard resource classes (for example ``DISK_GB``,
|
|
``MEMORY_MB``, and ``VCPU``) and provides the ability to define custom
|
|
resource classes as needed.
|
|
|
|
Each resource provider may also have a set of traits which describe qualitative
|
|
aspects of the resource provider. Traits describe an aspect of a resource
|
|
provider that cannot itself be consumed but a workload may wish to specify. For
|
|
example, available disk may be solid state drives (SSD).
|
|
|
|
.. _placement repository: https://opendev.org/openstack/placement
|
|
|
|
Usages
|
|
======
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
user/index
|
|
|
|
Command Line Interface
|
|
======================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
cli/index
|
|
|
|
Configuration
|
|
=============
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
configuration/index
|
|
|
|
Contribution
|
|
============
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
contributor/index
|
|
|
|
Specifications
|
|
==============
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
specs/index
|
|
|
|
Deployment
|
|
==========
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
install/index
|
|
|
|
Administrator Guide
|
|
===================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
admin/index
|