openstack
/
python-manilaclient
Code Issues Proposed changes
Python bindings for Manila
786 Commits 9 Branches 51 Tags 25 MiB
Python 99.8%
Shell 0.2%
Go to file
haixin cc401e5333 Add update share-type to SDK and CLI 
Currently, only the name and description and public access of share-type
is set when the share-type is created, and not allowed to be edited
after the share-type is created. We can only set extra spec for share-type.
But not name or description or public access for share-type.

Change-Id: Ia0df0d46e11d0438e16fc910fc377f9dd4e85521
Partially-Implements: blueprint update-share-type-name-or-description
Depends-On: https://review.opendev.org/669651
 		2019-09-10 13:51:17 -07:00
contrib/ci Add CLI commands for Manage-Unmanage of Share Servers 2019-03-06 14:41:47 -05:00
doc Add "functional tests" documentation 2019-06-12 19:21:23 +00:00
etc Implement functionality for functional tests using tempest-lib 2014-11-12 13:05:24 +02:00
manilaclient Add update share-type to SDK and CLI 2019-09-10 13:51:17 -07: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 Add update share-type to SDK and CLI 2019-09-10 13:51:17 -07: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 Add Python 3 Train unit tests 2019-07-05 11:54:21 -04: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
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-28 13:56:09 +08:00
lower-constraints.txt Drop 'clidoc' from sphinx extensions 2018-08-23 19:21:34 -07:00
requirements.txt Remove docutils requirement 2019-03-11 05:37:35 -04:00
run_tests.sh Remove nonexistent directory "tests" from pep8 scanning 2015-01-06 14:47:01 +02:00
setup.cfg Add Python 3 Train unit tests 2019-07-05 11:54:21 -04: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 Add Python 3 Train unit tests 2019-07-05 11:54:21 -04: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()
[...]