openstack/python-openstackclient
Code Issues Proposed changes

Document the use of keyring.

Browse Source 
* README.rst
  Document the option --os-use-keyring, and environment variable
  OS_USE_KEYRING, to enable keyring.

Change-Id: I54ceb2d2692fecca328da16f6ed14db8d09a6eb7
This commit is contained in:
Bhuvan Arumugam 2012-08-22 15:57:59 -07:00
parent a5aa06c92f
commit 8010e773ac
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@ -67,6 +67,7 @@ The 'password flow' variation is most commonly used::
export OS_TENANT_NAME=<tenant-name> export OS_TENANT_NAME=<tenant-name>
export OS_USERNAME=<user-name> export OS_USERNAME=<user-name>
export OS_PASSWORD=<password> # (optional) export OS_PASSWORD=<password> # (optional)
export OS_USE_KEYRING=true # (optional)
The corresponding command-line options look very similar:: The corresponding command-line options look very similar::
@ -74,9 +75,12 @@ The corresponding command-line options look very similar::
--os-tenant-name <tenant-name> --os-tenant-name <tenant-name>
--os-username <user-name> --os-username <user-name>
[--os-password <password>] [--os-password <password>]
[--os-use-keyring]
If a password is not provided above (in plaintext), you will be interactively If a password is not provided above (in plaintext), you will be interactively
prompted to provide one securely. prompted to provide one securely. If keyring is enabled, the password entered
in the prompt is stored in keyring. From next time, the password is read from
keyring, if it is not provided above (in plaintext).
The token flow variation for authentication uses an already-aquired token The token flow variation for authentication uses an already-aquired token
and a URL pointing directly to the service API that presumably was acquired and a URL pointing directly to the service API that presumably was acquired