Commit Graph

12 Commits

Author SHA1 Message Date
Stephen Finucane 3a6e1e2396 doc: Rework man pages
Rework the man pages by:

- Wording the synopsis sections similarly for all commands
- Not using upper-case section names, as this is unnecessary and results
  in worse HTML output
- Formatting code and file names as literals

The 'nova-idmapshift' man page is excluded as this utility will be
removed shortly.

Change-Id: I67914a757f9436461960a8d6b92d157f59ccad66
2017-10-09 16:08:40 +01:00
Takashi NATSUME 48eb371e62 Fix inconsistency of 'NOTE:' description
Use the 'note' directive.

TrivialFix
Change-Id: If342940f8cc64591778ad21ce6cccbe006c0145b
2017-09-28 16:28:49 +09:00
Dan Smith 8f8982d8ef Add nova-manage db command for ironic flavor migrations
This adds `nova-manage db ironic_flavor_migration` which allows
pushing the migrations ahead of time, and without ironic or nova
services running.

This is a similar operation to online_data_migrations, but there is
a need to pass data that would normally be retrieved from ironic.
However, we want this to work offline and thus that data must be
provided locally. When fast-forwarding through the pike release,
ironic and nova-compute will never be started and thus we can't rely
on the online nature of the migration integrated into the ironic
driver.

Change-Id: I459bce472227ee08230d3120d9e2eb1bde635218
2017-09-15 00:30:23 -04:00
Andreas Jaeger 4e6eec5c9b Fix broken URLs
Fix broken nova URLs that linked to the old developer/nova places and
use the new link instead.

Change-Id: Ideb50626e140201dded19fc82584440f1a407e47
2017-09-07 15:42:31 +02:00
wanghongtaozz f44935b7d2 spelling mistake
Change-Id: I478de51257b8133c2e3ef52e93d53a2818496f56
2017-09-06 03:46:38 -07:00
Jenkins a85ec5e53f Merge "add online_data_migrations to nova docs" 2017-09-01 16:45:47 +00:00
Hesam Chobanlou 9e1e1a52de add online_data_migrations to nova docs
adding cli documentation for online_data_migrations to clarify
when the command is complete.

Closes-Bug: #1670738

Change-Id: If50bd044091250611a7d3d67438d732279510d5b
2017-09-01 15:43:00 +00:00
Sean Dague 7e693e9c5c Clean up *most* ec2 / euca2ools references
The ec2 / euca2ools command references definitely don't work any more,
this deletes most of them. The exception is the policy reference doc
which is over a year out of date, and needs more then surgical removal
of ec2 from it.

Change-Id: I963170f99037d5ed085e8c676ab55750c7f6372e
2017-08-09 11:20:12 -04:00
Sean Dague 104efa6fb6 Structure cli page
The cli page was just a straight list of cli links. This groups them
by function with a preamble to make it more clear why you'd want to go
look at any particular ones.

Part of bp: doc-migration

Change-Id: Iecf99e173be3c3d5a2d5dd758c09f79d443729b9
2017-08-09 11:20:12 -04:00
Matt Riedemann 3414ab14ca Deprecate cells v1
With multi-cell support in Pike, we should deprecate cells v1
so we can at least start the deprecation signaling in the
docs and release notes. We may not end up removing cells v1
code in Queens, but this at least gives us the option.

Note that we also want to do this because nova-network cannot
be removed until we remove cells v1.

Change-Id: I1a173f7ce0715e684850e030c358e8175fa8724c
2017-08-01 11:07:55 -04:00
Dan Smith f2606322f7 Deprecate useless quota_usage_refresh from nova-manage
Since we no longer use usage records, we don't need the nova-manage
command to sync usage records with actual resource consumption.

Co-Authored-By: melanie witt <melwittt@gmail.com>

Part of blueprint cells-count-resources-to-check-quota-in-api

Change-Id: I55f7a2b6e15eec6e6ec97be23903325ad22bd4d4
2017-07-19 19:33:23 +00: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