Matt Riedemann
37164b418e
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
61 lines
2.4 KiB
ReStructuredText
61 lines
2.4 KiB
ReStructuredText
================================
|
|
Technical Reference Deep Dives
|
|
================================
|
|
|
|
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
|
|
part work.
|
|
|
|
.. _reference-internals:
|
|
|
|
Internals
|
|
=========
|
|
|
|
The following is a dive into some of the internals in nova.
|
|
|
|
* :doc:`/reference/rpc`: How nova uses AMQP as an RPC transport
|
|
* :doc:`/reference/scheduling`: The workflow through the scheduling process
|
|
* :doc:`/reference/scheduler-hints-vs-flavor-extra-specs`: The similarities
|
|
and differences between flavor extra specs and scheduler hints.
|
|
* :doc:`/reference/live-migration`: The live migration flow
|
|
* :doc:`/reference/services`: Module descriptions for some of the key modules
|
|
used in starting / running services
|
|
* :doc:`/reference/vm-states`: Cheat sheet for understanding the life cycle of
|
|
compute instances
|
|
* :doc:`/reference/threading`: The concurrency model used in nova, which is
|
|
based on eventlet, and may not be familiar to everyone.
|
|
* :doc:`/reference/notifications`: How the notifications subsystem works in
|
|
nova, and considerations when adding notifications.
|
|
* :doc:`/reference/update-provider-tree`: A detailed explanation of the
|
|
``ComputeDriver.update_provider_tree`` method.
|
|
* :doc:`/reference/upgrade-checks`: A guide to writing automated upgrade
|
|
checks.
|
|
* :doc:`/reference/conductor`
|
|
|
|
.. todo:: Need something about versioned objects and how they fit in with
|
|
conductor as an object backporter during upgrades.
|
|
|
|
Debugging
|
|
=========
|
|
|
|
* :doc:`/reference/gmr`: Inspired by Amiga, a way to trigger a very
|
|
comprehensive dump of a running service for deep debugging.
|
|
|
|
Forward Looking Plans
|
|
=====================
|
|
|
|
The following section includes documents that describe the overall plan behind
|
|
groups of nova-specs. Most of these cover items relating to the evolution of
|
|
various parts of nova's architecture. Once the work is complete,
|
|
these documents will move into the "Internals" section.
|
|
|
|
If you want to get involved in shaping the future of nova's architecture,
|
|
these are a great place to start reading up on the current plans.
|
|
|
|
* :doc:`/user/cells`: How cells v2 is evolving
|
|
* :doc:`/reference/policy-enforcement`: How we want policy checks on API actions
|
|
to work in the future
|
|
* :doc:`/reference/stable-api`: What stable api means to nova
|
|
* :doc:`/reference/scheduler-evolution`: Motivation behind the scheduler /
|
|
placement evolution
|