diff --git a/doc/cli-reference/generated/ch_cli_trove_commands.xml b/doc/cli-reference/generated/ch_cli_trove_commands.xml index 293fa1d3e6..b6795432a5 100644 --- a/doc/cli-reference/generated/ch_cli_trove_commands.xml +++ b/doc/cli-reference/generated/ch_cli_trove_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Database API and its extensions. This chapter documents trove version - 1.2.0. + 1.3.0. For help on a specific trove @@ -31,7 +31,7 @@ [--database-service-name <database-service-name>] [--endpoint-type <endpoint-type>] [--os-database-api-version <database-api-ver>] - [--retries <retries>] [--json] [--insecure] + [--retries <retries>] [--json] [--profile HMAC_KEY] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] @@ -113,6 +113,14 @@ + + cluster-grow + + + Adds more instances to a cluster. + + + cluster-instances @@ -137,6 +145,14 @@ + + cluster-shrink + + + Drops instances from a cluster. + + + configuration-attach @@ -419,15 +435,6 @@ - - resize-flavor - - - [DEPRECATED] Please use resize-instance - instead. - - - resize-instance @@ -466,7 +473,7 @@ Gets status if root was ever enabled for an - instance. + instance or cluster. @@ -706,6 +713,22 @@ + + --profile HMAC_KEY HMAC + + + 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 + env[OS_PROFILE_HMACKEY]. + + + --insecure @@ -1003,7 +1026,8 @@ Deletes a backup.
trove backup-list - usage: trove backup-list [--limit <limit>] [--datastore <datastore>] + usage: trove backup-list [--limit <limit>] [--marker <ID>] + [--datastore <datastore>] Lists available backups. @@ -1016,6 +1040,16 @@ Lists available backups. + + --marker <ID> + + + 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. + + + --datastore <datastore> @@ -1028,7 +1062,7 @@ Lists available backups.
trove backup-list-instance - usage: trove backup-list-instance [--limit <limit>] <instance> + usage: trove backup-list-instance [--limit <limit>] [--marker <ID>] <instance> Lists available backups for an instance. @@ -1052,6 +1086,16 @@ Lists available backups for an instance. + + --marker <ID> + + + 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. + + +
@@ -1074,7 +1118,7 @@ Shows details of a backup.
trove cluster-create usage: trove cluster-create <name> <datastore> <datastore_version> - [--instance <flavor_id=flavor_id,volume=volume>] + [--instance <flavor=flavor_name_or_id,volume=volume>] Creates a new cluster. @@ -1107,7 +1151,7 @@ Creates a new cluster. Optional arguments - --instance <flavor_id=flavor_id,volume=volume> + --instance <flavor=flavor_name_or_id,volume=volume> Create an instance for the cluster. Specify @@ -1128,7 +1172,37 @@ Deletes a cluster. <cluster> - ID of the cluster. + ID or name of the cluster. + + + + +
+
+ trove cluster-grow + usage: trove cluster-grow <cluster> + [--instance <name=name,flavor=flavor_name_or_id,volume=volume>] + +Adds more instances to a cluster. + + Positional arguments + + <cluster> + + + ID or name of the cluster. + + + + + + Optional arguments + + --instance <name=name,flavor=flavor_name_or_id,volume=volume> + + + Add an instance to the cluster. Specify + multiple times to create multiple instances. @@ -1193,6 +1267,32 @@ Shows details of a cluster. + +
+
+ trove cluster-shrink + usage: trove cluster-shrink <cluster> <instance> [<instance> ...] + +Drops instances from a cluster. + + Positional arguments + + <cluster> + + + ID or name of the cluster. + + + + + <instance> + + + Drop instance(s) from the cluster. Specify multiple ids to drop + multiple instances. + + +
@@ -1517,7 +1617,7 @@ Updates a configuration group.
trove create - usage: trove create <name> <flavor_id> + usage: trove create <name> <flavor> [--size <size>] [--databases <databases> [<databases> ...]] [--users <users> [<users> ...]] [--backup <backup>] @@ -1540,10 +1640,10 @@ Creates a new instance. - <flavor_id> + <flavor> - Flavor of the instance. + Flavor ID or name of the instance. @@ -1959,7 +2059,7 @@ Creates metadata in the database for instance <id>. <instance_id> - UUID for instance + UUID for instance. @@ -1967,7 +2067,7 @@ Creates metadata in the database for instance <id>. <key> - Key for assignment + Key for assignment. @@ -1975,7 +2075,7 @@ Creates metadata in the database for instance <id>. <value> - Value to assign to <key> + Value to assign to <key>. @@ -1992,7 +2092,7 @@ Deletes metadata for instance <id>. <instance_id> - UUID for instance + UUID for instance. @@ -2000,7 +2100,7 @@ Deletes metadata for instance <id>. <key> - Metadata key to delete + Metadata key to delete. @@ -2017,7 +2117,7 @@ Replaces metadata value with a new one, this is non-destructive. <instance_id> - UUID for instance + UUID for instance. @@ -2025,7 +2125,7 @@ Replaces metadata value with a new one, this is non-destructive. <key> - Key to replace + Key to replace. @@ -2033,7 +2133,7 @@ Replaces metadata value with a new one, this is non-destructive. <value> - New value to assign to <key> + New value to assign to <key>. @@ -2050,7 +2150,7 @@ Shows all metadata for instance <id>. <instance_id> - UUID for instance + UUID for instance. @@ -2067,7 +2167,7 @@ Shows metadata entry for key <key> and instance <id>. <instance_id> - UUID for instance + UUID for instance. @@ -2075,7 +2175,7 @@ Shows metadata entry for key <key> and instance <id>. <key> - key to display + Key to display. @@ -2092,7 +2192,7 @@ Updates metadata, this is destructive. <instance_id> - UUID for instance + UUID for instance. @@ -2100,7 +2200,7 @@ Updates metadata, this is destructive. <key> - Key to update + Key to update. @@ -2108,7 +2208,7 @@ Updates metadata, this is destructive. <newkey> - New key + New key. @@ -2116,7 +2216,7 @@ Updates metadata, this is destructive. <value> - Value to assign to <newkey> + Value to assign to <newkey>. @@ -2141,7 +2241,7 @@ Promotes a replica to be the new replica source of its set.
trove resize-instance - usage: trove resize-instance <instance> <flavor_id> + usage: trove resize-instance <instance> <flavor> Resizes an instance with a new flavor. @@ -2155,7 +2255,7 @@ Resizes an instance with a new flavor. - <flavor_id> + <flavor> New flavor of the instance. @@ -2208,16 +2308,28 @@ Restarts an instance.
trove root-enable - usage: trove root-enable <instance> + usage: trove root-enable <instance_or_cluster> + [--root_password <root_password>] Enables root for an instance and resets if already exists. Positional arguments - <instance> + <instance_or_cluster> - ID or name of the instance. + ID or name of the instance or cluster. + + + + + + Optional arguments + + --root_password <root_password> + + + Root password to set. @@ -2225,16 +2337,16 @@ Enables root for an instance and resets if already exists.
trove root-show - usage: trove root-show <instance> + usage: trove root-show <instance_or_cluster> -Gets status if root was ever enabled for an instance. +Gets status if root was ever enabled for an instance or cluster. Positional arguments - <instance> + <instance_or_cluster> - ID or name of the instance. + ID or name of the instance or cluster. @@ -2317,7 +2429,7 @@ Shows details of a security group. <security_group> - Security group ID + Security group ID.