docs: Rework all things metadata'y

Turns out we've a *lot* of disparate metadata systems. Attempt to both
link them somewhat through extensive cross-referencing and extract out
deployment-specific stuff from user-facing docs. Lots of changes here,
but in summary:

- Split out admin-focused content from the metadata API, config drive,
  user data and vendordata docs.

- Merge the config drive, metadata service, vendordata and user-data
  user docs, which are mostly talking about the same thing and are
  fairly barren without the deployment components

- Make use of various oslo.config and Sphinx roles

Side note: I miss when we have tech writers to do this stuff for us :(

Change-Id: I4fb2b628bd93358a752e2397ae353221758e2984
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane
2019-03-05 15:57:14 +00:00
parent 74aebe0d4e
commit 92a432fde7
20 changed files with 1058 additions and 725 deletions
+6 -8
View File
@@ -84,8 +84,8 @@ resources will help you get started with consuming the API directly.
* :doc:`Block Device Mapping </user/block-device-mapping>`: One of the trickier
parts to understand is the Block Device Mapping parameters used to connect
specific block devices to computes. This deserves its own deep dive.
* :doc:`Configuration drive </user/config-drive>`: Provide information to the
guest instance when it is created.
* :doc:`Metadata </user/metadata>`: Provide information to the guest instance
when it is created.
Nova can be configured to emit notifications over RPC.
@@ -158,9 +158,10 @@ Once you are running nova, the following information is extremely useful.
configured, and how that will impact where compute instances land in your
environment. If you are seeing unexpected distribution of compute instances
in your hosts, you'll want to dive into this configuration.
* :doc:`Exposing custom metadata to compute instances </user/vendordata>`: How and
when you might want to extend the basic metadata exposed to compute instances
(either via metadata server or config drive) for your specific purposes.
* :doc:`Exposing custom metadata to compute instances </admin/vendordata>`: How
and when you might want to extend the basic metadata exposed to compute
instances (either via metadata server or config drive) for your specific
purposes.
Reference Material
------------------
@@ -244,7 +245,6 @@ looking parts of our architecture. These are collected below.
user/cellsv2-layout
user/certificate-validation
user/conductor
user/config-drive
user/feature-classification
user/filter-scheduler
user/flavors
@@ -252,8 +252,6 @@ looking parts of our architecture. These are collected below.
user/quotas
user/support-matrix
user/upgrade
user/user-data
user/vendordata
user/wsgi