Commit Graph

5 Commits

Author SHA1 Message Date
Stephen Finucane a0380894d0 docs: Strip '.rst' suffix
These are unnecessary noise. Drop them.

Change-Id: I6ce4c78bd53975ae83c10b2e5c3910f23b42dba0
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-11-15 16:37:26 +00:00
Stephen Finucane 92a432fde7 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>
2019-06-20 18:22:34 +01:00
Matt Riedemann d63afbf6c5 Mention size limit on user data in docs
The API reference for the "user_data" parameter to server
create and rebuild mentions the size restriction but the
user docs did not, so this adds that note. While doing this,
several other user-facing docs that mention user data link back
to the overall user-data doc so that we can centralize any
further documentation about that topic in a single location.

Change-Id: Id4a61d58150337e0dec223d4d2741336ed6d5387
Closes-Bug: #1804653
2018-11-30 10:07:08 -05:00
Matt Riedemann 49b1bf8c54 Cleanup launch instance and manage IPs docs
This is a follow up to Ie039322660fd0e2e0403843448379b78114c425b.

A few things are changed here:

* The note about using file injection is removed. File injection
  was deprecated in the API in Queens and not something that we
  really want users using.
* Mention that creating a flavor is typically admin-only.
* Link to the BDM docs for more details about BDM parameter values.
* Update the manage-ip-address docs to make the examples rely on
  using the networking resource CLIs rather than any proxy APIs
  that were available in nova.

Change-Id: Ifa2e2bbb4c5f51f13d1a5832bd7dbf9f690fcad7
2018-02-01 15:12:10 -05:00
Matt Riedemann 4ed5e81ee0 Migrate "launch instance" user guide docs
This imports the "launch instance" end user guide docs from
the openstack-manuals repo. As part of the docs migration
in Pike, these were forgotten. The copied contents come from
the stable/ocata branch of openstack-manuals, and therefore
likely need some updating, but that could be done in follow up
changes. This is an initial import to (1) publish the content
again somewhere and (2) fix broken links in the cinder docs
for booting from volume.

Change-Id: Ie039322660fd0e2e0403843448379b78114c425b
Partial-Bug: #1714017
Related-Bug: #1711267
2018-02-01 14:28:18 -05:00