1721e2871d
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Set openstackdocs_auto_name to use 'project' as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I1d02403727831c29f3a38cfc11949325614ac7d0 |
||
|---|---|---|
| contrib/ci | ||
| doc | ||
| etc | ||
| manilaclient | ||
| playbooks/legacy/manilaclient-dsvm-neutron-functional | ||
| rally-jobs | ||
| releasenotes | ||
| tools | ||
| .gitignore | ||
| .gitreview | ||
| .stestr.conf | ||
| .zuul.yaml | ||
| CONTRIBUTING.rst | ||
| HACKING | ||
| LICENSE | ||
| README.rst | ||
| 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=fooprojectYou 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