openstack/openstack-manuals
Code Issues Proposed changes

Update basic environment content for Juno

Browse Source 
I updated the basic environment content in the installation
guide for Juno as follows:

1) Collapsed database section because it only includes procedures
   for the controller. Although the diagrams show the database on
   the controller node, I added some text to remind users.
2) Reorganized sections to improve flow. For example, moving the
   security section closer to the beginning of the chapter.

Change-Id: Icd43c2530982d356067c8a77ba4a744a2c63e0e4
This commit is contained in:
Matthew Kassawara 2014-10-27 12:52:45 -05:00
parent 5f467acdd8
commit 5c3d16331a
2 changed files with 70 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/install-guide/ch_basic_environment.xml
View File

@ -45,10 +45,10 @@
</para> </para>
</note> </note>
<xi:include href="section_basics-prerequisites.xml"/> <xi:include href="section_basics-prerequisites.xml"/>
<xi:include href="section_basics-security.xml"/>
<xi:include href="section_basics-networking.xml"/> <xi:include href="section_basics-networking.xml"/>
<xi:include href="section_basics-ntp.xml"/> <xi:include href="section_basics-ntp.xml"/>
<xi:include href="section_basics-security.xml"/>
<xi:include href="section_basics-database.xml"/>
<xi:include href="section_basics-packages.xml"/> <xi:include href="section_basics-packages.xml"/>
<xi:include href="section_basics-database.xml"/>
<xi:include href="section_basics-queue.xml"/> <xi:include href="section_basics-queue.xml"/>
</chapter> </chapter>

138
doc/install-guide/section_basics-database.xml
View File

