6785f07e7b
This patch introduces a new directory layout in doc/source in conformance with the OpenStack manuals project migration spec [1], moves the existing content in manila/doc/source into the new directories, and adjusts index files accordingly. This is the first step in the migration process as outlined in the spec. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Closes-Bug: #1706181 Change-Id: I8964d066bb838fabbe94239ac108bff884c6ff76 Depends-On: I72be6303f9be77c0461eaacbc61bad8372546fb5 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
52 lines
1.4 KiB
ReStructuredText
52 lines
1.4 KiB
ReStructuredText
The :program:`manila` shell utility
|
|
=========================================
|
|
|
|
.. program:: manila
|
|
.. highlight:: bash
|
|
|
|
The :program:`manila` shell utility interacts with the OpenStack Manila API
|
|
from the command line. It supports the entirety of the OpenStack Manila API.
|
|
|
|
You'll need to provide :program:`manila` with your OpenStack username and API
|
|
key. You can do this with the `--os-username`, `--os-password` and
|
|
`--os-tenant-name` options, but it's easier to just set them as environment
|
|
variables by setting two environment variables:
|
|
|
|
.. envvar:: OS_USERNAME or MANILA_USERNAME
|
|
|
|
Your OpenStack Manila username.
|
|
|
|
.. envvar:: OS_PASSWORD or MANILA_PASSWORD
|
|
|
|
Your password.
|
|
|
|
.. envvar:: OS_TENANT_NAME or MANILA_PROJECT_ID
|
|
|
|
Project for work.
|
|
|
|
.. envvar:: OS_AUTH_URL or MANILA_URL
|
|
|
|
The OpenStack API server URL.
|
|
|
|
.. envvar:: OS_SHARE_API_VERSION
|
|
|
|
The OpenStack Shared Filesystems API version.
|
|
|
|
For example, in Bash you'd use::
|
|
|
|
export OS_USERNAME=foo
|
|
export OS_PASSWORD=bar
|
|
export OS_TENANT_NAME=foobarproject
|
|
export OS_AUTH_URL=http://...
|
|
export OS_SHARE_API_VERSION=2
|
|
|
|
From there, all shell commands take the form::
|
|
|
|
manila <command> [arguments...]
|
|
|
|
Run :program:`manila help` to get a full list of all possible commands,
|
|
and run :program:`manila help <command>` to get detailed help for that
|
|
command.
|
|
|
|
.. include:: ../cli/manila_cli_output.rst.inc
|