diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2019-03-05 15:57:14 +0000 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2019-06-20 18:22:34 +0100 |
| commit | 92a432fde7967f83e9c803c6a95b8f2893a6cc35 (patch) | |
| tree | 880478f012ceb98de22e29c9912231ad967ba242 /api-guide | |
| parent | 74aebe0d4e5a978a40011e890aee9e70e98246c4 (diff) | |
| download | nova-92a432fde7967f83e9c803c6a95b8f2893a6cc35.tar.gz | |
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>
Diffstat (limited to 'api-guide')
| -rw-r--r-- | api-guide/source/server_concepts.rst | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/api-guide/source/server_concepts.rst b/api-guide/source/server_concepts.rst index 03a5f0ee5d..0b42f02b3c 100644 --- a/api-guide/source/server_concepts.rst +++ b/api-guide/source/server_concepts.rst @@ -1014,10 +1014,11 @@ Configure Guest OS Metadata API ------------ -Nova provides a metadata api for servers to retrieve server specific metadata. -Neutron ensures this metadata api can be accessed through a predefined ip -address (169.254.169.254). For more details, see :nova-doc:`Metadata Service -<user/metadata-service.html>`. + +Nova provides a metadata API for servers to retrieve server specific metadata. +Neutron ensures this metadata API can be accessed through a predefined IP +address, ``169.254.169.254``. For more details, refer to the :nova-doc:`user +guide <user/metadata.html>`. Config Drive ------------ @@ -1025,20 +1026,19 @@ Config Drive Nova is able to write metadata to a special configuration drive that attaches to the server when it boots. The server can mount this drive and read files from it to get information that is normally available through the metadata -service. For more details, see :nova-doc:`Config Drive -<user/config-drive.html>`. +service. For more details, refer to the :nova-doc:`user guide +<user/metadata.html>`. User data --------- + A user data file is a special key in the metadata service that holds a file that cloud-aware applications in the server can access. -Nova has two ways to send user data to the deployed server, one is by -metadata service to let server able to access to its metadata through -a predefined ip address (169.254.169.254), then other way is to use config -drive which will wrap metadata into a iso9660 or vfat format disk so that -the deployed server can consume it by active engines such as cloud-init -during its boot process. +This information can be accessed via the metadata API or a config drive. The +latter allows the deployed server to consume it by active engines such as +cloud-init during its boot process, where network connectivity may not be an +option. Server personality ------------------ |