Rearrange existing documentation to fit the new standard layout
The layout is configured to follow the design from this spec: https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html This change is necessary to continue the doc migration process. Change-Id: I5ab2e47b67baf90bdd808cb831493a010d23a070
This commit is contained in:
@@ -28,8 +28,8 @@ Alternatively, you can create a client instance using the keystoneauth session A
|
|||||||
>>> cinder.volumes.list()
|
>>> cinder.volumes.list()
|
||||||
[]
|
[]
|
||||||
|
|
||||||
Command-line Tool
|
User Guides
|
||||||
=================
|
===========
|
||||||
In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables::
|
In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables::
|
||||||
|
|
||||||
export OS_USERNAME=user
|
export OS_USERNAME=user
|
||||||
@@ -41,6 +41,28 @@ Once you've configured your authentication parameters, you can run ``cinder help
|
|||||||
|
|
||||||
See also :doc:`/cli/index` for detailed documentation.
|
See also :doc:`/cli/index` for detailed documentation.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
user/cinder
|
||||||
|
|
||||||
|
Command-Line Reference
|
||||||
|
======================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
cli/shell
|
||||||
|
cli/no_auth
|
||||||
|
|
||||||
|
Developer Guides
|
||||||
|
================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
contributor/functional_tests
|
||||||
|
contributor/unit_tests
|
||||||
|
|
||||||
Release Notes
|
Release Notes
|
||||||
=============
|
=============
|
||||||
|
58
doc/source/user/cinder.rst
Normal file
58
doc/source/user/cinder.rst
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
==============================
|
||||||
|
:program:`cinder` CLI man page
|
||||||
|
==============================
|
||||||
|
|
||||||
|
.. program:: cinder
|
||||||
|
.. highlight:: bash
|
||||||
|
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
========
|
||||||
|
|
||||||
|
:program:`cinder` [options] <command> [command-options]
|
||||||
|
|
||||||
|
:program:`cinder help`
|
||||||
|
|
||||||
|
:program:`cinder help` <command>
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
|
||||||
|
The :program:`cinder` command line utility interacts with OpenStack Block
|
||||||
|
Storage Service (Cinder).
|
||||||
|
|
||||||
|
In order to use the CLI, you must provide your OpenStack username, password,
|
||||||
|
project (historically called tenant), and auth endpoint. You can use
|
||||||
|
configuration options :option:`--os-username`, :option:`--os-password`,
|
||||||
|
:option:`--os-tenant-name` or :option:`--os-tenant-id`, and
|
||||||
|
:option:`--os-auth-url` or set corresponding environment variables::
|
||||||
|
|
||||||
|
export OS_USERNAME=user
|
||||||
|
export OS_PASSWORD=pass
|
||||||
|
export OS_TENANT_NAME=myproject
|
||||||
|
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
|
||||||
|
|
||||||
|
You can select an API version to use by :option:`--os-volume-api-version`
|
||||||
|
option or by setting corresponding environment variable::
|
||||||
|
|
||||||
|
export OS_VOLUME_API_VERSION=2
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
To get a list of available commands and options run::
|
||||||
|
|
||||||
|
cinder help
|
||||||
|
|
||||||
|
To get usage and options of a command::
|
||||||
|
|
||||||
|
cinder help <command>
|
||||||
|
|
||||||
|
|
||||||
|
BUGS
|
||||||
|
====
|
||||||
|
|
||||||
|
Cinder client is hosted in Launchpad so you can view current bugs at
|
||||||
|
https://bugs.launchpad.net/python-cinderclient/.
|
Reference in New Issue
Block a user