openstack/python-troveclient
Code Issues Proposed changes

Merge "Add a new command in the readme"

Browse Source
This commit is contained in:
Jenkins
2016-09-29 20:15:12 +00:00
committed by Gerrit Code Review
parent e8b4f6c15b 8b27e7f1c6
commit c22d37b51c
1 changed files with 231 additions and 203 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
README.rst
View File

@@ -79,27 +79,26 @@ Argument ``--profile`` is available only when the osprofiler lib is installed.
You'll find complete documentation on the shell by running You'll find complete documentation on the shell by running
``trove help``:: ``trove help``::
usage: trove [--version] [--debug] [--os-auth-system <auth-system>] usage: trove [--version] [--debug] [--service-type <service-type>]
[--service-type <service-type>] [--service-name <service-name>] [--service-name <service-name>] [--bypass-url <bypass-url>]
[--bypass-url <bypass-url>]
[--database-service-name <database-service-name>] [--database-service-name <database-service-name>]
[--endpoint-type <endpoint-type>] [--endpoint-type <endpoint-type>]
[--os-database-api-version <database-api-ver>] [--os-database-api-version <database-api-ver>]
[--retries <retries>] [--json] [--profile HMAC_KEY] [--insecure] [--retries <retries>] [--json] [--profile HMAC_KEY] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-cacert <ca-certificate>] [--os-cert <certificate>]
[--os-key <key>] [--timeout <seconds>] [--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>]
[--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
[--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID]
[--os-project-name OS_PROJECT_NAME] [--os-project-name OS_PROJECT_NAME]
[--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
[--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-trust-id OS_TRUST_ID]
[--os-username OS_USERNAME] [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
[--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
[--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
[--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-password OS_PASSWORD] [--os-tenant-name <auth-tenant-name>] [--os-password OS_PASSWORD] [--os-region-name <region-name>]
[--os-tenant-id <tenant-id>] [--os-auth-token OS_AUTH_TOKEN]
[--os-region-name <region-name>]
<subcommand> ... <subcommand> ...
Command-line interface to the OpenStack Trove API. Command-line interface to the OpenStack Trove API.
@@ -114,11 +113,13 @@ You'll find complete documentation on the shell by running
backup-show Shows details of a backup. backup-show Shows details of a backup.
cluster-create Creates a new cluster. cluster-create Creates a new cluster.
cluster-delete Deletes a cluster. cluster-delete Deletes a cluster.
cluster-force-delete Force delete a cluster
cluster-grow Adds more instances to a cluster. cluster-grow Adds more instances to a cluster.
cluster-instances Lists all instances of a cluster. cluster-instances Lists all instances of a cluster.
cluster-list Lists all the clusters. cluster-list Lists all the clusters.
cluster-modules Lists all modules for each instance of a cluster-modules Lists all modules for each instance of a
cluster. cluster.
cluster-reset-status Set the cluster task to NONE.
cluster-show Shows details of a cluster. cluster-show Shows details of a cluster.
cluster-shrink Drops instances from a cluster. cluster-shrink Drops instances from a cluster.
configuration-attach Attaches a configuration group to an configuration-attach Attaches a configuration group to an
@@ -150,8 +151,12 @@ You'll find complete documentation on the shell by running
detach-replica Detaches a replica instance from its detach-replica Detaches a replica instance from its
replication source. replication source.
eject-replica-source Ejects a replica source from its set. eject-replica-source Ejects a replica source from its set.
execution-delete Deletes an execution.
execution-list Lists executions of a scheduled backup of an
instance.
flavor-list Lists available flavors. flavor-list Lists available flavors.
flavor-show Shows details of a flavor. flavor-show Shows details of a flavor.
force-delete Force delete an instance.
limit-list Lists the limits for a tenant. limit-list Lists the limits for a tenant.
list Lists all the instances. list Lists all the instances.
log-disable Instructs Trove guest to stop collecting log log-disable Instructs Trove guest to stop collecting log
@@ -192,6 +197,9 @@ You'll find complete documentation on the shell by running
module-update Update a module. module-update Update a module.
promote-to-replica-source Promotes a replica to be the new replica promote-to-replica-source Promotes a replica to be the new replica
source of its set. source of its set.
quota-show Show quotas for a tenant.
quota-update Update quotas for a tenant.
reset-status Set the status to NONE.
resize-instance Resizes an instance with a new flavor. resize-instance Resizes an instance with a new flavor.
resize-volume Resizes the volume size of an instance. resize-volume Resizes the volume size of an instance.
restart Restarts an instance. restart Restarts an instance.
@@ -200,6 +208,10 @@ You'll find complete documentation on the shell by running
already exists. already exists.
root-show Gets status if root was ever enabled for an root-show Gets status if root was ever enabled for an
instance or cluster. instance or cluster.
schedule-create Schedules backups for an instance.
schedule-delete Deletes a schedule.
schedule-list Lists scheduled backups for an instance.
schedule-show Shows details of a schedule.
secgroup-add-rule Creates a security group rule. secgroup-add-rule Creates a security group rule.
secgroup-delete-rule Deletes a security group rule. secgroup-delete-rule Deletes a security group rule.
secgroup-list Lists all security groups. secgroup-list Lists all security groups.
@@ -208,6 +220,8 @@ You'll find complete documentation on the shell by running
show Shows details of an instance. show Shows details of an instance.
update Updates an instance: Edits name, update Updates an instance: Edits name,
configuration, or replica source. configuration, or replica source.
upgrade Upgrades an instance to a new datastore
version.
user-create Creates a user on an instance. user-create Creates a user on an instance.
user-delete Deletes a user from an instance. user-delete Deletes a user from an instance.
user-grant-access Grants access to a database(s) for a user. user-grant-access Grants access to a database(s) for a user.
@@ -224,7 +238,6 @@ You'll find complete documentation on the shell by running
Optional arguments: Optional arguments:
--version Show program's version number and exit. --version Show program's version number and exit.
--debug Print debugging output. --debug Print debugging output.
--os-auth-system <auth-system> Defaults to env[OS_AUTH_SYSTEM].
--service-type <service-type> Defaults to database for most actions. --service-type <service-type> Defaults to database for most actions.
--service-name <service-name> Defaults to env[TROVE_SERVICE_NAME]. --service-name <service-name> Defaults to env[TROVE_SERVICE_NAME].
--bypass-url <bypass-url> Defaults to env[TROVE_BYPASS_URL]. --bypass-url <bypass-url> Defaults to env[TROVE_BYPASS_URL].
@@ -249,6 +262,14 @@ You'll find complete documentation on the shell by running
triggered even if it is enabled on the triggered even if it is enabled on the
server side. Defaults to server side. Defaults to
env[OS_PROFILE_HMACKEY]. env[OS_PROFILE_HMACKEY].
--os-auth-type <name>, --os-auth-plugin <name>
Authentication type to use
--os-region-name <region-name> Specify the region to use. Defaults to
env[OS_REGION_NAME].
API Connection Options:
Options controlling the HTTP API Connections
--insecure Explicitly allow client to perform --insecure Explicitly allow client to perform
"insecure" TLS (https) requests. The "insecure" TLS (https) requests. The
server's certificate will not be verified server's certificate will not be verified
@@ -260,34 +281,41 @@ You'll find complete documentation on the shell by running
--os-cert <certificate> Defaults to env[OS_CERT]. --os-cert <certificate> Defaults to env[OS_CERT].
--os-key <key> Defaults to env[OS_KEY]. --os-key <key> Defaults to env[OS_KEY].
--timeout <seconds> Set request timeout (in seconds). --timeout <seconds> Set request timeout (in seconds).
Authentication Options:
Options specific to the password plugin.
--os-auth-url OS_AUTH_URL Authentication URL --os-auth-url OS_AUTH_URL Authentication URL
--os-domain-id OS_DOMAIN_ID Domain ID to scope to --os-domain-id OS_DOMAIN_ID Domain ID to scope to
--os-domain-name OS_DOMAIN_NAME --os-domain-name OS_DOMAIN_NAME
Domain name to scope to Domain name to scope to
--os-project-id OS_PROJECT_ID Project ID to scope to --os-project-id OS_PROJECT_ID, --os-tenant-id OS_PROJECT_ID
--os-project-name OS_PROJECT_NAME Project ID to scope to
--os-project-name OS_PROJECT_NAME, --os-tenant-name OS_PROJECT_NAME
Project name to scope to Project name to scope to
--os-project-domain-id OS_PROJECT_DOMAIN_ID --os-project-domain-id OS_PROJECT_DOMAIN_ID
Domain ID containing project Domain ID containing project
--os-project-domain-name OS_PROJECT_DOMAIN_NAME --os-project-domain-name OS_PROJECT_DOMAIN_NAME
Domain name containing project Domain name containing project
--os-trust-id OS_TRUST_ID Trust ID --os-trust-id OS_TRUST_ID Trust ID
--os-user-id OS_USER_ID User ID --os-default-domain-id OS_DEFAULT_DOMAIN_ID
--os-username OS_USERNAME, --os-user_name OS_USERNAME Optional domain ID to use with v3 and v2
parameters. It will be used for both the
user and project domain in v3 and ignored in
v2 authentication.
--os-default-domain-name OS_DEFAULT_DOMAIN_NAME
Optional domain name to use with v3 API and
v2 parameters. It will be used for both the
user and project domain in v3 and ignored in
v2 authentication.
--os-user-id OS_USER_ID User id
--os-username OS_USERNAME, --os-user-name OS_USERNAME
Username Username
--os-user-domain-id OS_USER_DOMAIN_ID --os-user-domain-id OS_USER_DOMAIN_ID
User's domain id User's domain id
--os-user-domain-name OS_USER_DOMAIN_NAME --os-user-domain-name OS_USER_DOMAIN_NAME
User's domain name User's domain name
--os-password OS_PASSWORD User's password --os-password OS_PASSWORD User's password
--os-tenant-name <auth-tenant-name>
Tenant to request authorization on. Defaults
to env[OS_TENANT_NAME].
--os-tenant-id <tenant-id> Tenant to request authorization on. Defaults
to env[OS_TENANT_ID].
--os-auth-token OS_AUTH_TOKEN Defaults to env[OS_AUTH_TOKEN]
--os-region-name <region-name> Specify the region to use. Defaults to
env[OS_REGION_NAME].
See "trove help COMMAND" for help on a specific command. See "trove help COMMAND" for help on a specific command.