Client library for OpenStack DBaaS API
Project description
This is a client for the OpenStack Trove API. There’s a Python API (the troveclient module), and a command-line script (trove). Each implements 100% of the OpenStack Trove API.
See the OpenStack CLI guide for information on how to use the trove command-line tool. You may also want to look at the OpenStack API documentation.
The project is hosted on Launchpad, where bugs can be filed. The code is hosted on Github. Patches must be submitted using Gerrit, not Github pull requests.
This code a fork of Jacobian’s python-cloudservers If you need API support for the Rackspace API solely or the BSD license, you should use that repository. python-troveclient is licensed under the Apache License like the rest of OpenStack.
Command-line API
Installing this package gets you a shell command, trove, that you can use to interact with any Rackspace compatible API (including OpenStack).
You’ll need to provide your OpenStack username and password. You can do this with the --os-username, --os-password and --os-tenant-name params, but it’s easier to just set them as environment variables:
export OS_USERNAME=openstack export OS_PASSWORD=yadayada export OS_TENANT_NAME=myproject
You will also need to define the authentication url with --os-auth-url and the version of the API with --version. Or set them as an environment variables as well:
export OS_AUTH_URL=http://example.com:5000/v2.0/
Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with --os-region-name (or export OS_REGION_NAME). It defaults to the first in the list returned.
You’ll find complete documentation on the shell by running trove help:
usage: trove [--version] [--debug] [--os-username <auth-user-name>]
[--os-password <auth-password>]
[--os-tenant-name <auth-tenant-name>]
[--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
[--os-region-name <region-name>] [--service-type <service-type>]
[--service-name <service-name>]
[--database-service-name <database-service-name>]
[--endpoint-type <endpoint-type>]
[--os-database-api-version <database-api-ver>]
[--os-cacert <ca-certificate>] [--retries <retries>]
<subcommand> ...
Command-line interface to the OpenStack Trove API.
Positional arguments:
<subcommand>
backup-create Creates a backup.
backup-delete Deletes a backup.
backup-list List available backups.
backup-list-instance
List available backups for an instance.
backup-show Show details of a backup.
create Creates a new instance.
database-create Creates a database on an instance.
database-delete Deletes a database.
database-list Lists available databases on an instance.
delete Deletes an instance.
flavor-list Lists available flavors.
flavor-show Show details of a flavor.
limit-list Lists the limits for a tenant.
list List all the instances.
resize-flavor Resizes the flavor of an instance.
resize-volume Resizes the volume size of an instance.
restart Restarts the instance.
root-enable Enables root for a instance.
root-show Gets root enabled status for a instance.
secgroup-add-rule Creates a security group rule.
secgroup-delete-rule
Deletes a security group rule.
secgroup-list Lists all security groups.
secgroup-show Shows details about a security group.
show Show details of an instance.
user-create Creates a user.
user-delete Deletes a user from the instance.
user-grant-access Grants access to a database(s) for a user.
user-list Lists the users for a instance.
user-revoke-access Revokes access to a database for a user.
user-show Gets a user from the instance.
user-show-access Gets a users access from the instance.
user-update-attributes
Updates a users attributes from the instance.
bash-completion Print arguments for bash_completion.
help Display help about this program or one of its
subcommands.
Optional arguments:
--version show program's version number and exit
--debug Print debugging output
--os-username <auth-user-name>
Defaults to env[OS_USERNAME].
--os-password <auth-password>
Defaults to env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--os-tenant-id <auth-tenant-id>
Defaults to env[OS_TENANT_ID].
--os-auth-url <auth-url>
Defaults to env[OS_AUTH_URL].
--os-region-name <region-name>
Defaults to env[OS_REGION_NAME].
--service-type <service-type>
Defaults to database for most actions
--service-name <service-name>
Defaults to env[TROVE_SERVICE_NAME]
--database-service-name <database-service-name>
Defaults to env[TROVE_DATABASE_SERVICE_NAME]
--endpoint-type <endpoint-type>
Defaults to env[TROVE_ENDPOINT_TYPE] or publicURL.
--os-database-api-version <database-api-ver>
Accepts 1,defaults to env[OS_DATABASE_API_VERSION].
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--retries <retries> Number of retries.
Python API
There’s also a complete Python API, but it has not yet been documented.
Quick-start using keystone:
# use v2.0 auth with http://example.com:5000/v2.0/") >>> from troveclient.v1 import client >>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="database") >>> nt.instances.list() [...]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file python-troveclient-1.0.2.tar.gz.
File metadata
- Download URL: python-troveclient-1.0.2.tar.gz
- Upload date:
- Size: 116.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fd389622a0b4b25bd075bff9abaea37814003d8b9d89a4cc6901f15fca25ac24 |
|
| MD5 | a896b37f8cce532518dd339b92a883eb |
|
| BLAKE2b-256 | 15c2dbcb1a7225bfc674ad88ea63afc484c1c312910f51f68ffe514c9233653f |
