From 1476b030bd53deddd85468c0d8b545d8f8f30f19 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Tue, 26 Jun 2018 10:16:55 -0400 Subject: [PATCH] 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 --- doc/source/cli/nova-manage.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/source/cli/nova-manage.rst b/doc/source/cli/nova-manage.rst index e22fc95ceb62..bf6dbaaff8de 100644 --- a/doc/source/cli/nova-manage.rst +++ b/doc/source/cli/nova-manage.rst @@ -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: