Python bindings for Manila
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Maari Tamm 126c82a2ae Implement OSC share resize command 1 month ago
doc Switch to newer openstackdocstheme and reno versions 1 month ago
etc Implement functionality for functional tests using tempest-lib 5 years ago
manilaclient Implement OSC share resize command 3 days ago
playbooks/python-manilaclient-functional Migrate functional job to native zuulv3 3 days ago
rally-jobs Add rally job manifests 2 years ago
releasenotes Switch to newer openstackdocstheme and reno versions 1 month ago
roles/populate-manilaclient-config Migrate functional job to native zuulv3 3 days ago
tools TrivialFix: Remove unnecessary future imports 1 month ago
zuul.d Migrate functional job to native zuulv3 3 days ago
.gitignore Drop 'clidoc' from sphinx extensions 1 year ago
.gitreview OpenDev Migration Patch 1 year ago
.stestr.conf Switch to use stestr instead of testr 2 years ago
CONTRIBUTING.rst [ussuri][goal] Change contributor guide 2 months ago
HACKING TrivialFix for HACKING file 2 years ago
LICENSE setup.py fixed 6 years ago
README.rst Add PDF documentation build 9 months ago
bindep.txt Migrate functional job to native zuulv3 3 days ago
lower-constraints.txt Switch to newer openstackdocstheme and reno versions 1 month ago
requirements.txt Cleanup py27 support 3 months ago
run_tests.sh Remove nonexistent directory "tests" from pep8 scanning 5 years ago
setup.cfg Implement OSC share resize command 3 days ago
setup.py Cleanup py27 support 3 months ago
test-requirements.txt Fix hacking min version to 3.0.1 1 month ago
tox.ini Drop install_command usage in tox 2 months ago

README.rst

Team and repository tags

image

Python bindings to the OpenStack Manila API

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()
[...]