From 83e77635181c34b1071492c2e388a77ad24cc189 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Wed, 28 Jun 2017 12:23:19 +0100 Subject: [PATCH] doc: Populate the 'reference' section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Per the spec [1]: reference/ – any reference information associated with a project that is not covered by one of the above categories. Library projects should place their automatically generated class documentation here. There are a couple of documents that focus on nova internals, but won't necessarily be applicable to user. These are moved here. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I94614c2383329e1fbed60d9c5aca3fab5170ef8f --- .../images/create-vm-states.svg} | 0 .../arch.png => _static/images/rpc-arch.png} | Bin .../arch.svg => _static/images/rpc-arch.svg} | 0 .../images/rpc-flow-1.png} | Bin .../images/rpc-flow-1.svg} | 0 .../images/rpc-flow-2.png} | Bin .../images/rpc-flow-2.svg} | 0 .../rabt.png => _static/images/rpc-rabt.png} | Bin .../rabt.svg => _static/images/rpc-rabt.svg} | 0 .../images/rpc-state.png} | Bin doc/source/api_microversion_history.rst | 1 - doc/source/architecture.rst | 2 +- doc/source/contributor/code-review.rst | 2 +- doc/source/index.rst | 22 +++++++++--------- .../reference/api-microversion-history.rst | 1 + doc/source/{ => reference}/gmr.rst | 0 doc/source/{ => reference}/i18n.rst | 0 doc/source/{ => reference}/notifications.rst | 0 .../policy-enforcement.rst} | 0 doc/source/{ => reference}/rpc.rst | 10 ++++---- .../scheduler-evolution.rst} | 0 doc/source/{ => reference}/services.rst | 0 .../stable-api.rst} | 0 doc/source/{ => reference}/threading.rst | 0 .../{vmstates.rst => reference/vm-states.rst} | 2 +- 25 files changed, 20 insertions(+), 20 deletions(-) rename doc/source/{images/create_vm_states.svg => _static/images/create-vm-states.svg} (100%) rename doc/source/{images/rpc/arch.png => _static/images/rpc-arch.png} (100%) rename doc/source/{images/rpc/arch.svg => _static/images/rpc-arch.svg} (100%) rename doc/source/{images/rpc/flow1.png => _static/images/rpc-flow-1.png} (100%) rename doc/source/{images/rpc/flow1.svg => _static/images/rpc-flow-1.svg} (100%) rename doc/source/{images/rpc/flow2.png => _static/images/rpc-flow-2.png} (100%) rename doc/source/{images/rpc/flow2.svg => _static/images/rpc-flow-2.svg} (100%) rename doc/source/{images/rpc/rabt.png => _static/images/rpc-rabt.png} (100%) rename doc/source/{images/rpc/rabt.svg => _static/images/rpc-rabt.svg} (100%) rename doc/source/{images/rpc/state.png => _static/images/rpc-state.png} (100%) delete mode 100644 doc/source/api_microversion_history.rst create mode 100644 doc/source/reference/api-microversion-history.rst rename doc/source/{ => reference}/gmr.rst (100%) rename doc/source/{ => reference}/i18n.rst (100%) rename doc/source/{ => reference}/notifications.rst (100%) rename doc/source/{policy_enforcement.rst => reference/policy-enforcement.rst} (100%) rename doc/source/{ => reference}/rpc.rst (98%) rename doc/source/{scheduler_evolution.rst => reference/scheduler-evolution.rst} (100%) rename doc/source/{ => reference}/services.rst (100%) rename doc/source/{stable_api.rst => reference/stable-api.rst} (100%) rename doc/source/{ => reference}/threading.rst (100%) rename doc/source/{vmstates.rst => reference/vm-states.rst} (99%) diff --git a/doc/source/images/create_vm_states.svg b/doc/source/_static/images/create-vm-states.svg similarity index 100% rename from doc/source/images/create_vm_states.svg rename to doc/source/_static/images/create-vm-states.svg diff --git a/doc/source/images/rpc/arch.png b/doc/source/_static/images/rpc-arch.png similarity index 100% rename from doc/source/images/rpc/arch.png rename to doc/source/_static/images/rpc-arch.png diff --git a/doc/source/images/rpc/arch.svg b/doc/source/_static/images/rpc-arch.svg similarity index 100% rename from doc/source/images/rpc/arch.svg rename to doc/source/_static/images/rpc-arch.svg diff --git a/doc/source/images/rpc/flow1.png b/doc/source/_static/images/rpc-flow-1.png similarity index 100% rename from doc/source/images/rpc/flow1.png rename to doc/source/_static/images/rpc-flow-1.png diff --git a/doc/source/images/rpc/flow1.svg b/doc/source/_static/images/rpc-flow-1.svg similarity index 100% rename from doc/source/images/rpc/flow1.svg rename to doc/source/_static/images/rpc-flow-1.svg diff --git a/doc/source/images/rpc/flow2.png b/doc/source/_static/images/rpc-flow-2.png similarity index 100% rename from doc/source/images/rpc/flow2.png rename to doc/source/_static/images/rpc-flow-2.png diff --git a/doc/source/images/rpc/flow2.svg b/doc/source/_static/images/rpc-flow-2.svg similarity index 100% rename from doc/source/images/rpc/flow2.svg rename to doc/source/_static/images/rpc-flow-2.svg diff --git a/doc/source/images/rpc/rabt.png b/doc/source/_static/images/rpc-rabt.png similarity index 100% rename from doc/source/images/rpc/rabt.png rename to doc/source/_static/images/rpc-rabt.png diff --git a/doc/source/images/rpc/rabt.svg b/doc/source/_static/images/rpc-rabt.svg similarity index 100% rename from doc/source/images/rpc/rabt.svg rename to doc/source/_static/images/rpc-rabt.svg diff --git a/doc/source/images/rpc/state.png b/doc/source/_static/images/rpc-state.png similarity index 100% rename from doc/source/images/rpc/state.png rename to doc/source/_static/images/rpc-state.png diff --git a/doc/source/api_microversion_history.rst b/doc/source/api_microversion_history.rst deleted file mode 100644 index b8a7412c6132..000000000000 --- a/doc/source/api_microversion_history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../nova/api/openstack/compute/rest_api_version_history.rst diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index 5aacc92dce98..3d0824ba2b97 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -32,7 +32,7 @@ a `manager` that is listening for `RPC` messages. The one major exception is nova-compute, where a single process runs on the hypervisor it is managing (except when using the VMware or Ironic drivers). The manager also, optionally, has periodic tasks. -For more details on our `RPC` system, please see: :doc:`rpc` +For more details on our `RPC` system, please see: :doc:`/reference/rpc` Nova also uses a central database that is (logically) shared between all components. However, to aid upgrade, the DB is accessed through an object diff --git a/doc/source/contributor/code-review.rst b/doc/source/contributor/code-review.rst index 90294f858516..8930d2390d6f 100644 --- a/doc/source/contributor/code-review.rst +++ b/doc/source/contributor/code-review.rst @@ -243,7 +243,7 @@ Notifications ============= * Every new notification type shall use the new versioned notification - infrastructure documented in :doc:`/notifications` + infrastructure documented in :doc:`/reference/notifications` Release Notes ============= diff --git a/doc/source/index.rst b/doc/source/index.rst index 98524de03662..9c7b5d7baa2f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -54,7 +54,7 @@ forward. You can also see a history of our microversions here: .. toctree:: :maxdepth: 1 - api_microversion_history + reference/api-microversion-history .. note:: Only Version 2.1 APIs should be used from this point forward, Version 2.0 @@ -147,18 +147,18 @@ Open Development. :maxdepth: 1 contributor/api-2 - rpc + reference/rpc block_device_mapping conductor filter_scheduler aggregates - i18n - notifications + reference/i18n + reference/notifications placement contributor/placement quotas - threading - vmstates + reference/threading + reference/vm-states wsgi Architecture Evolution Plans @@ -178,9 +178,9 @@ these are a great place to start reading up on the current plans. upgrade contributor/api contributor/microversions - policy_enforcement - stable_api - scheduler_evolution + reference/policy-enforcement + reference/stable-api + reference/scheduler-evolution Advanced testing and guides ---------------------------- @@ -188,7 +188,7 @@ Advanced testing and guides .. toctree:: :maxdepth: 1 - gmr + reference/gmr contributor/testing/libvirt-numa contributor/testing/serial-console contributor/testing/zero-downtime-upgrade @@ -222,7 +222,7 @@ Module Reference .. toctree:: :maxdepth: 1 - services + reference/services .. # NOTE(mriedem): This is the section where we hide things that we don't diff --git a/doc/source/reference/api-microversion-history.rst b/doc/source/reference/api-microversion-history.rst new file mode 100644 index 000000000000..45000e16d25d --- /dev/null +++ b/doc/source/reference/api-microversion-history.rst @@ -0,0 +1 @@ +.. include:: ../../../nova/api/openstack/compute/rest_api_version_history.rst diff --git a/doc/source/gmr.rst b/doc/source/reference/gmr.rst similarity index 100% rename from doc/source/gmr.rst rename to doc/source/reference/gmr.rst diff --git a/doc/source/i18n.rst b/doc/source/reference/i18n.rst similarity index 100% rename from doc/source/i18n.rst rename to doc/source/reference/i18n.rst diff --git a/doc/source/notifications.rst b/doc/source/reference/notifications.rst similarity index 100% rename from doc/source/notifications.rst rename to doc/source/reference/notifications.rst diff --git a/doc/source/policy_enforcement.rst b/doc/source/reference/policy-enforcement.rst similarity index 100% rename from doc/source/policy_enforcement.rst rename to doc/source/reference/policy-enforcement.rst diff --git a/doc/source/rpc.rst b/doc/source/reference/rpc.rst similarity index 98% rename from doc/source/rpc.rst rename to doc/source/reference/rpc.rst index 7027f81a10f2..b2d7c98353d1 100644 --- a/doc/source/rpc.rst +++ b/doc/source/reference/rpc.rst @@ -25,7 +25,7 @@ AMQP is the messaging technology chosen by the OpenStack cloud. The AMQP broker Nova uses direct, fanout, and topic-based exchanges. The architecture looks like the one depicted in the figure below: -.. image:: ./images/rpc/arch.png +.. image:: /_static/images/rpc-arch.png :width: 60% .. @@ -47,7 +47,7 @@ Figure 2 shows the following internal elements: * Direct Exchange: this is a routing table that is created during rpc.call operations; there are many instances of this kind of exchange throughout the life-cycle of a message broker node, one for each rpc.call invoked. * Queue Element: A Queue is a message bucket. Messages are kept in the queue until a Consumer (either Topic or Direct Consumer) connects to the queue and fetch it. Queues can be shared or can be exclusive. Queues whose routing key is 'topic' are shared amongst Workers of the same personality. -.. image:: ./images/rpc/rabt.png +.. image:: /_static/images/rpc-rabt.png :width: 60% .. @@ -62,7 +62,7 @@ The diagram below shows the message flow during an rpc.call operation: 3. once the task is completed, a Direct Publisher is allocated to send the response message to the queuing system. 4. once the message is dispatched by the exchange, it is fetched by the Direct Consumer dictated by the routing key (such as 'msg_id') and passed to the Invoker. -.. image:: ./images/rpc/flow1.png +.. image:: /_static/images/rpc-flow-1.png :width: 60% .. @@ -75,7 +75,7 @@ The diagram below shows the message flow during an rpc.cast operation: 1. A Topic Publisher is instantiated to send the message request to the queuing system. 2. Once the message is dispatched by the exchange, it is fetched by the Topic Consumer dictated by the routing key (such as 'topic') and passed to the Worker in charge of the task. -.. image:: ./images/rpc/flow2.png +.. image:: /_static/images/rpc-flow-2.png :width: 60% .. @@ -100,7 +100,7 @@ The figure below shows the status of a RabbitMQ node after Nova components' boot 5. scheduler.phantom (phantom is hostname) 6. scheduler -.. image:: ./images/rpc/state.png +.. image:: /_static/images/rpc-state.png :width: 60% .. diff --git a/doc/source/scheduler_evolution.rst b/doc/source/reference/scheduler-evolution.rst similarity index 100% rename from doc/source/scheduler_evolution.rst rename to doc/source/reference/scheduler-evolution.rst diff --git a/doc/source/services.rst b/doc/source/reference/services.rst similarity index 100% rename from doc/source/services.rst rename to doc/source/reference/services.rst diff --git a/doc/source/stable_api.rst b/doc/source/reference/stable-api.rst similarity index 100% rename from doc/source/stable_api.rst rename to doc/source/reference/stable-api.rst diff --git a/doc/source/threading.rst b/doc/source/reference/threading.rst similarity index 100% rename from doc/source/threading.rst rename to doc/source/reference/threading.rst diff --git a/doc/source/vmstates.rst b/doc/source/reference/vm-states.rst similarity index 99% rename from doc/source/vmstates.rst rename to doc/source/reference/vm-states.rst index 978fe5223e73..f9d6ae554efa 100644 --- a/doc/source/vmstates.rst +++ b/doc/source/reference/vm-states.rst @@ -136,6 +136,6 @@ Create Instance States The following diagram shows the sequence of VM states, task states, and power states when a new VM instance is created. -.. image:: ./images/create_vm_states.svg +.. image:: /_static/images/create-vm-states.svg :alt: Sequence of VM states, task states, and power states when a new VM instance is created.