openstack/python-manilaclient
Code Issues Proposed changes
Python bindings for Manila
800 Commits 10 Branches 56 Tags 26 MiB
Python 99.8%
Shell 0.2%
6bccfc0d6e
Go to file
Victoria Martinez de la Cruz 6bccfc0d6e Put osc unit tests with all other unit tests 
Having osc in an upper level module meant that
all osc unit tests were not being run.

We had two options: either create a new job purely
for osc unit tests or put all tests on the same module.

The latter made more sense for simplicity reasons (KISS)

Change-Id: Iabf76d8ac7ef886d736f3e30d466fe3f992287da
2020-02-03 13:39:48 +00:00
contrib/ci Add CLI commands for Manage-Unmanage of Share Servers 2019-03-06 14:41:47 -05:00
doc Merge "[ussuri][goal] Drop python2.7 support" 2019-12-13 10:52:34 +00:00
etc Implement functionality for functional tests using tempest-lib 2014-11-12 13:05:24 +02:00
manilaclient Put osc unit tests with all other unit tests 2020-02-03 13:39:48 +00:00
playbooks/legacy/manilaclient-dsvm-neutron-functional OpenDev Migration Patch 2019-04-19 19:44:14 +00:00
rally-jobs Add rally job manifests 2017-07-31 19:57:48 -04:00
releasenotes [ussuri][goal] Drop python2.7 support 2019-12-08 21:04:14 -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 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
.zuul.yaml [ussuri][goal] Drop python2.7 support 2019-12-08 21:04:14 -08: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 [OSC] Init OpenStack Client implementation 2019-11-21 09:56:38 +00:00
README.rst Add PDF documentation build 2019-09-13 14:00:46 -04:00
requirements.txt [OSC] Init OpenStack Client implementation 2019-11-21 09:56:38 +00:00
run_tests.sh Remove nonexistent directory "tests" from pep8 scanning 2015-01-06 14:47:01 +02:00
setup.cfg Merge "[OSC] Init OpenStack Client implementation" 2019-12-19 21:30:24 +00: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 [ussuri][goal] Drop python2.7 support 2019-12-08 21:04:14 -08: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()
[...]