doc: cleanup references to conductor doc

The conductor doc is not really end user material,
so this moves it under reference/, removes it from the
user page and adds it to the reference index for internals.
Also makes the contributor page link to the reference internals
since it's kind of weird to have one contributor section that
only mentions one thing but the internals under reference have
a lot more of that kind of detail. Finally, a todo is added so
we don't forget to update the reference internals about versioned
objects at some point since that's always a point of confusion
for people.

Change-Id: I8d3dbce5334afaa3e1ca309b2669eff9933a0104
This commit is contained in:
Matt Riedemann 2019-09-05 18:37:31 -04:00
parent c84400f152
commit 37164b418e
5 changed files with 12 additions and 7 deletions

View File

@ -104,8 +104,6 @@ changes done to the API, as the impact can be very wide.
Nova Major Subsystems Nova Major Subsystems
===================== =====================
Major subsystems in nova have different needs; some of those are documented Major subsystems in nova have different needs. If you are contributing to one
here. If you are contributing to one of these please read the subsystem guide of these please read the :ref:`reference guide <reference-internals>` before
before diving in. diving in.
* :doc:`/user/conductor`

View File

@ -223,6 +223,7 @@ looking parts of our architecture. These are collected below.
contributor/project-scope contributor/project-scope
contributor/ptl-guide contributor/ptl-guide
reference/api-microversion-history.rst reference/api-microversion-history.rst
reference/conductor
reference/gmr reference/gmr
reference/i18n reference/i18n
reference/live-migration reference/live-migration
@ -245,7 +246,6 @@ looking parts of our architecture. These are collected below.
user/cells user/cells
user/cellsv2-layout user/cellsv2-layout
user/certificate-validation user/certificate-validation
user/conductor
user/feature-classification user/feature-classification
user/filter-scheduler user/filter-scheduler
user/flavors user/flavors

View File

@ -6,6 +6,8 @@ The nova project is large, and there are lots of complicated parts in it where
it helps to have an overview to understand how the internals of a particular it helps to have an overview to understand how the internals of a particular
part work. part work.
.. _reference-internals:
Internals Internals
========= =========
@ -28,6 +30,10 @@ The following is a dive into some of the internals in nova.
``ComputeDriver.update_provider_tree`` method. ``ComputeDriver.update_provider_tree`` method.
* :doc:`/reference/upgrade-checks`: A guide to writing automated upgrade * :doc:`/reference/upgrade-checks`: A guide to writing automated upgrade
checks. checks.
* :doc:`/reference/conductor`
.. todo:: Need something about versioned objects and how they fit in with
conductor as an object backporter during upgrades.
Debugging Debugging
========= =========

View File

@ -27,7 +27,8 @@ Architecture Overview
to connect specific block devices to computes. This deserves its own deep to connect specific block devices to computes. This deserves its own deep
dive. dive.
* :doc:`Conductor </user/conductor>`: TODO See the :ref:`reference guide <reference-internals>` for details about more
internal subsystems.
Deployment Considerations Deployment Considerations
------------------------- -------------------------