openstack
/
placement
Code Issues Proposed changes

Merge "Slightly improve usage documentation"

This commit is contained in:
Zuul 2019-03-19 20:23:09 +00:00 committed by Gerrit Code Review
parent 226e3ca706 af99d9e4e1
commit 08e5a62185
1 changed files with 36 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/source/usage/index.rst
View File

@ -20,17 +20,50 @@ Tracking Resources
The placement service enables other projects to track their own resources.
Those projects can register/delete their own resources to/from placement
via the placement REST API.
via the placement `HTTP API`_.
The placement service originated in the :nova-doc:`Nova project </>`. As a
result much of the functionality in placement was driven by nova's
requirements. However, that functionality was designed to be sufficiently
generic to be used by any service that needs to manage the selection and
consumption of resources.
How Nova Uses Placement
-----------------------
Two processes, ``nova-compute`` and ``nova-scheduler``, host most of nova's
interaction with placement.
The nova resource tracker in ``nova-compute`` is responsible for `creating the
resource provider`_ record corresponding to the compute host on which the
resource tracker runs, `setting the inventory`_ that describes the quantitative
resources that are available for workloads to consume (e.g., ``VCPU``), and
`setting the traits`_ that describe qualitative aspects of the resources (e.g.,
``STORAGE_DISK_SSD``).
The nova resource tracker is responsible for creating the resource provider
record corresponding to the compute host on which the resource tracker runs.
If other projects -- for example, Neutron or Cyborg -- wish to manage resources
on a compute host, they should create resource providers as children of the
compute host provider and register their own managed resources as inventory on
those child providers. For more information, see the
:doc:`Modeling with Provider Trees <provider-tree>`.
The ``nova-scheduler`` is responsible for selecting a set of suitable
destination hosts for a workload. It begins by formulating a request to
placement for a list of `allocation candidates`_. That request expresses
quantitative and qualitative requirements, membership in aggregates, and in
more complex cases, the topology of related resources. That list is reduced and
ordered by filters and weighers within the scheduler process. An `allocation`_
is made against a resource provider representing a destination, consuming a
portion of the inventory set by the resource tracker.
.. toctree::
:hidden:
provider-tree
.. _HTTP API: https://developer.openstack.org/api-ref/placement/
.. _creating the resource provider: https://developer.openstack.org/api-ref/placement/?expanded=create-resource-provider-detail#create-resource-provider
.. _setting the inventory: https://developer.openstack.org/api-ref/placement/?expanded=update-resource-provider-inventories-detail#update-resource-provider-inventories
.. _setting the traits: https://developer.openstack.org/api-ref/placement/?expanded=update-resource-provider-traits-detail#update-resource-provider-traits
.. _allocation candidates: https://developer.openstack.org/api-ref/placement/?expanded=list-allocation-candidates-detail#list-allocation-candidates
.. _allocation: https://developer.openstack.org/api-ref/placement/?expanded=update-allocations-detail#update-allocations