openstack/openstack-manuals
Code Issues Proposed changes

Removes a Keyring support section from End User Guide

Browse Source 
As keyring encryption support was removed from openstackclient code,
the End User Guide was updated as well by removing Keyring support
section from appropriate chapter in the user guide.

Change-Id: I9531b460be9a4dd2d6c1aedb33324fd9140a4538
Closes-Bug: #1419990
This commit is contained in:
Olena Logvinova 2015-03-11 17:56:23 +02:00
parent 0e5118fc20
commit a471a63a96
2 changed files with 10 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/common/section_cli_openrc.xml
View File

@ -136,6 +136,15 @@ export OS_CACERT=<replaceable>/path/to/cacertFile</replaceable></programlisting>
follows:</para>
<screen><prompt>$</prompt> <userinput>keystone --os-password <replaceable>PASSWORD</replaceable> service-list</userinput></screen>
<para>Where <replaceable>PASSWORD</replaceable> is your password.</para>
<para>A user specifies their username and password credentials to interact
with OpenStack, using any client command. These credentials can be specified
using various mechanisms, namely, the environment variable or command-line argument.
It is not safe to specify the password using either of these methods.</para>
<para>For example, when you specify your password using the command-line client
with the <parameter>--os-password</parameter> argument, anyone with access
to your computer can view it in plain text with the <literal>ps</literal>
field.</para>
<para>To avoid storing the password in plain text, you can prompt for the
OpenStack password interactively.</para>
</section>
<xi:include href="../common/section_keystone-keyring-support.xml"/>
</section>

28
doc/common/section_keystone-keyring-support.xml
View File

@ -1,28 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="section_keystone-keyring-support">
<title>Keyring support</title>
<para>Keyring is a password management system available in OpenStack.
You can install it using the following command:</para>
<screen><prompt>$</prompt> <userinput>pip install keyring</userinput></screen>
<note>
<para>Keyring is used only if <parameter>--os-use-keyring</parameter>
is specified or if the environment variable
<option>OS_USE_KEYRING=true</option> is defined.</para>
</note>
<para>A user specifies their username and password credentials to interact
with OpenStack, using any client command. These credentials can be specified
using various mechanisms, namely, the environment variable, or command line argument.
It is not safe to specify the password using either of these methods.</para>
<para>For example, when you specify your password using the command-line client
with the <parameter>--os-password</parameter> argument, anyone with access
to your computer can view it in plain text with the <literal>ps</literal>
field.</para>
<para>To avoid storing the password in plain text, you can prompt for the
OpenStack password interactively. Then, the keyring can store the password
and the user can safely retrieve it from their keyring. The encrypted password
is stored in the <filename>~/.openstack-keyring.cfg</filename> file.</para>
</section>