7f7d7d32dc
This enables writing ids to a local completion
cache when using the manilaclient shell, which
allows tools/manila.bash_completion to complete
commands such as:
manila delete a<tab>
Share ids are recorded on "manila list" operations.
Caching can be expanded to cover additional
types of manila objects using this same infrastructure.
Uses ~/.cache/manilaclient/ to match path standards,
and uses SHA-1 since Python running w/ FIPS mode may
not have MD5.
Also, fix a small bug in the fakes used in our test suite.
We were adding the shares count (an optional param) to all
the list responses, while this is something that should be done
only if the param with_count is set to True.
Co-Authored-By: Victoria Martinez de la Cruz <victoria@redhat.com>
Closes-Bug: #1712835
Change-Id: I7f4dedf1dd4b7db6cf24fc1c4ed2a8d3685f714c
(cherry picked from commit
|
||
---|---|---|
doc | ||
etc | ||
manilaclient | ||
playbooks/python-manilaclient-functional | ||
rally-jobs | ||
releasenotes | ||
roles/populate-manilaclient-config | ||
tools | ||
zuul.d | ||
.gitignore | ||
.gitreview | ||
.stestr.conf | ||
CONTRIBUTING.rst | ||
HACKING | ||
LICENSE | ||
README.rst | ||
bindep.txt | ||
lower-constraints.txt | ||
requirements.txt | ||
run_tests.sh | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
README.rst
Team and repository tags
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()
[...]
- License: Apache License, Version 2.0
- PyPi - package installation
- Online Documentation
- Launchpad project - release management
- Blueprints - feature specifications
- Bugs - issue tracking
- Source
- How to Contribute
- Release Notes