openstack/python-manilaclient
Code Issues Proposed changes
Python bindings for Manila
753 Commits 10 Branches 57 Tags 26 MiB
Python 99.8%
Shell 0.2%
359a96ba58
Go to file
Goutham Pacha Ravi 359a96ba58 Add support for replica export location APIs 
- Add share_replica_export_locations module to the
  manilaclient SDK.
- Add 'share-replica-export-location-list' and
  'share-replica-export-location-show' commands to
  the manilaclient shell module.
- Add export_locations attr to 'share-replica-show'
  command in the shell module.

Change-Id: I0edb0d56f5c8f439932c18d510aad0457112b75e
Depends-On: https://review.openstack.org/#/c/628069/
Implements: bp export-locations-az
2019-01-07 11:40:21 -08:00
contrib/ci Fix functional tests 2018-08-16 04:48:44 +00:00
doc Drop 'clidoc' from sphinx extensions 2018-08-23 19:21:34 -07:00
etc Implement functionality for functional tests using tempest-lib 2014-11-12 13:05:24 +02:00
manilaclient Add support for replica export location APIs 2019-01-07 11:40:21 -08:00
playbooks/legacy/manilaclient-dsvm-neutron-functional Allow clone of manila-tempest-plugin 2018-03-23 09:18:42 -04:00
rally-jobs Add rally job manifests 2017-07-31 19:57:48 -04:00
releasenotes Add support for replica export location APIs 2019-01-07 11:40:21 -08:00
tools Avoid tox_install.sh for constraints support 2017-12-02 16:56:04 +00:00
.gitignore Drop 'clidoc' from sphinx extensions 2018-08-23 19:21:34 -07:00
.gitreview Update .gitreview file for move to openstack 2014-09-19 21:10:25 +00:00
.stestr.conf Switch to use stestr instead of testr 2018-05-07 22:24:34 +08:00
.zuul.yaml Change python3.5 job to python3.7 job on Stein+ 2018-10-12 21:25:47 +00:00
CONTRIBUTING.rst Replace http with https 2017-07-19 18:56:26 +08: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
lower-constraints.txt Drop 'clidoc' from sphinx extensions 2018-08-23 19:21:34 -07:00
README.rst Add Release Notes in README 2018-11-12 09:45:46 +08:00
requirements.txt Loosen docutils requirement pin 2018-07-27 17:55:15 -04:00
run_tests.sh Remove nonexistent directory "tests" from pep8 scanning 2015-01-06 14:47:01 +02:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-03 21:47:37 -05:00
setup.py Updated from global requirements 2017-03-03 00:04:17 +00:00
test-requirements.txt Switch to use stestr instead of testr 2018-05-07 22:24:34 +08:00
tox.ini Remove setup.py check from pep8 job 2018-10-30 11:10:20 -05: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()
[...]