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

434
README.rst
View File

@@ -79,215 +79,243 @@ 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-auth-type <name>]
[--os-key <key>] [--timeout <seconds>] [--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-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
[--os-username OS_USERNAME] [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
[--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
[--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-password OS_PASSWORD] [--os-tenant-name <auth-tenant-name>] [--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-tenant-id <tenant-id>] [--os-auth-token OS_AUTH_TOKEN] [--os-password OS_PASSWORD] [--os-region-name <region-name>]
[--os-region-name <region-name>] <subcommand> ...
<subcommand> ...
Command-line interface to the OpenStack Trove API. Command-line interface to the OpenStack Trove API.
Positional arguments: Positional arguments:
<subcommand> <subcommand>
backup-copy Creates a backup from another backup. backup-copy Creates a backup from another backup.
backup-create Creates a backup of an instance. backup-create Creates a backup of an instance.
backup-delete Deletes a backup. backup-delete Deletes a backup.
backup-list Lists available backups. backup-list Lists available backups.
backup-list-instance Lists available backups for an instance. backup-list-instance Lists available backups for an instance.
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-grow Adds more instances to a cluster. cluster-force-delete Force delete a cluster
cluster-instances Lists all instances of a cluster. cluster-grow Adds more instances to a cluster.
cluster-list Lists all the clusters. cluster-instances Lists all instances of a cluster.
cluster-modules Lists all modules for each instance of a cluster-list Lists all the clusters.
cluster. cluster-modules Lists all modules for each instance of a
cluster-show Shows details of a cluster. cluster.
cluster-shrink Drops instances from a cluster. cluster-reset-status Set the cluster task to NONE.
configuration-attach Attaches a configuration group to an cluster-show Shows details of a cluster.
instance. cluster-shrink Drops instances from a cluster.
configuration-create Creates a configuration group. configuration-attach Attaches a configuration group to an
configuration-default Shows the default configuration of an instance.
instance. configuration-create Creates a configuration group.
configuration-delete Deletes a configuration group. configuration-default Shows the default configuration of an
configuration-detach Detaches a configuration group from an instance.
instance. configuration-delete Deletes a configuration group.
configuration-instances Lists all instances associated with a configuration-detach Detaches a configuration group from an
configuration group. instance.
configuration-list Lists all configuration groups. configuration-instances Lists all instances associated with a
configuration-parameter-list Lists available parameters for a configuration group.
configuration group. configuration-list Lists all configuration groups.
configuration-parameter-show Shows details of a configuration parameter. configuration-parameter-list Lists available parameters for a
configuration-patch Patches a configuration group. configuration group.
configuration-show Shows details of a configuration group. configuration-parameter-show Shows details of a configuration parameter.
configuration-update Updates a configuration group. configuration-patch Patches a configuration group.
create Creates a new instance. configuration-show Shows details of a configuration group.
database-create Creates a database on an instance. configuration-update Updates a configuration group.
database-delete Deletes a database from an instance. create Creates a new instance.
database-list Lists available databases on an instance. database-create Creates a database on an instance.
datastore-list Lists available datastores. database-delete Deletes a database from an instance.
datastore-show Shows details of a datastore. database-list Lists available databases on an instance.
datastore-version-list Lists available versions for a datastore. datastore-list Lists available datastores.
datastore-version-show Shows details of a datastore version. datastore-show Shows details of a datastore.
delete Deletes an instance. datastore-version-list Lists available versions for a datastore.
detach-replica Detaches a replica instance from its datastore-version-show Shows details of a datastore version.
replication source. delete Deletes an instance.
eject-replica-source Ejects a replica source from its set. detach-replica Detaches a replica instance from its
flavor-list Lists available flavors. replication source.
flavor-show Shows details of a flavor. eject-replica-source Ejects a replica source from its set.
limit-list Lists the limits for a tenant. execution-delete Deletes an execution.
list Lists all the instances. execution-list Lists executions of a scheduled backup of an
log-disable Instructs Trove guest to stop collecting log instance.
details. flavor-list Lists available flavors.
log-discard Instructs Trove guest to discard the flavor-show Shows details of a flavor.
container of the published log. force-delete Force delete an instance.
log-enable Instructs Trove guest to start collecting limit-list Lists the limits for a tenant.
log details. list Lists all the instances.
log-list Lists the log files available for instance. log-disable Instructs Trove guest to stop collecting log
log-publish Instructs Trove guest to publish latest log details.
entries on instance. log-discard Instructs Trove guest to discard the
log-save Save log file for instance. container of the published log.
log-show Instructs Trove guest to show details of log-enable Instructs Trove guest to start collecting
log. log details.
log-tail Display log entries for instance. log-list Lists the log files available for instance.
metadata-create Creates metadata in the database for log-publish Instructs Trove guest to publish latest log
instance <id>. entries on instance.
metadata-delete Deletes metadata for instance <id>. log-save Save log file for instance.
metadata-edit Replaces metadata value with a new one, this log-show Instructs Trove guest to show details of
is non-destructive. log.
metadata-list Shows all metadata for instance <id>. log-tail Display log entries for instance.
metadata-show Shows metadata entry for key <key> and metadata-create Creates metadata in the database for
instance <id>. instance <id>.
metadata-update Updates metadata, this is destructive. metadata-delete Deletes metadata for instance <id>.
module-apply Apply modules to an instance. metadata-edit Replaces metadata value with a new one, this
module-create Create a module. is non-destructive.
module-delete Delete a module. metadata-list Shows all metadata for instance <id>.
module-instances Lists the instances that have a particular metadata-show Shows metadata entry for key <key> and
module applied. instance <id>.
module-list Lists the modules available. metadata-update Updates metadata, this is destructive.
module-list-instance Lists the modules that have been applied to module-apply Apply modules to an instance.
an instance. module-create Create a module.
module-query Query the status of the modules on an module-delete Delete a module.
instance. module-instances Lists the instances that have a particular
module-remove Remove a module from an instance. module applied.
module-retrieve Retrieve module contents from an instance. module-list Lists the modules available.
module-show Shows details of a module. module-list-instance Lists the modules that have been applied to
module-update Update a module. an instance.
promote-to-replica-source Promotes a replica to be the new replica module-query Query the status of the modules on an
source of its set. instance.
resize-instance Resizes an instance with a new flavor. module-remove Remove a module from an instance.
resize-volume Resizes the volume size of an instance. module-retrieve Retrieve module contents from an instance.
restart Restarts an instance. module-show Shows details of a module.
root-disable Disables root for an instance. module-update Update a module.
root-enable Enables root for an instance and resets if promote-to-replica-source Promotes a replica to be the new replica
already exists. source of its set.
root-show Gets status if root was ever enabled for an quota-show Show quotas for a tenant.
instance or cluster. quota-update Update quotas for a tenant.
secgroup-add-rule Creates a security group rule. reset-status Set the status to NONE.
secgroup-delete-rule Deletes a security group rule. resize-instance Resizes an instance with a new flavor.
secgroup-list Lists all security groups. resize-volume Resizes the volume size of an instance.
secgroup-list-rules Lists all rules for a security group. restart Restarts an instance.
secgroup-show Shows details of a security group. root-disable Disables root for an instance.
show Shows details of an instance. root-enable Enables root for an instance and resets if
update Updates an instance: Edits name, already exists.
configuration, or replica source. root-show Gets status if root was ever enabled for an
user-create Creates a user on an instance. instance or cluster.
user-delete Deletes a user from an instance. schedule-create Schedules backups for an instance.
user-grant-access Grants access to a database(s) for a user. schedule-delete Deletes a schedule.
user-list Lists the users for an instance. schedule-list Lists scheduled backups for an instance.
user-revoke-access Revokes access to a database for a user. schedule-show Shows details of a schedule.
user-show Shows details of a user of an instance. secgroup-add-rule Creates a security group rule.
user-show-access Shows access details of a user of an secgroup-delete-rule Deletes a security group rule.
instance. secgroup-list Lists all security groups.
user-update-attributes Updates a user's attributes on an instance. secgroup-list-rules Lists all rules for a security group.
bash-completion Prints arguments for bash_completion. secgroup-show Shows details of a security group.
help Displays help about this program or one of show Shows details of an instance.
its subcommands. update Updates an instance: Edits name,
configuration, or replica source.
upgrade Upgrades an instance to a new datastore
version.
user-create Creates a user on an instance.
user-delete Deletes a user from an instance.
user-grant-access Grants access to a database(s) for a user.
user-list Lists the users for an instance.
user-revoke-access Revokes access to a database for a user.
user-show Shows details of a user of an instance.
user-show-access Shows access details of a user of an
instance.
user-update-attributes Updates a user's attributes on an instance.
bash-completion Prints arguments for bash_completion.
help Displays help about this program or one of
its subcommands.
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]. --database-service-name <database-service-name>
--database-service-name <database-service-name> Defaults to
Defaults to env[TROVE_DATABASE_SERVICE_NAME].
env[TROVE_DATABASE_SERVICE_NAME]. --endpoint-type <endpoint-type>
--endpoint-type <endpoint-type> Defaults to env[TROVE_ENDPOINT_TYPE] or
Defaults to env[TROVE_ENDPOINT_TYPE] or env[OS_ENDPOINT_TYPE] or publicURL.
env[OS_ENDPOINT_TYPE] or publicURL. --os-database-api-version <database-api-ver>
--os-database-api-version <database-api-ver> Accepts 1, defaults to
Accepts 1, defaults to env[OS_DATABASE_API_VERSION].
env[OS_DATABASE_API_VERSION]. --retries <retries> Number of retries.
--retries <retries> Number of retries. --json, --os-json-output Output JSON instead of prettyprint. Defaults
--json, --os-json-output Output JSON instead of prettyprint. Defaults to env[OS_JSON_OUTPUT].
to env[OS_JSON_OUTPUT]. --profile HMAC_KEY HMAC key used to encrypt context data when
--profile HMAC_KEY HMAC key used to encrypt context data when profiling the performance of an operation.
profiling the performance of an operation. This key should be set to one of the HMAC
This key should be set to one of the HMAC keys configured in Trove (they are found in
keys configured in Trove (they are found in api-paste.ini, typically in /etc/trove).
api-paste.ini, typically in /etc/trove). Without the key, profiling will not be
Without the key, profiling will not be 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>
--insecure Explicitly allow client to perform Authentication type to use
"insecure" TLS (https) requests. The --os-region-name <region-name> Specify the region to use. Defaults to
server's certificate will not be verified env[OS_REGION_NAME].
against any certificate authorities. This
option should be used with caution. API Connection Options:
--os-cacert <ca-certificate> Specify a CA bundle file to use in verifying Options controlling the HTTP API Connections
a TLS (https) server certificate. Defaults
to env[OS_CACERT]. --insecure Explicitly allow client to perform
--os-cert <certificate> Defaults to env[OS_CERT]. "insecure" TLS (https) requests. The
--os-key <key> Defaults to env[OS_KEY]. server's certificate will not be verified
--timeout <seconds> Set request timeout (in seconds). against any certificate authorities. This
--os-auth-url OS_AUTH_URL Authentication URL option should be used with caution.
--os-domain-id OS_DOMAIN_ID Domain ID to scope to --os-cacert <ca-certificate> Specify a CA bundle file to use in verifying
--os-domain-name OS_DOMAIN_NAME a TLS (https) server certificate. Defaults
Domain name to scope to to env[OS_CACERT].
--os-project-id OS_PROJECT_ID Project ID to scope to --os-cert <certificate> Defaults to env[OS_CERT].
--os-project-name OS_PROJECT_NAME --os-key <key> Defaults to env[OS_KEY].
Project name to scope to --timeout <seconds> Set request timeout (in seconds).
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Domain ID containing project Authentication Options:
--os-project-domain-name OS_PROJECT_DOMAIN_NAME Options specific to the password plugin.
Domain name containing project
--os-trust-id OS_TRUST_ID Trust ID --os-auth-url OS_AUTH_URL Authentication URL
--os-user-id OS_USER_ID User ID --os-domain-id OS_DOMAIN_ID Domain ID to scope to
--os-username OS_USERNAME, --os-user_name OS_USERNAME --os-domain-name OS_DOMAIN_NAME
Username Domain name to scope to
--os-user-domain-id OS_USER_DOMAIN_ID --os-project-id OS_PROJECT_ID, --os-tenant-id OS_PROJECT_ID
User's domain id Project ID to scope to
--os-user-domain-name OS_USER_DOMAIN_NAME --os-project-name OS_PROJECT_NAME, --os-tenant-name OS_PROJECT_NAME
User's domain name Project name to scope to
--os-password OS_PASSWORD User's password --os-project-domain-id OS_PROJECT_DOMAIN_ID
--os-tenant-name <auth-tenant-name> Domain ID containing project
Tenant to request authorization on. Defaults --os-project-domain-name OS_PROJECT_DOMAIN_NAME
to env[OS_TENANT_NAME]. Domain name containing project
--os-tenant-id <tenant-id> Tenant to request authorization on. Defaults --os-trust-id OS_TRUST_ID Trust ID
to env[OS_TENANT_ID]. --os-default-domain-id OS_DEFAULT_DOMAIN_ID
--os-auth-token OS_AUTH_TOKEN Defaults to env[OS_AUTH_TOKEN] Optional domain ID to use with v3 and v2
--os-region-name <region-name> Specify the region to use. Defaults to parameters. It will be used for both the
env[OS_REGION_NAME]. 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
--os-user-domain-id OS_USER_DOMAIN_ID
User's domain id
--os-user-domain-name OS_USER_DOMAIN_NAME
User's domain name
--os-password OS_PASSWORD User's password
See "trove help COMMAND" for help on a specific command. See "trove help COMMAND" for help on a specific command.