openstack
/
python-manilaclient
Code Issues Proposed changes
Python bindings for Manila
843 Commits 9 Branches 51 Tags 25 MiB
Python 99.8%
Shell 0.2%
Go to file
OpenStack Release Bot 3cac584e70 Add Python3 wallaby unit tests 
This is an automatically generated patch to ensure unit testing
is in place for all the of the tested runtimes for wallaby.

See also the PTI in governance [1].

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html

Change-Id: I47ec3b6d5cdc8228d0f6e2353a0e6eafe2aa7b76
 		2020-09-11 15:46:01 +00:00
doc Implement the first half of OSC share snapshots commands 2020-09-10 16:52:34 +00:00
etc Implement functionality for functional tests using tempest-lib 2014-11-12 13:05:24 +02:00
manilaclient Merge "Add commands for share server migration" 2020-09-11 14:24:19 +00:00
playbooks/python-manilaclient-functional Migrate functional job to native zuulv3 2020-06-30 17:25:46 +00:00
rally-jobs Add rally job manifests 2017-07-31 19:57:48 -04:00
releasenotes Update master for stable/victoria 2020-09-11 15:45:56 +00:00
roles/populate-manilaclient-config Add commands for share server migration 2020-09-10 07:40:32 -03:00
tools TrivialFix: Remove unnecessary future imports 2020-05-05 08:44:02 -07:00
zuul.d Add Python3 wallaby unit tests 2020-09-11 15:46:01 +00:00
.gitignore Drop 'clidoc' from sphinx extensions 2018-08-23 19:21:34 -07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:44:14 +00:00
.stestr.conf Switch to use stestr instead of testr 2018-05-07 22:24:34 +08:00
CONTRIBUTING.rst [ussuri][goal] Change contributor guide 2020-04-24 16:49:52 -07:00
HACKING TrivialFix for HACKING file 2017-08-23 17:42:54 +08:00
LICENSE setup.py fixed 2013-09-03 14:37:34 +03:00
README.rst Add PDF documentation build 2019-09-13 14:00:46 -04:00
bindep.txt Migrate functional job to native zuulv3 2020-06-30 17:25:46 +00:00
lower-constraints.txt [goal] Migrate testing to ubuntu focal 2020-09-06 00:49:59 +00:00
requirements.txt Cleanup py27 support 2020-04-04 11:30:07 +02:00
run_tests.sh Remove nonexistent directory "tests" from pep8 scanning 2015-01-06 14:47:01 +02:00
setup.cfg Implement the first half of OSC share snapshots commands 2020-09-10 16:52:34 +00:00
setup.py Cleanup py27 support 2020-04-04 11:30:07 +02:00
test-requirements.txt Use unittest.mock instead of third party lib 2020-06-22 17:26:26 -07:00
tox.ini Drop install_command usage in tox 2020-04-22 18:25:56 -07:00

README.rst

Team and repository tags

image

Python bindings to the OpenStack Manila API

Latest Version

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