@ -7,87 +7,85 @@
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<title>Database</title> <title>Database</title>
<para>Most OpenStack services use an SQL database to store information. <para>Most OpenStack services use an SQL database to store information.
The procedures in this guide use <application>MariaDB</application> The database typically runs on the controller node. The procedures in
or <application>MySQL</application> depending on the distribution. this guide use <application>MariaDB</application> or
<application>MySQL</application> depending on the distribution.
OpenStack services also support other SQL databases including OpenStack services also support other SQL databases including
<link xlink:href="http://www.postgresql.org/">PostgreSQL</link>.</para> <link xlink:href="http://www.postgresql.org/">PostgreSQL</link>.</para>
<section xml:id="basics-database-controller-node"> <procedure>
<title>Controller node</title> <title>To install and configure the database server</title>
<procedure> <step>
<title>To install and configure the database server</title> <para>Install the packages:</para>
<step> <note os="ubuntu;rhel;centos;fedora;opensuse">
<para>Install the packages:</para> <para>The Python MySQL library is compatible with MariaDB.</para>
<note os="ubuntu;rhel;centos;fedora;opensuse"> </note>
<para>The Python MySQL library is compatible with MariaDB.</para> <screen os="ubuntu"><prompt>#</prompt> <userinput>apt-get install mariadb-server python-mysqldb</userinput></screen>
</note> <screen os="debian"><prompt>#</prompt> <userinput>apt-get install mysql-server python-mysqldb</userinput></screen>
<screen os="ubuntu"><prompt>#</prompt> <userinput>apt-get install mariadb-server python-mysqldb</userinput></screen> <screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>yum install mariadb mariadb-server MySQL-python</userinput></screen>
<screen os="debian"><prompt>#</prompt> <userinput>apt-get install mysql-server python-mysqldb</userinput></screen> <para os="sles;opensuse">On openSUSE:</para>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>yum install mariadb mariadb-server MySQL-python</userinput></screen> <screen os="opensuse"><prompt>#</prompt> <userinput>zypper install mariadb-client mariadb python-mysql</userinput></screen>
<para os="sles;opensuse">On openSUSE:</para> <para os="sles;opensuse">On SLES:</para>
<screen os="opensuse"><prompt>#</prompt> <userinput>zypper install mariadb-client mariadb python-mysql</userinput></screen> <screen os="sles"><prompt>#</prompt> <userinput>zypper install mysql-client mysql python-mysql</userinput></screen>
<para os="sles;opensuse">On SLES:</para> </step>
<screen os="sles"><prompt>#</prompt> <userinput>zypper install mysql-client mysql python-mysql</userinput></screen> <step os="ubuntu;debian">
</step> <para>Choose a suitable password for the database root account.</para>
<step os="ubuntu;debian"> </step>
<para>Choose a suitable password for the database root account.</para> <step>
</step> <para os="ubuntu;debian">Edit the
<step> <filename>/etc/mysql/my.cnf</filename> file and complete the
<para os="ubuntu;debian">Edit the following actions:</para>
<filename>/etc/mysql/my.cnf</filename> file and complete the <para os="rhel;centos;fedora;sles;opensuse">Edit the
following actions:</para> <filename>/etc/my.cnf</filename> file and complete the following
<para os="rhel;centos;fedora;sles;opensuse">Edit the actions:</para>
<filename>/etc/my.cnf</filename> file and complete the following <substeps>
actions:</para> <step>
<substeps> <para>In the <literal>[mysqld]</literal> section, set the
<step> <literal>bind-address</literal> key to the management IP
<para>In the <literal>[mysqld]</literal> section, set the address of the controller node to enable access by other
<literal>bind-address</literal> key to the management IP nodes via the management network:</para>
address of the controller node to enable access by other <programlisting language="ini">[mysqld]
nodes via the management network:</para>
<programlisting language="ini">[mysqld]
... ...
bind-address = 10.0.0.11</programlisting> bind-address = 10.0.0.11</programlisting>
</step> </step>
<step> <step>
<para>In the <literal>[mysqld]</literal> section, set the <para>In the <literal>[mysqld]</literal> section, set the
following keys to enable useful options and the UTF-8 following keys to enable useful options and the UTF-8
character set:</para> character set:</para>
<programlisting language="ini">[mysqld] <programlisting language="ini">[mysqld]
... ...
default-storage-engine = innodb default-storage-engine = innodb
innodb_file_per_table innodb_file_per_table
collation-server = utf8_general_ci collation-server = utf8_general_ci
init-connect = 'SET NAMES utf8' init-connect = 'SET NAMES utf8'
character-set-server = utf8</programlisting> character-set-server = utf8</programlisting>
</step> </step>
</substeps> </substeps>
</step> </step>
</procedure> </procedure>
<procedure> <procedure>
<title>To finalize installation</title> <title>To finalize installation</title>
<step os="ubuntu;debian"> <step os="ubuntu;debian">
<para>Restart the database service:</para> <para>Restart the database service:</para>
<screen><prompt>#</prompt> <userinput>service mysql restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service mysql restart</userinput></screen>
</step> </step>
<step os="rhel;centos;fedora;sles;opensuse"> <step os="rhel;centos;fedora;sles;opensuse">
<para>Start the database service and configure it to start when the <para>Start the database service and configure it to start when the
system boots:</para> system boots:</para>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>systemctl enable mariadb.service</userinput> <screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>systemctl enable mariadb.service</userinput>
<prompt>#</prompt> <userinput>systemctl start mariadb.service</userinput></screen> <prompt>#</prompt> <userinput>systemctl start mariadb.service</userinput></screen>
<para os="sles;opensuse">On SLES:</para> <para os="sles;opensuse">On SLES:</para>
<screen os="sles"><prompt>#</prompt> <userinput>service mysql start</userinput> <screen os="sles"><prompt>#</prompt> <userinput>service mysql start</userinput>
<prompt>#</prompt> <userinput>chkconfig mysql on</userinput></screen> <prompt>#</prompt> <userinput>chkconfig mysql on</userinput></screen>
<para os="sles;opensuse">On openSUSE:</para> <para os="sles;opensuse">On openSUSE:</para>
<screen os="opensuse"><prompt>#</prompt> <userinput>systemctl start mysql.service</userinput> <screen os="opensuse"><prompt>#</prompt> <userinput>systemctl start mysql.service</userinput>
<prompt>#</prompt> <userinput>systemctl enable mysql.service</userinput></screen> <prompt>#</prompt> <userinput>systemctl enable mysql.service</userinput></screen>
</step> </step>
<step> <step>
<para os="ubuntu;debian">Secure the database service:</para> <para os="ubuntu;debian">Secure the database service:</para>
<para os="rhel;centos;fedora;sles;opensuse">Secure the database <para os="rhel;centos;fedora;sles;opensuse">Secure the database
service including choosing a suitable password for the root service including choosing a suitable password for the root
account:</para> account:</para>
<screen><prompt>#</prompt> <userinput>mysql_secure_installation</userinput></screen> <screen><prompt>#</prompt> <userinput>mysql_secure_installation</userinput></screen>
</step> </step>
</procedure> </procedure>
</section>
</section> </section>