cinder/doc/source/contributor
imacdonn 74fd810ad1 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
(cherry picked from commit d47486d317)
2018-10-31 19:08:45 +00:00
..
README.rst Fix some typos in cinder doc 2017-12-19 13:47:45 +08:00
addmethod.openstackapi.rst fix wrong url link 2018-01-24 09:36:55 +08:00
api.apache.rst Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
api_conditional_updates.rst Fix the typo in api_conditional_updates.rst 2018-01-31 19:50:36 +08:00
api_microversion_dev.rst Move MV history under API Microversion contrib docs 2018-04-10 20:34:13 +08:00
api_microversion_history.rst Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
architecture.rst Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
attach_detach_conventions.rst Replace Chinese punctuation with English punctuation 2018-05-02 17:55:09 +08:00
attach_detach_conventions_v2.rst Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
development.environment.rst Merge "Update macOS devref info" 2018-06-15 17:19:24 +00:00
documentation.rst Fix some typos in cinder doc 2017-12-19 13:47:45 +08:00
drivers.rst Make scheduler check online_extend_support capability 2018-06-26 14:42:34 -03:00
drivers_locking_examples.rst docs: Write high availability devref 2018-08-01 14:46:42 -05:00
gerrit.rst Use sphinxcontrib.apidoc for module docs 2018-04-05 14:36:03 -05:00
gmr.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
groups.rst cinder-manage online_data_migrations fixes 2018-10-31 19:08:45 +00:00
high_availability.rst docs: Write high availability devref 2018-08-01 14:46:42 -05:00
i18n.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
index.rst docs: Write high availability devref 2018-08-01 14:46:42 -05:00
jenkins.rst [doc]Modify failed hyperlinks 2018-06-12 08:51:49 +08:00
launchpad.rst [doc]Modify failed hyperlinks 2018-06-12 08:51:49 +08:00
migration.rst Replace Chinese punctuation with English punctuation 2018-05-02 17:55:09 +08:00
releasenotes.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
replication.rst Fix some typos in cinder doc 2017-12-19 13:47:45 +08:00
rolling.upgrades.rst [doc]Modify failed hyperlinks 2018-06-12 08:51:49 +08:00
rpc.rst Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
testing.rst Add contributor notes on how to use pdb with tests 2018-01-23 12:13:29 -05:00
thin_provisioning.rst Updates overprovisioning dev-ref 2018-04-27 15:03:32 -03:00
threading.rst Fix none-ascii char in doc 2018-08-03 10:37:54 +08:00
user_messages.rst [DOC BLD FIX] Fix user messages documentation 2017-08-07 17:59:36 -05:00

README.rst

Cinder Contributor Documentation (source/contributor)

Introduction:

This directory is intended to hold any documentation that relates to how to contribute to Cinder or how the project is managed. Some of this content was previous under 'developer' in openstack-manuals. The content of the documentation, however, goes beyond just developers to anyone contributing to the project, thus the change in naming.

The full spec for organization of documentation may be seen in the OS Manuals Migration Spec <https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html>.