openstack/openstack-manuals
Code Issues Proposed changes

Update Trove CLI doc to version 1.3.0

Browse Source 
Trove recently release version 1.3.0 of the python client:
https://pypi.python.org/pypi/python-troveclient

The CLI documention has been updated to reflect the new release.

Change-Id: I41f31057ecc4756cf2845d9eee96d7ccea3886ff
Closes-Bug: #1496576
This commit is contained in:
Peter Stachowski 2015-09-16 20:43:14 +00:00
parent c0ca3c53c3
commit 38323fb21b
1 changed files with 157 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

202
doc/cli-reference/generated/ch_cli_trove_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the Database API and its extensions.
This chapter documents <command>trove</command> version
<literal>1.2.0</literal>.
<literal>1.3.0</literal>.
</para>
<para>For help on a specific <command>trove</command>
@ -31,7 +31,7 @@
[--database-service-name &lt;database-service-name&gt;]
[--endpoint-type &lt;endpoint-type&gt;]
[--os-database-api-version &lt;database-api-ver&gt;]
[--retries &lt;retries&gt;] [--json] [--insecure]
[--retries &lt;retries&gt;] [--json] [--profile HMAC_KEY] [--insecure]
[--os-cacert &lt;ca-certificate&gt;] [--os-cert &lt;certificate&gt;]
[--os-key &lt;key&gt;] [--timeout &lt;seconds&gt;]
[--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
@ -113,6 +113,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-grow</command></term>
<listitem>
<para>
Adds more instances to a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-instances</command></term>
<listitem>
@ -137,6 +145,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-shrink</command></term>
<listitem>
<para>
Drops instances from a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-attach</command></term>
<listitem>
@ -419,15 +435,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>resize-flavor</command></term>
<listitem>
<para>
[<emphasis>DEPRECATED</emphasis>] Please use resize-instance
instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>resize-instance</command></term>
<listitem>
@ -466,7 +473,7 @@
<listitem>
<para>
Gets status if root was ever enabled for an
instance.
instance or cluster.
</para>
</listitem>
</varlistentry>
@ -706,6 +713,22 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--profile HMAC_KEY HMAC</command></term>
<listitem>
<para>
key used to encrypt context data when
profiling the performance of an operation.
This key should be set to one of the HMAC
keys configured in Trove (they are found in
api-paste.ini, typically in /etc/trove).
Without the key, profiling will not be
triggered even if it is enabled on the
server side. Defaults to
<code>env[OS_PROFILE_HMACKEY]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--insecure</command></term>
<listitem>
@ -1003,7 +1026,8 @@ Deletes a backup.
</section>
<section xml:id="troveclient_subcommand_backup-list">
<title>trove backup-list</title>
<screen><computeroutput>usage: trove backup-list [--limit &lt;limit&gt;] [--datastore &lt;datastore&gt;]</computeroutput></screen>
<screen><computeroutput>usage: trove backup-list [--limit &lt;limit&gt;] [--marker &lt;ID&gt;]
[--datastore &lt;datastore&gt;]</computeroutput></screen>
<para>
Lists available backups.
</para> <variablelist wordsize="10">
@ -1016,6 +1040,16 @@ Lists available backups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;ID&gt;</command></term>
<listitem>
<para>
Begin displaying the results for IDs greater than
the specified marker. When used with --limit, set
this to the last ID displayed in the previous run.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--datastore &lt;datastore&gt;</command></term>
<listitem>
@ -1028,7 +1062,7 @@ Lists available backups.
</section>
<section xml:id="troveclient_subcommand_backup-list-instance">
<title>trove backup-list-instance</title>
<screen><computeroutput>usage: trove backup-list-instance [--limit &lt;limit&gt;] &lt;instance&gt;</computeroutput></screen>
<screen><computeroutput>usage: trove backup-list-instance [--limit &lt;limit&gt;] [--marker &lt;ID&gt;] &lt;instance&gt;</computeroutput></screen>
<para>
Lists available backups for an instance.
</para> <variablelist wordsize="10">
@ -1052,6 +1086,16 @@ Lists available backups for an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;ID&gt;</command></term>
<listitem>
<para>
Begin displaying the results for IDs greater than the
specified marker. When used with --limit, set this to the
last ID displayed in the previous run.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_backup-show">
@ -1074,7 +1118,7 @@ Shows details of a backup.
<section xml:id="troveclient_subcommand_cluster-create">
<title>trove cluster-create</title>
<screen><computeroutput>usage: trove cluster-create &lt;name&gt; &lt;datastore&gt; &lt;datastore_version&gt;
[--instance &lt;flavor_id=flavor_id,volume=volume&gt;]</computeroutput></screen>
[--instance &lt;flavor=flavor_name_or_id,volume=volume&gt;]</computeroutput></screen>
<para>
Creates a new cluster.
</para> <variablelist wordsize="10">
@ -1107,7 +1151,7 @@ Creates a new cluster.
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--instance &lt;flavor_id=flavor_id,volume=volume&gt;</command></term>
<term><command>--instance &lt;flavor=flavor_name_or_id,volume=volume&gt;</command></term>
<listitem>
<para>
Create an instance for the cluster. Specify
@ -1128,7 +1172,37 @@ Deletes a cluster.
<term><command>&lt;cluster&gt;</command></term>
<listitem>
<para>
ID of the cluster.
ID or name of the cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_cluster-grow">
<title>trove cluster-grow</title>
<screen><computeroutput>usage: trove cluster-grow &lt;cluster&gt;
[--instance &lt;name=name,flavor=flavor_name_or_id,volume=volume&gt;]</computeroutput></screen>
<para>
Adds more instances to a cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cluster&gt;</command></term>
<listitem>
<para>
ID or name of the cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--instance &lt;name=name,flavor=flavor_name_or_id,volume=volume&gt;</command></term>
<listitem>
<para>
Add an instance to the cluster. Specify
multiple times to create multiple instances.
</para>
</listitem>
</varlistentry>
@ -1193,6 +1267,32 @@ Shows details of a cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_cluster-shrink">
<title>trove cluster-shrink</title>
<screen><computeroutput>usage: trove cluster-shrink &lt;cluster&gt; &lt;instance&gt; [&lt;instance&gt; ...]</computeroutput></screen>
<para>
Drops instances from a cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cluster&gt;</command></term>
<listitem>
<para>
ID or name of the cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
Drop instance(s) from the cluster. Specify multiple ids to drop
multiple instances.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-attach">
@ -1517,7 +1617,7 @@ Updates a configuration group.
</section>
<section xml:id="troveclient_subcommand_create">
<title>trove create</title>
<screen><computeroutput>usage: trove create &lt;name&gt; &lt;flavor_id&gt;
<screen><computeroutput>usage: trove create &lt;name&gt; &lt;flavor&gt;
[--size &lt;size&gt;]
[--databases &lt;databases&gt; [&lt;databases&gt; ...]]
[--users &lt;users&gt; [&lt;users&gt; ...]] [--backup &lt;backup&gt;]
@ -1540,10 +1640,10 @@ Creates a new instance.
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;flavor_id&gt;</command></term>
<term><command>&lt;flavor&gt;</command></term>
<listitem>
<para>
Flavor of the instance.
Flavor ID or name of the instance.
</para>
</listitem>
</varlistentry>
@ -1959,7 +2059,7 @@ Creates metadata in the database for instance &lt;id&gt;.
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance
UUID for instance.
</para>
</listitem>
</varlistentry>
@ -1967,7 +2067,7 @@ Creates metadata in the database for instance &lt;id&gt;.
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Key for assignment
Key for assignment.
</para>
</listitem>
</varlistentry>
@ -1975,7 +2075,7 @@ Creates metadata in the database for instance &lt;id&gt;.
<term><command>&lt;value&gt;</command></term>
<listitem>
<para>
Value to assign to &lt;key&gt;
Value to assign to &lt;key&gt;.
</para>
</listitem>
</varlistentry>
@ -1992,7 +2092,7 @@ Deletes metadata for instance &lt;id&gt;.
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance
UUID for instance.
</para>
</listitem>
</varlistentry>
@ -2000,7 +2100,7 @@ Deletes metadata for instance &lt;id&gt;.
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Metadata key to delete
Metadata key to delete.
</para>
</listitem>
</varlistentry>
@ -2017,7 +2117,7 @@ Replaces metadata value with a new one, this is non-destructive.
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance
UUID for instance.
</para>
</listitem>
</varlistentry>
@ -2025,7 +2125,7 @@ Replaces metadata value with a new one, this is non-destructive.
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Key to replace
Key to replace.
</para>
</listitem>
</varlistentry>
@ -2033,7 +2133,7 @@ Replaces metadata value with a new one, this is non-destructive.
<term><command>&lt;value&gt;</command></term>
<listitem>
<para>
New value to assign to &lt;key&gt;
New value to assign to &lt;key&gt;.
</para>
</listitem>
</varlistentry>
@ -2050,7 +2150,7 @@ Shows all metadata for instance &lt;id&gt;.
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance
UUID for instance.
</para>
</listitem>
</varlistentry>
@ -2067,7 +2167,7 @@ Shows metadata entry for key &lt;key&gt; and instance &lt;id&gt;.
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance
UUID for instance.
</para>
</listitem>
</varlistentry>
@ -2075,7 +2175,7 @@ Shows metadata entry for key &lt;key&gt; and instance &lt;id&gt;.
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
key to display
Key to display.
</para>
</listitem>
</varlistentry>
@ -2092,7 +2192,7 @@ Updates metadata, this is destructive.
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance
UUID for instance.
</para>
</listitem>
</varlistentry>
@ -2100,7 +2200,7 @@ Updates metadata, this is destructive.
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Key to update
Key to update.
</para>
</listitem>
</varlistentry>
@ -2108,7 +2208,7 @@ Updates metadata, this is destructive.
<term><command>&lt;newkey&gt;</command></term>
<listitem>
<para>
New key
New key.
</para>
</listitem>
</varlistentry>
@ -2116,7 +2216,7 @@ Updates metadata, this is destructive.
<term><command>&lt;value&gt;</command></term>
<listitem>
<para>
Value to assign to &lt;newkey&gt;
Value to assign to &lt;newkey&gt;.
</para>
</listitem>
</varlistentry>
@ -2141,7 +2241,7 @@ Promotes a replica to be the new replica source of its set.
</section>
<section xml:id="troveclient_subcommand_resize-instance">
<title>trove resize-instance</title>
<screen><computeroutput>usage: trove resize-instance &lt;instance&gt; &lt;flavor_id&gt;</computeroutput></screen>
<screen><computeroutput>usage: trove resize-instance &lt;instance&gt; &lt;flavor&gt;</computeroutput></screen>
<para>
Resizes an instance with a new flavor.
</para> <variablelist wordsize="10">
@ -2155,7 +2255,7 @@ Resizes an instance with a new flavor.
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;flavor_id&gt;</command></term>
<term><command>&lt;flavor&gt;</command></term>
<listitem>
<para>
New flavor of the instance.
@ -2208,16 +2308,28 @@ Restarts an instance.
</section>
<section xml:id="troveclient_subcommand_root-enable">
<title>trove root-enable</title>
<screen><computeroutput>usage: trove root-enable &lt;instance&gt;</computeroutput></screen>
<screen><computeroutput>usage: trove root-enable &lt;instance_or_cluster&gt;
[--root_password &lt;root_password&gt;]</computeroutput></screen>
<para>
Enables root for an instance and resets if already exists.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<term><command>&lt;instance_or_cluster&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
ID or name of the instance or cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--root_password &lt;root_password&gt;</command></term>
<listitem>
<para>
Root password to set.
</para>
</listitem>
</varlistentry>
@ -2225,16 +2337,16 @@ Enables root for an instance and resets if already exists.
</section>
<section xml:id="troveclient_subcommand_root-show">
<title>trove root-show</title>
<screen><computeroutput>usage: trove root-show &lt;instance&gt;</computeroutput></screen>
<screen><computeroutput>usage: trove root-show &lt;instance_or_cluster&gt;</computeroutput></screen>
<para>
Gets status if root was ever enabled for an instance.
Gets status if root was ever enabled for an instance or cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<term><command>&lt;instance_or_cluster&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
ID or name of the instance or cluster.
</para>
</listitem>
</varlistentry>
@ -2317,7 +2429,7 @@ Shows details of a security group.
<term><command>&lt;security_group&gt;</command></term>
<listitem>
<para>
Security group ID
Security group ID.
</para>
</listitem>
</varlistentry>