Merge "Cleanup the home page"
This commit is contained in:
		| @@ -1,7 +1,4 @@ | ||||
| ================== | ||||
| CINDERCLIENT Tests | ||||
| ================== | ||||
|  | ||||
| ================ | ||||
| Functional Tests | ||||
| ================ | ||||
|  | ||||
|   | ||||
| @@ -1,7 +1,4 @@ | ||||
| ================== | ||||
| CINDERCLIENT Tests | ||||
| ================== | ||||
|  | ||||
| ========== | ||||
| Unit Tests | ||||
| ========== | ||||
|  | ||||
|   | ||||
| @@ -34,41 +34,25 @@ API:: | ||||
|     [] | ||||
|  | ||||
| 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:: | ||||
|  | ||||
|     export OS_USERNAME=user | ||||
|     export OS_PASSWORD=pass | ||||
|     export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b | ||||
|     export OS_AUTH_URL=http://auth.example.com:5000/v2.0 | ||||
|  | ||||
| Once you've configured your authentication parameters, you can run ``cinder | ||||
| help`` to see a complete listing of available commands. | ||||
|  | ||||
| See also :doc:`/cli/index` for detailed documentation. | ||||
| ~~~~~~~~~~~ | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|  | ||||
|    user/cinder | ||||
|    user/shell | ||||
|    user/no_auth | ||||
|  | ||||
| Command-Line Reference | ||||
| ====================== | ||||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|  | ||||
|    cli/index | ||||
|    cli/details | ||||
|    user/shell | ||||
|    user/no_auth | ||||
|  | ||||
| Developer Guides | ||||
| ================ | ||||
| ~~~~~~~~~~~~~~~~ | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
| @@ -77,7 +61,7 @@ Developer Guides | ||||
|    contributor/unit_tests | ||||
|  | ||||
| Release Notes | ||||
| ============= | ||||
| ~~~~~~~~~~~~~ | ||||
|  | ||||
| All python-cinderclient release notes can now be found on the `release notes`_ | ||||
| page. | ||||
|   | ||||
| @@ -1,58 +0,0 @@ | ||||
| ============================== | ||||
| :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 `--os-username`, `--os-password`, `--os-tenant-name` or | ||||
| `--os-tenant-id`, and `--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/v3 | ||||
|  | ||||
| You can select an API version to use by `--os-volume-api-version` | ||||
| option or by setting corresponding environment variable:: | ||||
|  | ||||
|     export OS_VOLUME_API_VERSION=3 | ||||
|  | ||||
|  | ||||
| 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/. | ||||
| @@ -1,6 +1,6 @@ | ||||
| ========================= | ||||
| CINDERCLIENT Using noauth | ||||
| ========================= | ||||
| ============ | ||||
| Using noauth | ||||
| ============ | ||||
|  | ||||
| Cinder Server side API setup | ||||
| ============================ | ||||
|   | ||||
		Reference in New Issue
	
	Block a user
	 Zuul
					Zuul