openstack/python-manilaclient
Code Issues Proposed changes
Python bindings for Manila
434 Commits 10 Branches 57 Tags 26 MiB
Python 99.8%
Shell 0.2%
0b9a1dd83d
Go to file
Goutham Pacha Ravi 0b9a1dd83d Add support for releasenotes 
Create the releasenotes directory and add the requisite
conf.py file to generate python-manilaclient's release notes.

project-config change: I522ba76263a6597026f6dd7b03ec51bb05bfb15a

Change-Id: I6b0fa6016781a252a71649a7cac85f02b0a019e8
2016-05-25 17:45:16 +00:00
contrib/ci Fix post_test_hook.sh script auth error 2016-02-27 18:15:23 +02:00
doc Fix view of doc info for functional tests 2016-05-17 18:00:51 +03:00
etc Implement functionality for functional tests using tempest-lib 2014-11-12 13:05:24 +02:00
manilaclient Add possibility to provide auth token via CLI 2016-05-16 20:02:06 +03:00
releasenotes Add support for releasenotes 2016-05-25 17:45:16 +00:00
tools Remove vim header from source files 2015-12-27 22:58:42 -05:00
.gitignore Add support for releasenotes 2016-05-25 17:45:16 +00:00
.gitreview Update .gitreview file for move to openstack 2014-09-19 21:10:25 +00:00
.testr.conf Fix usage of setUpClass method in functional tests 2015-10-26 15:02:07 +02:00
CONTRIBUTING.rst Added CONTRIBUTING.rst file to the project 2016-05-17 00:06:50 +00:00
HACKING mass replace cinder to manila 2013-09-05 13:32:38 +03:00
LICENSE setup.py fixed 2013-09-03 14:37:34 +03:00
openstack-common.conf Sync with oslo-incubator 2014-10-23 08:13:25 +02:00
README.rst Eliminate unnecessary character 2016-02-17 11:09:42 +09:00
requirements.txt Updated from global requirements 2016-05-18 02:39:58 +00:00
run_tests.sh Remove nonexistent directory "tests" from pep8 scanning 2015-01-06 14:47:01 +02:00
setup.cfg Update the home-page with developer documentation 2016-05-17 10:08:30 +05:30
setup.py Updated from global requirements 2015-09-18 16:42:20 +00:00
test-requirements.txt Add support for releasenotes 2016-05-25 17:45:16 +00:00
tox.ini Add support for releasenotes 2016-05-25 17:45:16 +00:00

README.rst

Python bindings to the OpenStack Manila API

Latest Version

Downloads

This is a client for the OpenStack Manila API. There's a Python API (the manilaclient module), and a command-line script (manila). Each implements 100% of the OpenStack Manila API.

See the OpenStack CLI guide for information on how to use the manila 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 is a fork of Cinderclient of Grizzly release and then it was developed separately. Cinderclient code is 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-manilaclient is licensed under the Apache License like the rest of OpenStack.

Contents:

Command-line API

Installing this package gets you a shell command, manila, 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=foouser
export OS_PASSWORD=barpass
export OS_TENANT_NAME=fooproject

You will also need to define the authentication url either with param --os-auth-url or as an environment variable:

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 manila help, see manila help COMMAND for help on a specific command.

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 manilaclient.v1 import client
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="share")
>>> nt.shares.list()
[...]