From e9cf54c1f538435608d6a217218fffb90cfe0189 Mon Sep 17 00:00:00 2001
From: Matt Kassawara <mkassawara@gmail.com>
Date: Fri, 10 Jan 2014 17:36:00 -0700
Subject: [PATCH] Clarified database configuration steps for Block Storage

I clarified the database configuration steps for Block Storage for
consistency with the associated patch applied to Havana. I also added
a note for Ubuntu users to add the '[database]' section header if not
included with the default "cinder.conf" file. This patch covers both
the controller and storage nodes.

Change-Id: I6ae7072b2a98db00a6367213721f883072f8348b
---
 .../section_cinder-controller.xml             | 26 +++++++++----------
 doc/install-guide/section_cinder-node.xml     | 21 ++++++++-------
 2 files changed, 23 insertions(+), 24 deletions(-)

diff --git a/doc/install-guide/section_cinder-controller.xml b/doc/install-guide/section_cinder-controller.xml
index c8a87e1025..2e30496290 100644
--- a/doc/install-guide/section_cinder-controller.xml
+++ b/doc/install-guide/section_cinder-controller.xml
@@ -31,24 +31,22 @@
         registration.</para>
     </step>
     <step os="ubuntu;rhel;centos;fedora;opensuse;sles">
-      <para>The Block Storage Service stores volume information in a
-        database. The examples in this section use the MySQL database
-        that is used by other OpenStack services.</para>
-      <para>Configure the Block Storage Service to use the database.
-        Replace
-          <literal><replaceable>CINDER_DBPASS</replaceable></literal>
-        with a password of your choice.</para>
+      <para>Configure Block Storage to use your MySQL database. Edit the
+        <filename>/etc/cinder/cinder.conf</filename> file and add the
+        following key under the <literal>[database]</literal> section.
+        Replace <replaceable>CINDER_DBPASS</replaceable> with the password
+        for the Block Storage database that you will create in a later step.
+      </para>
+      <note os="ubuntu"><para>The <filename>/etc/cinder/cinder.conf</filename>
+        file packaged with some distributions does not include the
+        <literal>[database]</literal> section header. You must add this
+        section header to the end of the file before proceeding further.</para>
+      </note>
       <screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/cinder/cinder.conf \
   database connection mysql://cinder:<replaceable>CINDER_DBPASS</replaceable>@<replaceable>controller</replaceable>/cinder</userinput></screen>
-      <para os="ubuntu">Edit
-          <filename>/etc/cinder/cinder.conf</filename> and change the
-          <literal>[database]</literal> section.</para>
       <programlisting os="ubuntu" language="ini">[database]
 ...
-# The SQLAlchemy connection string used to connect to the
-# database (string value)
-connection = mysql://cinder:CINDER_DBPASS@localhost/cinder
-...</programlisting>
+connection = mysql://cinder:<replaceable>CINDER_DBPASS</replaceable>@<replaceable>controller</replaceable>/cinder</programlisting>
     </step>
     <step os="rhel;centos;fedora;opensuse;sles">
       <para>To create the Block Storage Service database and tables
diff --git a/doc/install-guide/section_cinder-node.xml b/doc/install-guide/section_cinder-node.xml
index 752610da0d..71dcfe8aa6 100644
--- a/doc/install-guide/section_cinder-node.xml
+++ b/doc/install-guide/section_cinder-node.xml
@@ -149,21 +149,22 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
 <prompt>#</prompt> <userinput>openstack-config --set /etc/cinder/cinder.conf \
   DEFAULT rabbit_password <replaceable>RABBIT_PASS</replaceable></userinput></screen>
     </step>
-
     <step os="ubuntu;rhel;centos;fedora;opensuse;sles">
-      <para>Configure the Block Storage Service on this node to use
-        the Cinder database on the controller node:</para>
+      <para>Configure Block Storage to use your MySQL database. Edit the
+        <filename>/etc/cinder/cinder.conf</filename> file and add the following
+        key under the <literal>[database]</literal> section. Replace
+        <replaceable>CINDER_DBPASS</replaceable> with the password you chose
+        for the Block Storage database.</para>
+      <note os="ubuntu"><para>The <filename>/etc/cinder/cinder.conf</filename>
+        file packaged with some distributions does not include the
+        <literal>[database]</literal> section header. You must add this
+        section header to the end of the file before proceeding further.</para>
+      </note>
       <screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/cinder/cinder.conf \
   database connection mysql://cinder:<replaceable>CINDER_DBPASS</replaceable>@<replaceable>controller</replaceable>/cinder</userinput></screen>
-      <para os="ubuntu">Edit
-          <filename>/etc/cinder/cinder.conf</filename> and change the
-          <literal>[database]</literal> section:</para>
       <programlisting os="ubuntu" language="ini">[database]
 ...
-# The SQLAlchemy connection string used to connect to the
-# database (string value)
-connection = mysql://cinder:CINDER_DBPASS@controller/cinder
-...</programlisting>
+connection = mysql://cinder:<replaceable>CINDER_DBPASS</replaceable>@<replaceable>controller</replaceable>/cinder</programlisting>
     </step>