openstack/openstack-manuals
Code Issues Proposed changes

Regenerated the trove-manage CLI file

Browse Source 
New commands are now available for the trove-manage utility.
They are:

datastore_version_flavor_add
datastore_version_flavor_delete
db_load_datastore_config_parameters

The CLI xml file was regenerated to reflect the new commands.

Change-Id: I9b46c12f556888f1a25029c14d04ced583d7d98b
This commit is contained in:
Peter Stachowski 2015-10-03 15:43:20 +00:00
parent 046de3d84b
commit c04ca4c119
1 changed files with 165 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

189
doc/cli-reference/generated/ch_cli_trove-manage_commands.xml
View File

@ -9,11 +9,15 @@
<?dbhtml stop-chunking?>
<title>Database Service Management command-line client</title>
<para>The <command>trove-manage</command> client is the command-line interface
(CLI) for the Database Management Utility and its extensions. This chapter documents
<command>trove-manage</command> version 2014.2.
<title>Database service management command-line client</title>
<para>The <command>trove-manage</command> client is the command-line
interface (CLI) for the Database Management Utility API and its extensions.
This chapter documents <command>trove-manage</command> version
<literal>4.0.0</literal>.
</para>
<para>For help on a specific <command>trove-manage</command>
command, enter:
</para>
@ -28,8 +32,7 @@
[--nouse-syslog-rfc-format] [--noverbose]
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog]
[--use-syslog-rfc-format] [--verbose] [--version]
{db_sync,db_upgrade,db_downgrade,datastore_update,datastore_version_update,db_recreate}
{db_sync,db_upgrade,db_downgrade,datastore_update,datastore_version_update,db_recreate,db_load_datastore_config_parameters,datastore_version_flavor_add,datastore_version_flavor_delete}
...</computeroutput></screen>
</section>
<section xml:id="trove-manageclient_command_optional">
@ -71,7 +74,7 @@
<listitem>
<para>
Print debugging output (set logging level to DEBUG
instead of default WARNING level).
instead of default INFO level).
</para>
</listitem>
</varlistentry>
@ -170,8 +173,7 @@
<listitem>
<para>
Use syslog for logging. Existing syslog format is
<emphasis>DEPRECATED</emphasis> during I, and will change in J to honor
RFC5424.
<emphasis>DEPRECATED</emphasis> and will be changed later to honor RFC5424.
</para>
</listitem>
</varlistentry>
@ -182,8 +184,8 @@
(Optional) Enables or disables syslog rfc5424 format
for logging. If enabled, prefixes the MSG part of the
syslog message with APP-NAME (RFC5424). The format
without the APP-NAME is deprecated in I, and will be
removed in J.
without the APP-NAME is deprecated in Kilo, and will
be removed in Mitaka, along with this option.
</para>
</listitem>
</varlistentry>
@ -191,8 +193,8 @@
<term><command>--verbose, -v</command></term>
<listitem>
<para>
Print more verbose output (set logging level to INFO
instead of default WARNING level).
If set to false, will disable INFO logging level,
making WARNING the default.
</para>
</listitem>
</varlistentry>
@ -207,7 +209,7 @@
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_datastore_update">
<title>trove-manage datastore_update command</title>
<title>trove-manage datastore_update</title>
<screen><computeroutput>usage: trove-manage datastore_update [-h] datastore_name default_version</computeroutput></screen>
<para>
Add or update a datastore. If the datastore already exists, the default
@ -242,10 +244,103 @@ version will be updated.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_datastore_version_flavor_add">
<title>trove-manage datastore_version_flavor_add</title>
<screen><computeroutput>usage: trove-manage datastore_version_flavor_add [-h]
datastore_name
datastore_version_name
flavor_ids</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>datastore_name</command></term>
<listitem>
<para>
Name of the datastore.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>datastore_version_name</command></term>
<listitem>
<para>
Name of the datastore version.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>flavor_ids</command></term>
<listitem>
<para>
Comma separated list of flavor ids.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_datastore_version_flavor_delete">
<title>trove-manage datastore_version_flavor_delete</title>
<screen><computeroutput>usage: trove-manage datastore_version_flavor_delete [-h]
datastore_name
datastore_version_name
flavor_id</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>datastore_name</command></term>
<listitem>
<para>
Name of the datastore.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>datastore_version_name</command></term>
<listitem>
<para>
Name of the datastore version.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>flavor_id</command></term>
<listitem>
<para>
The flavor to be deleted for a given datastore and
datastore version.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_datastore_version_update">
<title>trove-manage datastore_version_update command</title>
<title>trove-manage datastore_version_update</title>
<screen><computeroutput>usage: trove-manage datastore_version_update [-h]
datastore version_name manager
image_id packages active</computeroutput></screen>
@ -320,7 +415,7 @@ all values except the datastore name and version will be updated.
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_db_downgrade">
<title>trove-manage db_downgrade command</title>
<title>trove-manage db_downgrade</title>
<screen><computeroutput>usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version</computeroutput></screen>
<para>
Downgrade the database to the specified version.
@ -355,18 +450,39 @@ Downgrade the database to the specified version.
</varlistentry>
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_db_recreate">
<title>trove-manage db_recreate command</title>
<screen><computeroutput>usage: trove-manage db_recreate [-h] repo_path</computeroutput></screen>
<section xml:id="trove-manageclient_subcommand_db_load_datastore_config_parameters">
<title>trove-manage db_load_datastore_config_parameters</title>
<screen><computeroutput>usage: trove-manage db_load_datastore_config_parameters [-h]
datastore
datastore_version
config_file_location</computeroutput></screen>
<para>
Drop the database and recreate it.
Loads configuration group parameter validation rules for a datastore version
into the database.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>repo_path</command></term>
<term><command>datastore</command></term>
<listitem>
<para>
SQLAlchemy Migrate repository path.
Name of the datastore.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>datastore_version</command></term>
<listitem>
<para>
Name of the datastore version.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>config_file_location</command></term>
<listitem>
<para>
Fully qualified file path to the configuration group
parameter validation rules.
</para>
</listitem>
</varlistentry>
@ -381,10 +497,35 @@ Drop the database and recreate it.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_db_recreate">
<title>trove-manage db_recreate</title>
<screen><computeroutput>usage: trove-manage db_recreate [-h] [--repo_path REPO_PATH]</computeroutput></screen>
<para>
Drop the database and recreate it.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--repo_path REPO_PATH</command></term>
<listitem>
<para>
SQLAlchemy Migrate repository path.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_db_sync">
<title>trove-manage db_sync command</title>
<title>trove-manage db_sync</title>
<screen><computeroutput>usage: trove-manage db_sync [-h] [--repo_path REPO_PATH]</computeroutput></screen>
<para>
Populate the database structure
@ -409,7 +550,7 @@ Populate the database structure
</variablelist>
</section>
<section xml:id="trove-manageclient_subcommand_db_upgrade">
<title>trove-manage db_upgrade command</title>
<title>trove-manage db_upgrade</title>
<screen><computeroutput>usage: trove-manage db_upgrade [-h] [--version VERSION]
[--repo_path REPO_PATH]</computeroutput></screen>
<para>