From ed880fdd29803291311414aad4581401a8e0896f Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Tue, 21 Feb 2017 22:18:30 +0100 Subject: [PATCH] Improve authentication documentation Remove confusing documentation about variables, add OS_AUTH_TYPE for password authentication and add link to keystoneauth doc. Change-Id: I5adcb23e18ae03ffd7d37a5604e93d0bd412e78b Closes-Bug: #1666617 --- doc/source/shell.rst | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/doc/source/shell.rst b/doc/source/shell.rst index be1f714..f2dece7 100644 --- a/doc/source/shell.rst +++ b/doc/source/shell.rst @@ -13,26 +13,6 @@ Authentication method You'll need to provide the authentication method and your credentials to :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 ~~~~~~~~~~~~~~~~~ @@ -72,6 +52,7 @@ OpenStack Keystone authentication If you're using Gnocchi with Keystone authentication, export the following variables in your environment with the appropriate values:: + export OS_AUTH_TYPE=password export OS_USERNAME=user export OS_PASSWORD=pass export OS_TENANT_NAME=myproject @@ -87,6 +68,10 @@ variables:: export OS_AUTH_PLUGIN=token export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 +For more details, check the `keystoneauth documentation`_. + +.. _`keystoneauth documentation` https://docs.openstack.org/developer/keystoneauth/ + Commands descriptions +++++++++++++++++++++