From fbb5c854ff04d5949fbacac3d897d8e3847dc842 Mon Sep 17 00:00:00 2001
From: Matthew Kassawara <mkassawara@gmail.com>
Date: Fri, 11 Jul 2014 15:46:50 +0000
Subject: [PATCH] Improve install guide openrc content

Improve openrc content in the installation guide as follows:

1) Add new openrc section to keystone chapter
2) Remove clients chapter

This patch implements changes approved for other patches associated
with this blueprint.

Change-Id: I075671cb0b432ce73addb972a0d709f9a4655114
Implements: blueprint installation-guide-improvements
---
 .../bk-openstack-install-guide.xml            |  1 -
 doc/install-guide/ch_keystone.xml             |  1 +
 doc/install-guide/section_keystone-openrc.xml | 52 +++++++++++++++++++
 3 files changed, 53 insertions(+), 1 deletion(-)
 create mode 100644 doc/install-guide/section_keystone-openrc.xml

diff --git a/doc/install-guide/bk-openstack-install-guide.xml b/doc/install-guide/bk-openstack-install-guide.xml
index c46527771b..52a7a67535 100644
--- a/doc/install-guide/bk-openstack-install-guide.xml
+++ b/doc/install-guide/bk-openstack-install-guide.xml
@@ -210,7 +210,6 @@
     <xi:include href="ch_basics.xml"/>
     <xi:include href="ch_debconf.xml"/>
     <xi:include href="ch_keystone.xml"/>
-    <xi:include href="ch_clients.xml"/>
     <xi:include href="ch_glance.xml"/>
     <xi:include href="ch_nova.xml"/>
     <xi:include href="ch_networking.xml"/>
diff --git a/doc/install-guide/ch_keystone.xml b/doc/install-guide/ch_keystone.xml
index d6c612f2fb..ccdfac68a2 100644
--- a/doc/install-guide/ch_keystone.xml
+++ b/doc/install-guide/ch_keystone.xml
@@ -10,4 +10,5 @@
     <xi:include href="section_keystone-users.xml"/>
     <xi:include href="section_keystone-services.xml"/>
     <xi:include href="section_keystone-verify.xml"/>
+    <xi:include href="section_keystone-openrc.xml"/>
 </chapter>
diff --git a/doc/install-guide/section_keystone-openrc.xml b/doc/install-guide/section_keystone-openrc.xml
new file mode 100644
index 0000000000..dbbf9907ef
--- /dev/null
+++ b/doc/install-guide/section_keystone-openrc.xml
@@ -0,0 +1,52 @@
+<?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="keystone-openrc">
+  <title>Create OpenStack client environment scripts</title>
+  <para>The previous section used a combination of environment variables and
+    command options to interact with the Identity service via the
+    <command>keystone</command> client. To increase efficiency of client
+    operations, OpenStack supports simple client environment scripts also
+    known as OpenRC files. These scripts typically contain common options for
+    all clients, but also support unique options. For more information, see the
+    <link xlink:href="http://docs.openstack.org/user-guide/content/cli_openrc.html">OpenStack User Guide</link>.</para>
+  <procedure>
+    <title>To create the scripts</title>
+    <para>Create client environment scripts for the <literal>admin</literal>
+      and <literal>demo</literal> tenants and users. Future portions of this
+      guide reference these scripts to load appropriate credentials for client
+      operations.</para>
+    <step>
+      <para>Edit the <filename>admin-openrc.sh</filename> file and add the
+        following content:</para>
+      <programlisting language="bash">export OS_TENANT_NAME=admin
+export OS_USERNAME=admin
+export OS_PASSWORD=<replaceable>ADMIN_PASS</replaceable>
+export OS_AUTH_URL=http://<replaceable>controller</replaceable>:35357/v2.0</programlisting>
+      <para>Replace <literal>ADMIN_PASS</literal> with the password you chose
+        for the <literal>admin</literal> user in the Identity service.</para>
+    </step>
+    <step>
+      <para>Edit the <filename>demo-openrc.sh</filename> file and add the
+        following content:</para>
+      <programlisting language="bash">export OS_TENANT_NAME=demo
+export OS_USERNAME=demo
+export OS_PASSWORD=<replaceable>DEMO_PASS</replaceable>
+export OS_AUTH_URL=http://<replaceable>controller</replaceable>:5000/v2.0</programlisting>
+      <para>Replace <literal>DEMO_PASS</literal> with the password you chose
+        for the <literal>demo</literal> user in the Identity service.</para>
+    </step>
+  </procedure>
+  <procedure>
+    <title>To load client environment scripts</title>
+    <step>
+      <para>To run clients as a certain tenant and user, you can simply load
+        the associated client environment script prior to running them. For
+        example, to load the location of the Identity service and
+        <literal>admin</literal> tenant and user credentials:</para>
+      <screen><prompt>$</prompt> <userinput>source admin-openrc.sh</userinput></screen>
+    </step>
+  </procedure>
+</section>