Commit Graph

16 Commits

Author SHA1 Message Date
Stephen Finucane ef9cbc0017 doc: Populate the 'user' section
Per the spec [1]:

  user/ – end-user content such as concept guides, advice, tutorials,
  step-by-step instructions for using the CLI to perform specific tasks,
  etc.

The remaining content all ends up in here.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I480eee9cd7568efe2f76dd185004774588eb4a99
2017-07-18 15:41:20 +01:00
Stephen Finucane be8fa67024 doc: Populate the 'cli' section
Per the spec [1]:

  cli/ – command line tool reference docs, similar to man pages These
  may be automatically generated with cliff's sphinx integration, or
  manually written when auto-generation is not possible.

All of the docs currently found in 'man' fit that category, so those and
those alone are moved. It'll be a great day in the parish when we can
replace all of these with cliff's Sphinx integration.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I45bed324ec37cfea7c1a574ec06af38e7b875a1c
2017-07-13 14:54:11 +01:00
Matt Riedemann e8d8558531 doc: add cells v2 FAQ on mapping instances
This came up in IRC where someone upgraded from newton to
ocata and didn't use the simple_cell_setup command, but they
didn't run the map_instances command. Our cells v2 deploy/upgrade
guide mentions using simple_cell_setup for the minimal scenario
so it wasn't clear that they needed to run map_instances.

The install guide doesn't mention any of this either since this
is about upgrades, and the install guide is focused on fresh installs
where there are no existing instances to map.

Change-Id: Iedf3aabf1508abf59a54071b20a7f1c58b63e32c
2017-05-23 12:55:17 -04:00
Matt Riedemann 7c1018a118 doc: add cells v2 FAQ on refreshing global cells cache
There is a cells cache in the API and in the request context,
which is used in the controller services (api, conductor, and
scheduler), so this adds a FAQ item about needing to restart
those services if you update the db connection or transport url
in a given cell which is already cached.

Change-Id: I56daf87dad9e86f747e945f0842344ddba42b91e
2017-05-23 12:38:52 -04:00
Matt Riedemann 64ed7a2824 doc: start a FAQs section for cells v2
We get random questions about cells v2 in IRC and some of them
are repeats, and some are just good questions which took some
thought to answer, so we should document those so they aren't
lost.

This is the start of a series, so it adds an initial question.

Change-Id: I96005d1b86bb92f71a5cc848afd2d0126dd9071a
2017-05-23 12:24:11 -04:00
Matt Riedemann bc783fe5be doc: add links to summit videos on cells v2
We've had a couple of nice presentations on cells v2
from previous summits. This change links those into the
top-level cells v2 docs in the devref. Note that I
consciously put them before the Manifesto section as
that might be somewhat dated at this point, but it would
also be nice as someone new to watch a presentation before
digging into prose for the details. I also elected to avoid
adding yet a third "References" section to this page since
the other ones are specifically references for install and
upgrade scenarios.

Change-Id: I8e60e018cd103e18dd34c3f9cbdd409ec6550a97
2017-05-23 11:22:17 -04:00
Matt Riedemann 9a5c3cd7da Add release note and update cell install guide for multi-cell limitations
As of change If1e03c9343b8cc9c34bd51c2b4d25acdb21131ff, using
"nova hypervisor-list" before compute hosts are mapped to a cell
will result in an empty list.

Our cells v2 install steps mention using 'nova hypervisor-list' after
creating a cell and starting compute services to tell when to run
the discover_hosts command, but now hypervisor-list won't work until
you've run discover_hosts, so it's a catch-22.

This change adds a release note to let people writing deployment tools
to know about the change in behavior and also updates the install steps
to use service-list instead of hypervisor-list, since service-list does
not require the compute host to be mapped to the cell first.

We are going to need to make a similar change in the OpenStack install
guide since that also mentions using 'nova hypervisor-list' before
discover_hosts.

Change-Id: If2baab40c2e2a3de20e561bba50688d615b002ef
Closes-Bug: #1682060
2017-04-21 10:11:03 -07:00
melanie witt ae3f3c4acc Add Cells V1 -> Cells V2 step-by-step example
This adds an example for: upgrade with Cells V1.

Change-Id: I05c48152eb66148c6f247a71f70f65d2e077bd7d
2017-02-10 19:58:59 +00:00
melanie witt 59f6423549 Edits for Cells V2 step-by-step examples
This addresses comments from the original patch set to add more
detail to the steps.

Change-Id: Ibebef30b499dc9b4c6ce8d43f4d8faf9eb93f809
2017-02-08 21:52:43 +00:00
melanie witt dd198d11f8 Add step-by-step examples for Cells V2 setup
This starts off with two examples: fresh install and minimal upgrade.

Change-Id: Id6a1fe694abc6069b6728434b5400f13f8f24c0e
2017-02-03 20:14:00 +00:00
Matt Riedemann a3563ed37e doc: refer to the cell_v2 man pages from the cells v2 doc
This is just a simple change that provides a references section
for setting up cells v2 and points to the nova-manage cell_v2
man pages.

Change-Id: I94d3de97f4ff2120e250ac40ac82c31372d90a2b
2017-02-01 15:09:50 -05:00
Matt Riedemann 5ba69008b6 Fix and add some notes to the cells v2 first time setup doc
There was a typo in here about the map_cell0 command creating
a db connection with a _nova suffix when it's actually a _cell0
suffix like in the example, nova_cell0.

This also adds a reminder to sync the API database schema before
running the commands and also gives a warning about being
specific when using map_cell0 and having the databases on different
hosts.

Depends-On: I541b072638b5d50985145391e76f610417fdcaa6

Change-Id: Ibf3355217bbd0139a020de352bb62ff7d973d27b
2017-01-23 11:49:07 +00:00
Dan Smith db79c53090 Add some cellsv2 setup docs
Change-Id: If0d4e435a5c687492d7d820031a3a0261e29d2ee
2017-01-16 17:03:10 -05:00
Matt Riedemann 409085a8c0 docs: link to Laski's cells talk from the Austin summit
Andrew Laski gave a nice presentation at the Austin Newton summit
of cells v1 and v2, along with work complete and what's being
worked on. This fits nicely into our documentation on cells and is
good to watch before reading further in detail.

Change-Id: I4c0245c000bb74c159fc02c36a83a11f145208a3
2016-05-02 12:23:08 -04:00
Matt Riedemann 79f052ac15 Document restrictions for working on cells v1
Since the 2015/11/12 nova meeting we've said that cells v1 is in feature
freeze and we won't focus on hard-to-fix latent bugs. We should include that
information in the devref so it's treated as a policy.

Change-Id: I31186463fd832c27accc05feb82713fe71f603a8
2016-01-05 06:54:46 -08:00
Joe Gordon a1e8fc6dd9 Update docs layout
* Explain these docs are for trunk (copied from ironic)
* All the docs in this repo are meant to be developer docs, so having a
  devref inside of the docs is redundant and just makes the docs more
  complicated to navigate. Move everything out of the devref folder and
  link to everything from main index.
* Move man pages into separate section. The man pages are pretty sparse
* right now, we should either make them useful or just delete them
* Remove dead docs from unused_docs list in doc/source/conf.py
* Shuffle docs landing page, move common referees to the top (API,
  hypervisor support matrix), Add a introduction section and more. The
  hope is the updated layout makes this document easier to navigate.
* Use maxdepth of 1
* Rename a few sections with what are hopefully better names

The next step is to prune out outdated documents and further cleanup
this page.

Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-15 10:47:18 -07:00