Added documentation for trove-manage
No documentation was being generated for the trove-manage CLI of the database project. Since *-manage CLIs are now supported by the openstack-auto-commands tool, this has been added to the CLI reference manual. A current version of the trove-manage .xml file is included. Change-Id: Ib8457a3c93b8c9acda8225c5795dc626485d64c4 Closes-Bug: #1338798
This commit is contained in:
Peter Stachowski
parent
8678e34caf
commit
9681fcfc58
@ -89,5 +89,6 @@
|
||||
<xi:include href="../common/ch_cli_heat_commands.xml"/>
|
||||
<xi:include href="../common/ch_cli_ceilometer_commands.xml"/>
|
||||
<xi:include href="../common/ch_cli_trove_commands.xml"/>
|
||||
<xi:include href="../common/ch_cli_trove-manage_commands.xml"/>
|
||||
<xi:include href="../common/app_support.xml"/>
|
||||
</book>
|
||||
|
||||
445
doc/common/ch_cli_trove-manage_commands.xml
Normal file
445
doc/common/ch_cli_trove-manage_commands.xml
Normal file
@ -0,0 +1,445 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
version="5.0"
|
||||
xml:id="trove-manageclient_commands">
|
||||
|
||||
<!-- This file is automatically generated, do not edit -->
|
||||
|
||||
<?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.
|
||||
</para>
|
||||
<para>For help on a specific <command>trove-manage</command>
|
||||
command, enter:
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput><command>trove-manage</command> <replaceable>COMMAND</replaceable> <option>--help</option></userinput></screen>
|
||||
|
||||
<section xml:id="trove-manageclient_command_usage">
|
||||
<title>trove-manage usage</title>
|
||||
<screen><computeroutput>usage: trove-manage [-h] [--config-dir DIR] [--config-file PATH] [--debug]
|
||||
[--log-config-append PATH] [--log-date-format DATE_FORMAT]
|
||||
[--log-dir LOG_DIR] [--log-file PATH]
|
||||
[--log-format FORMAT] [--nodebug] [--nouse-syslog]
|
||||
[--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}
|
||||
...</computeroutput></screen>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_command_optional">
|
||||
<title>trove-manage optional arguments</title>
|
||||
<variablelist wordsize="10">
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--config-dir DIR</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to a config directory to pull *.conf files from.
|
||||
This file set is sorted, so as to provide a
|
||||
predictable parse order if individual options are
|
||||
over-ridden. The set is parsed after the file(s)
|
||||
specified via previous --config-file, arguments hence
|
||||
over-ridden options in the directory take precedence.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--config-file PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to a config file to use. Multiple config files
|
||||
can be specified, with values in later files taking
|
||||
precedence. The default files used are: None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--debug, -d</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print debugging output (set logging level to DEBUG
|
||||
instead of default WARNING level).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-config-append PATH, --log_config PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of a logging configuration file. This file is
|
||||
appended to any existing logging configuration files.
|
||||
For details about logging configuration files, see the
|
||||
Python logging module documentation.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-date-format DATE_FORMAT</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Format string for %(asctime)s in log records. Default:
|
||||
None .
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-dir LOG_DIR, --logdir LOG_DIR</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
(Optional) The base directory used for relative --log-
|
||||
file paths.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-file PATH, --logfile PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
(Optional) Name of log file to output to. If no
|
||||
default is set, logging will go to stdout.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-format FORMAT</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<emphasis>DEPRECATED</emphasis>. A logging.Formatter log message format
|
||||
string which may use any of the available
|
||||
logging.LogRecord attributes. This option is
|
||||
deprecated. Please use logging_context_format_string
|
||||
and logging_default_format_string instead.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nodebug</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The inverse of --debug
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nouse-syslog</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The inverse of --use-syslog
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nouse-syslog-rfc-format</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The inverse of --use-syslog-rfc-format
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noverbose</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The inverse of --verbose
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--syslog-log-facility SYSLOG_LOG_FACILITY</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Syslog facility to receive log lines.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--use-syslog</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Use syslog for logging. Existing syslog format is
|
||||
<emphasis>DEPRECATED</emphasis> during I, and will change in J to honor
|
||||
RFC5424.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--use-syslog-rfc-format</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
(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.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--verbose, -v</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print more verbose output (set logging level to INFO
|
||||
instead of default WARNING level).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show program's version number and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_datastore_update">
|
||||
<title>trove-manage datastore_update command</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
|
||||
version will be updated.
|
||||
</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>default_version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of an existing datastore version to set as the
|
||||
default. When adding a new datastore, use an empty string.
|
||||
</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>
|
||||
<screen><computeroutput>usage: trove-manage datastore_version_update [-h]
|
||||
datastore version_name manager
|
||||
image_id packages active</computeroutput></screen>
|
||||
<para>
|
||||
Add or update a datastore version. If the datastore version already exists,
|
||||
all values except the datastore name and version will be updated.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>datastore</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>version_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>manager</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the manager that will administer the datastore
|
||||
version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>image_id</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of the image used to create an instance of the datastore
|
||||
version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>packages</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Packages required by the datastore version that are installed
|
||||
on the guest image.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>active</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Whether the datastore version is active or not. Accepted
|
||||
values are 0 and 1.
|
||||
</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_db_downgrade">
|
||||
<title>trove-manage db_downgrade command</title>
|
||||
<screen><computeroutput>usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version</computeroutput></screen>
|
||||
<para>
|
||||
Downgrade the database to the specified version.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Target 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>
|
||||
<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_recreate">
|
||||
<title>trove-manage db_recreate command</title>
|
||||
<screen><computeroutput>usage: trove-manage db_recreate [-h] repo_path</computeroutput></screen>
|
||||
<para>
|
||||
Drop the database and recreate it.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>repo_path</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
SQLAlchemy Migrate repository path.
|
||||
</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_db_sync">
|
||||
<title>trove-manage db_sync command</title>
|
||||
<screen><computeroutput>usage: trove-manage db_sync [-h] [--repo_path REPO_PATH]</computeroutput></screen>
|
||||
<para>
|
||||
Populate the database structure
|
||||
</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_upgrade">
|
||||
<title>trove-manage db_upgrade command</title>
|
||||
<screen><computeroutput>usage: trove-manage db_upgrade [-h] [--version VERSION]
|
||||
[--repo_path REPO_PATH]</computeroutput></screen>
|
||||
<para>
|
||||
Upgrade the database to the specified version.
|
||||
</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>--version VERSION</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Target version. Defaults to the latest version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repo_path REPO_PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
SQLAlchemy Migrate repository path.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
</chapter>
|
||||
Loading…
Reference in New Issue
Block a user