openstack
/
nova
Code Issues Proposed changes

Fix CLI docs for nova-manage api_db commands 

There were a few changes needed here:

1. There is no "API cell database", just the API
   database, so this removes mentions of cells.

2. The VERSION argument was missing from the sync help.

3. The sync command does not create a database, it upgrades
   the schema. Wording for that was borrowed from the
   nova-manage db sync help.

4. Starting in Rocky, the api_db sync command also upgrades
   the schema for the optional placement database if configured
   so that's mentioned here as well.

Change-Id: Ibc49f93b8bd51d9a050acde5ef3dc8aad91321ca
Closes-Bug: #1778733
This commit is contained in:
Matt Riedemann 2018-06-26 10:16:55 -04:00
parent 08a618d0c4
commit 1476b030bd
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/cli/nova-manage.rst
View File

@ -125,11 +125,18 @@ Nova API Database
~~~~~~~~~~~~~~~~~
``nova-manage api_db version``
Print the current cells api database version.
Print the current API database version.
``nova-manage api_db sync``
Sync the api cells database up to the most recent version. This is the
standard way to create the db as well.
``nova-manage api_db sync [VERSION]``
Upgrade the API database schema up to the most recent version or
``[VERSION]`` if specified. This command does not create the API
database, it runs schema migration scripts. The API database connection is
determined by ``[api_database]/connection`` in the configuration file
passed to nova-manage.
Starting in the 18.0.0 Rocky release, this command will also upgrade the
optional placement database if ``[placement_database]/connection`` is
configured.
.. _man-page-cells-v2: