Merge "Improve authentication documentation"

This commit is contained in:
Jenkins 2017-03-01 22:20:49 +00:00 committed by Gerrit Code Review
commit 5e7ede3363
1 changed files with 5 additions and 20 deletions

View File

@ -13,26 +13,6 @@ Authentication method
You'll need to provide the authentication method and your credentials to You'll need to provide the authentication method and your credentials to
:program:`gnocchi`. :program:`gnocchi`.
You can do this with the :option:`--os-username`, :option:`--os-password`,
:option:`--os-tenant-id` and :option:`--os-auth-url` options, but it's easier
to just set them as environment variables:
.. envvar:: OS_USERNAME
Your username.
.. envvar:: OS_PASSWORD
Your password.
.. envvar:: OS_TENANT_NAME
Project to work on.
.. envvar:: OS_AUTH_URL
The OpenStack auth server URL (Keystone).
No authentication No authentication
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -72,6 +52,7 @@ OpenStack Keystone authentication
If you're using Gnocchi with Keystone authentication, export the following If you're using Gnocchi with Keystone authentication, export the following
variables in your environment with the appropriate values:: variables in your environment with the appropriate values::
export OS_AUTH_TYPE=password
export OS_USERNAME=user export OS_USERNAME=user
export OS_PASSWORD=pass export OS_PASSWORD=pass
export OS_TENANT_NAME=myproject export OS_TENANT_NAME=myproject
@ -87,6 +68,10 @@ variables::
export OS_AUTH_PLUGIN=token export OS_AUTH_PLUGIN=token
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
For more details, check the `keystoneauth documentation`_.
.. _`keystoneauth documentation` https://docs.openstack.org/developer/keystoneauth/
Commands descriptions Commands descriptions
+++++++++++++++++++++ +++++++++++++++++++++