Merge "User Guide: document the manual creation of openrc.sh"

doc/common/section_cli_install.xml

@@ -196,7 +196,7 @@
             </step>
             <step>
                 <para>Before you can issue client commands, you must
-                    download and source the
+                    create and source the
                         <filename>openrc</filename> file to set
                     environment variables. See <xref
                         linkend="cli_openrc"/>.</para>

doc/common/section_cli_openrc.xml

@@ -3,20 +3,19 @@
     xmlns:xi="http://www.w3.org/2001/XInclude"
     xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
     xml:id="cli_openrc">
-    <title>Download and source the OpenStack RC file</title>
+    <title>Create and source the OpenStack RC file</title>
     <para>To set the required environment variables for the OpenStack
-        command-line clients, you must download and source an
+        command-line clients, you must either create or download an environment
-        environment file, <filename>openrc.sh</filename>. It is
+        file, and source it. It is project-specific and contains the
-        project-specific and contains the credentials used by
+        credentials used by all OpenStack services.</para>
-        OpenStack Compute, Image, and Identity services.</para>
+    <para>When you source the file, environment variables are set for your
-    <para>When you source the file and enter the password, environment
+        current shell. They allow the commands to communicate to the OpenStack
-        variables are set for that shell. They allow the commands to
+        services that run in the cloud.</para>
-        communicate to the OpenStack services that run in the
+
-        cloud.</para>
+    <para>If your OpenStack installation provides it, you can download the file
-    <para>You can download the file from the OpenStack dashboard as an
+        from the OpenStack dashboard as an administrative user or any other
-        administrative user or any other user.</para>
+        user.</para>
     <procedure>
-   <!--     <title>To download the OpenStack RC file</title> -->
         <step>
             <para>Log in to the OpenStack dashboard, choose the
                 project for which you want to download the OpenStack
@@ -57,4 +56,32 @@
                 your password.</para>
         </step>
     </procedure>
+
+    <para>Alternatively, you can create the <filename>openrc.sh</filename> file from scratch.</para>
+    <procedure>
+        <step>
+            <para>Create the file <filename>openrc.sh</filename> containing the
+              authentication:</para>
+            <programlisting language="bash">export OS_USERNAME=<replaceable>USERNAME</replaceable>
+export OS_PASSWORD=<replaceable>PASSWORD</replaceable>
+export OS_TENANT_NAME=<replaceable>PROJECT_NAME</replaceable>
+export OS_AUTH_URL=<replaceable>https://IDENTITY_HOST:PORT/v2.0</replaceable>
+# The following lines can be omitted
+export OS_TENANT_ID=<replaceable>9d792532ffce494583138c495801d164</replaceable>
+export OS_REGION_NAME=<replaceable>RegionOne</replaceable></programlisting>
+        </step>
+        <step>
+            <para>On any shell from where you want to run OpenStack
+              commands, source the <filename>openrc.sh</filename>
+              file for the respective project.</para>
+            <screen><prompt>$</prompt> <userinput>source openrc.sh</userinput></screen>
+        </step>
+    </procedure>
+    <note>
+        <para>The password will not be prompted with this method, but lives in
+        clear text in the <filename>openrc.sh</filename> file. Restrict the
+        permissions on this file to avoid security problems. You can also
+        remove the <literal>OS_PASSWORD</literal> variable from the file, and
+        use the <literal>--password</literal> option of OpenStack clients.</para>
+    </note>
 </section>