5 Commits

Author SHA1 Message Date
Andreas Jaeger
99ec31f53f Docs: Make links more robust
Some docs used external links which cannot be verified and thus we
easily might get broken links. Use internal links that Sphinx can verify.

Some additional updates:
* Update tox.ini to not publish the dirtrees.
* Update openstack mailing list to openstack-discuss
* Remove reference to not anymore existing 'OpenStack Configuration
  Reference'

Change-Id: I9a613fa682021fab7bbaba90b219adaa7d9384d3
2019-08-10 10:49:23 +02:00
Xing Zhang
5ead630429
Fix cinder-manage args --max_count in docs
--max_count was added in [0]

[0] https://review.openstack.org/#/c/330391/

Change-Id: If3780b4ec799ff244f02182b636a7afe4037445b
2019-04-12 16:06:04 +08:00
Sean McGinnis
d5b539be36
Doc8: Stop skipping D001: Line too long
This cleans up the cases where we had D001 violations so we can stop
skipping that check in doc8 runs.

Change-Id: Ie52f6ecac1a645fcbcc643b9ca63e033b622d830
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-02-19 16:51:56 -06:00
imacdonn
d47486d317 cinder-manage online_data_migrations fixes
Addresses some issues with this command:

1) When used without the --max-count option, the summary table will
   always show zero migrations run, because it only accounts for the
   last batch, and the loop only exits when the last batch does no work.

2) "remaining" counts cannot be accurate, given the way migrations are
   implemented, because the "found" count refers to the number of rows
   that exist in the database, not the number that still need the
   migration applied.

3) In the case where no migrations are successful, but some raise
   exceptions, the command was exiting with status zero, which usually
   indicates "success". This can cause issues that cause migration
   failures to go unnoticed, especially when automated.

4) When exceptions do occur, a minimally useful message is output, and
   no detail about the exception is available to the user. The exception
   detail should be logged.

5) Inaccuracies in the documentation - "--max_number" should be
   "--max-count", and stale references to the "--ignore_state" option,
   which was removed in [1]

The solution for (3) introduces a new exit status, 2. See release note
for details.

These changes are aligned with equivalents [2][3] for the nova-manage
command, except for the calculation of "Total Needed" - nova seems to
interpret the "found" count differently/inconsistently.

[1] https://review.openstack.org/510201
[2] https://review.openstack.org/605828
[3] https://review.openstack.org/608091

Change-Id: I878480eb2359625cde839b073230844acc645cba
Closes-Bug: #1794364
Closes-Bug: #1796192
2018-10-17 23:22:48 +00:00
Matt Riedemann
0ff0cbf74a Move cinder-manage page to cli doc subtree
Since we have a CLI reference and specific doc subtree the
cinder-manage docs should live there. This moves the cinder-manage
page from man/ to cli/ and adds a redirect link.

Change-Id: If99416e8a382d2a6571412742276dccc591d180c
2018-10-16 10:13:30 -04:00