Update basic environment content for Juno

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

1) Restructured and clarified OpenStack package procedures.
2) Removed RHEL/CentOS 6.5 special cases and workarounds.
3) Changed RHEL/CentOS to use systemd.
4) Improved SLES/openSUSE sysv/systemd steps.
5) Clarified firewall/security content.
6) Indicated that rebooting is necessary to activate network
   changes on Ubuntu and Debian.
7) Removed Python MySQL library from non-controller nodes
   because the services running on them no longer directly
   interact with the database. I'm looking at you,
   nova-network.
8) Other minor fixes.

Change-Id: If95e6b42e596f55c6a66f2d9ab456b335d3098ca
Implements: blueprint installation-guide-improvements
Closes-Bug: #1373821
This commit is contained in:
Matthew Kassawara 2014-10-02 14:49:14 -05:00
parent dcb890eff0
commit ea823a4f4a
9 changed files with 157 additions and 172 deletions

View File

@ -7311,6 +7311,18 @@
</glossdef>
</glossentry>
<glossentry>
<glossterm>SELinux</glossterm>
<indexterm class="singular">
<primary>SELinux</primary>
</indexterm>
<glossdef>
<para>Linux kernel security module that provides the mechanism for
supporting access control policies.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>server</glossterm>
<indexterm class="singular">

View File

@ -22,8 +22,8 @@
<para>Have a copy of the operating system installation media available
if you are installing on a new server.</para>
<para>These steps assume you have set up repositories for packages for
your operating system as shown in <link linkend="basics-packages"
>OpenStack Packages</link>.</para>
your operating system as shown in
<link linkend="basics-packages"/>.</para>
<para>This document demonstrates how to install a cluster by using the
following types of nodes:</para>
<itemizedlist>

View File

@ -72,8 +72,8 @@ character-set-server = utf8</programlisting>
<step os="rhel;centos;fedora;sles;opensuse">
<para>Start the database service and configure it to start when the
system boots:</para>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>systemctl start mariadb.service</userinput>
<prompt>#</prompt> <userinput>systemctl enable mariadb.service</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>systemctl enable mariadb.service</userinput>
<prompt>#</prompt> <userinput>systemctl start mariadb.service</userinput></screen>
<para os="sles;opensuse">On SLES:</para>
<screen os="sles"><prompt>#</prompt> <userinput>service mysql start</userinput>
<prompt>#</prompt> <userinput>chkconfig mysql on</userinput></screen>
@ -90,12 +90,4 @@ character-set-server = utf8</programlisting>
</step>
</procedure>
</section>
<section xml:id="basics-database-other-nodes">
<title>Other nodes</title>
<para>On nodes other than the controller node, only install the Python
MySQL library:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install python-mysqldb</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install MySQL-python</userinput></screen>
<screen os="sles;opensuse"><prompt>#</prompt> <userinput>zypper install python-mysql</userinput></screen>
</section>
</section>

View File

@ -54,6 +54,9 @@
<para>Network mask: 255.255.255.0 (or /24)</para>
<para>Default gateway: 10.0.0.1</para>
</step>
<step>
<para>Reboot the system to activate the changes.</para>
</step>
</procedure>
<procedure>
<title>To configure name resolution:</title>
@ -133,9 +136,7 @@ BOOTPROTO='static'</programlisting>
</substeps>
</step>
<step>
<para>Restart networking:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>service networking stop &amp;&amp; service networking start</userinput></screen>
<screen os="rhel;centos;fedora;sles;opensuse"><prompt>#</prompt> <userinput>service network restart</userinput></screen>
<para>Reboot the system to activate the changes.</para>
</step>
</procedure>
<procedure>
@ -185,6 +186,9 @@ BOOTPROTO='static'</programlisting>
and so on.</para>
</note>
</step>
<step>
<para>Reboot the system to activate the changes.</para>
</step>
</procedure>
<procedure>
<title>To configure name resolution:</title>

View File

@ -50,6 +50,9 @@
<para>Network mask: 255.255.255.0 (or /24)</para>
<para>Default gateway: 10.0.0.1</para>
</step>
<step>
<para>Reboot the system to activate the changes.</para>
</step>
</procedure>
<procedure>
<title>To configure name resolution:</title>
@ -124,9 +127,7 @@ BOOTPROTO='static'</programlisting>
</substeps>
</step>
<step>
<para>Restart networking:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>service networking stop &amp;&amp; service networking start</userinput></screen>
<screen os="rhel;centos;fedora;sles;opensuse"><prompt>#</prompt> <userinput>service network restart</userinput></screen>
<para>Reboot the system to activate the changes.</para>
</step>
</procedure>
<procedure>

View File

@ -28,19 +28,8 @@
<link os="sles;opensuse"
xlink:href="http://activedoc.opensuse.org/book/opensuse-reference/chapter-13-basic-networking"
>openSUSE documentation.</link></para>
<procedure os="fedora">
<title>To disable <systemitem class="service">NetworkManager</systemitem>
and enable the <systemitem class="service">network</systemitem>
service:</title>
<step>
<screen><prompt>#</prompt> <userinput>service NetworkManager stop</userinput>
<prompt>#</prompt> <userinput>service network start</userinput>
<prompt>#</prompt> <userinput>chkconfig NetworkManager off</userinput>
<prompt>#</prompt> <userinput>chkconfig network on</userinput></screen>
</step>
</procedure>
<procedure os="sles;opensuse">
<title>To disable <systemitem class="service">NetworkManager</systemitem>:</title>
<title>To disable Network Manager:</title>
<step>
<para>Use the YaST network module:</para>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>yast2 network</userinput></screen>
@ -52,28 +41,17 @@
</para>
</step>
</procedure>
<para os="rhel;centos">RHEL and derivatives including CentOS and Scientific
Linux enable a restrictive <glossterm>firewall</glossterm> by default.
During this installation, certain steps will fail unless you alter or
disable the firewall. For further information about securing your
installation, refer to the
<link xlink:href="http://docs.openstack.org/sec/">
OpenStack Security Guide</link>.</para>
<para os="fedora">On Fedora, <literal>firewalld</literal> replaces
<literal>iptables</literal> as the default firewall system. While you
can use <literal>firewalld</literal> successfully, this guide
references <literal>iptables</literal> for compatibility with other
distributions.</para>
<procedure os="fedora">
<title>To disable <literal>firewalld</literal> and enable
<literal>iptables</literal>:</title>
<step>
<screen><prompt>#</prompt> <userinput>service firewalld stop</userinput>
<prompt>#</prompt> <userinput>service iptables start</userinput>
<prompt>#</prompt> <userinput>chkconfig firewalld off</userinput>
<prompt>#</prompt> <userinput>chkconfig iptables on</userinput></screen>
</step>
</procedure>
<para os="rhel;centos">RHEL and CentOS enable a restrictive
<glossterm>firewall</glossterm> by default. During the installation
process, certain steps will fail unless you alter or disable the
firewall. For more information about securing your environment, refer
to the <link xlink:href="http://docs.openstack.org/sec/">OpenStack
Security Guide</link>.</para>
<para os="ubuntu;debian;sles;opensuse">Your distribution does not enable a
restrictive <glossterm>firewall</glossterm> by default. For more
information about securing your environment, refer to the
<link xlink:href="http://docs.openstack.org/sec/">OpenStack
Security Guide</link>.</para>
<para>Proceed to network configuration for the example
<link linkend="basics-networking-neutron">OpenStack Networking (neutron)
</link> or <link linkend="basics-networking-nova">legacy

View File

@ -31,7 +31,7 @@
<para>Edit the <filename>/etc/ntp.conf</filename> file and add,
change, or remove the following keys as necessary for your
environment:</para>
<programlisting>server <replaceable>NTP_SERVER</replaceable> iburst
<programlisting language="ini">server <replaceable>NTP_SERVER</replaceable> iburst
restrict -4 default kod notrap nomodify
restrict -6 default kod notrap nomodify</programlisting>
<para>Replace <replaceable>NTP_SERVER</replaceable> with the
@ -55,10 +55,14 @@ restrict -6 default kod notrap nomodify</programlisting>
<step os="rhel;centos;fedora;sles;opensuse">
<para>Start the NTP service and configure it to start when the system
boots:</para>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>service ntpd start</userinput>
<prompt>#</prompt> <userinput>chkconfig ntpd on</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>service ntp start</userinput>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>systemctl enable ntpd.service</userinput>
<prompt>#</prompt> <userinput>systemctl start ntpd.service</userinput></screen>
<para os="sles">On SLES:</para>
<screen os="sles"><prompt>#</prompt> <userinput>service ntp start</userinput>
<prompt>#</prompt> <userinput>chkconfig ntp on</userinput></screen>
<para os="opensuse">On openSUSE:</para>
<screen os="opensuse"><prompt>#</prompt> <userinput>systemctl enable ntpd.service</userinput>
<prompt>#</prompt> <userinput>systemctl start ntpd.service</userinput></screen>
</step>
</procedure>
</section>
@ -80,7 +84,7 @@ restrict -6 default kod notrap nomodify</programlisting>
<para>Edit the <filename>/etc/ntp.conf</filename> file:</para>
<para>Comment out or remove all but one <literal>server</literal>
key and change it to reference the controller node.</para>
<programlisting>server <replaceable>controller</replaceable> iburst</programlisting>
<programlisting language="ini">server <replaceable>controller</replaceable> iburst</programlisting>
<note os="ubuntu;debian">
<para>Remove the <filename>/var/lib/ntp/ntp.conf.dhcp</filename> file
if it exists.</para>
@ -93,10 +97,14 @@ restrict -6 default kod notrap nomodify</programlisting>
<step os="rhel;centos;fedora;sles;opensuse">
<para>Start the NTP service and configure it to start when the system
boots:</para>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>service ntpd start</userinput>
<prompt>#</prompt> <userinput>chkconfig ntpd on</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>service ntp start</userinput>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>systemctl enable ntpd.service</userinput>
<prompt>#</prompt> <userinput>systemctl start ntpd.service</userinput></screen>
<para os="sles">On SLES:</para>
<screen os="sles"><prompt>#</prompt> <userinput>service ntp start</userinput>
<prompt>#</prompt> <userinput>chkconfig ntp on</userinput></screen>
<para os="opensuse">On openSUSE:</para>
<screen os="opensuse"><prompt>#</prompt> <userinput>systemctl enable ntpd.service</userinput>
<prompt>#</prompt> <userinput>systemctl start ntpd.service</userinput></screen>
</step>
</procedure>
</section>

View File

@ -6,116 +6,75 @@
xml:id="basics-packages">
<?dbhtml stop-chunking?>
<title>OpenStack packages</title>
<para>Distributions might release OpenStack packages as part of
their distribution or through other methods because the
OpenStack and distribution release times are independent of each
other.</para>
<para>This section describes the configuration you must
complete after you configure machines to install the latest
OpenStack packages.</para>
<para os="fedora;centos;rhel">The examples in this guide use the
OpenStack packages from the RDO repository. These packages work
on Red Hat Enterprise Linux 6, compatible versions of CentOS,
and Fedora 20.</para>
<para os="fedora;centos;rhel">
On all nodes, install the <package>yum-plugin-priorities</package> plug-in. This package
allows the assignment of relative priorities to the configured software
repositories. This functionality is used by the RDO release packages:
</para>
<para>Distributions release OpenStack packages as part of the distribution
or using other methods because of differing release schedules. Perform
these procedures on all nodes.</para>
<note>
<para>Disable or remove any automatic update services because they can
impact your OpenStack environment.</para>
</note>
<procedure os="ubuntu">
<title>To configure prerequisites</title>
<step>
<para>Install the <package>python-software-properties</package> package
to ease repository management:</para>
<screen><prompt>#</prompt> <userinput>apt-get install python-software-properties</userinput></screen>
</step>
</procedure>
<procedure os="ubuntu">
<title>To enable the OpenStack repository</title>
<step>
<para>Enable the Ubuntu Cloud archive repository:</para>
<screen><prompt>#</prompt> <userinput>add-apt-repository cloud-archive:juno</userinput></screen>
</step>
</procedure>
<procedure os="rhel;centos;fedora">
<title>To configure prerequisites</title>
<step>
<para>Install the <package>yum-plugin-priorities</package> package to
enable assignment of relative priorities within repositories:</para>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install yum-plugin-priorities</userinput></screen>
<para os="fedora;centos;rhel">
To enable the RDO repository, download and
install the <package>rdo-release-juno</package>
package:</para>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install https://rdo.fedorapeople.org/openstack-juno/rdo-release-juno.rpm</userinput></screen>
<para os="fedora;centos;rhel">The EPEL package includes GPG keys
for package signing and repository information. This should only
be installed on Red Hat Enterprise Linux and CentOS, not Fedora.
Install the latest <package>epel-release</package> package (see
</step>
<step>
<para>Install the <package>epel-release</package> package to enable the
<link
xlink:href="http://download.fedoraproject.org/pub/epel/6/x86_64/repoview/epel-release.html"
>http://download.fedoraproject.org/pub/epel/6/x86_64/repoview/epel-release.html</link>).
For example:</para>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm</userinput></screen>
<para os="fedora;centos;rhel">The
<package>openstack-utils</package> package contains utility
programs that make installation and configuration easier. These
programs are used throughout this guide. Install
<package>openstack-utils</package>. This verifies that you can
access the RDO repository:</para>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install openstack-utils</userinput></screen>
<para os="opensuse;sles">On all nodes, use the Open Build Service repositories
for <glossterm>Juno</glossterm> based on your openSUSE or
SUSE Linux Enterprise Server version.</para>
<para os="opensuse">For openSUSE 13.1 use:</para>
<screen os="opensuse"><prompt>#</prompt> <userinput>zypper addrepo -f obs://Cloud:OpenStack:Juno/openSUSE_13.1 Juno</userinput></screen>
<para os="sles">If you use SUSE Linux Enterprise Server 11 SP3,
use:</para>
<screen os="sles"><prompt>#</prompt> <userinput>zypper addrepo -f obs://Cloud:OpenStack:Juno/SLE_11_SP3 Juno</userinput></screen>
<para os="opensuse;sles">The packages are signed by GPG key 893A90DAD85F9316. You should verify the fingerprint of the imported GPG key before using it.
<programlisting>Key ID: 893A90DAD85F9316
xlink:href="http://download.fedoraproject.org/pub/epel/7/x86_64/repoview/epel-release.html">EPEL</link> repository:</para>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install http://dl.fedoraproject.org/pub/epel/7/x86_64/e/epel-release-7-2.noarch.rpm</userinput></screen>
<note>
<para>Fedora does not require this package.</para>
</note>
</step>
</procedure>
<procedure os="rhel;centos;fedora">
<title>To enable the OpenStack repository</title>
<step>
<para>Install the <package>rdo-release-juno</package> package to enable
the RDO repository:</para>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install http://rdo.fedorapeople.org/openstack-juno/rdo-release-juno.rpm</userinput></screen>
</step>
</procedure>
<procedure os="sles;opensuse">
<title>To enable the OpenStack repository</title>
<step>
<para>Enable the Open Build Service repositories based on your openSUSE
or SLES version:</para>
<para>On openSUSE 13.1:</para>
<screen><prompt>#</prompt> <userinput>zypper addrepo -f obs://Cloud:OpenStack:Juno/openSUSE_13.1 Juno</userinput></screen>
<para>On SLES 11 SP3:</para>
<screen><prompt>#</prompt> <userinput>zypper addrepo -f obs://Cloud:OpenStack:Juno/SLE_11_SP3 Juno</userinput></screen>
<note>
<para>The packages are signed by GPG key 893A90DAD85F9316. You should
verify the fingerprint of the imported GPG key before using
it.</para>
<programlisting>Key ID: 893A90DAD85F9316
Key Name: Cloud:OpenStack OBS Project &lt;Cloud:OpenStack@build.opensuse.org&gt;
Key Fingerprint: 35B34E18ABC1076D66D5A86B893A90DAD85F9316
Key Created: Tue Oct 8 13:34:21 2013
Key Expires: Thu Dec 17 13:34:21 2015</programlisting>
</para>
<para os="opensuse;sles">The <package>openstack-utils</package>
package contains utility programs that make installation and
configuration easier. These programs are used throughout this
guide. Install <package>openstack-utils</package>. This verifies
that you can access the Open Build Service repository:</para>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-utils</userinput></screen>
<warning os="fedora;centos;rhel;opensuse;sles">
<para>The <application>openstack-config</application> program
in the <package>openstack-utils</package> package uses
<application>crudini</application> to manipulate configuration
files. However, <application>crudini</application> version 0.3
does not support multi valued options. See
<link
xlink:href="https://bugs.launchpad.net/openstack-manuals/+bug/1269271"
>https://bugs.launchpad.net/openstack-manuals/+bug/1269271</link>.
As a work around, you must manually set any multi valued
options or the new value overwrites the previous value instead
of creating a new option.</para>
</warning>
<para os="centos;rhel">The
<package>openstack-selinux</package> package includes the
policy files that are required to configure SELinux during
OpenStack installation on RHEL and CentOS. This step is not required during
OpenStack installation on Fedora.
Install <package>openstack-selinux</package>:</para>
<screen os="centos;rhel"><prompt>#</prompt> <userinput>yum install openstack-selinux</userinput></screen>
<para os="fedora;centos;rhel;opensuse;sles">Upgrade your system packages:</para>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum upgrade</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper refresh</userinput>
<prompt>#</prompt> <userinput>zypper dist-upgrade</userinput></screen>
<para os="fedora;centos;rhel;opensuse;sles">If the upgrade included a new
kernel package, reboot the system to ensure the new kernel is running:</para>
<screen os="fedora;centos;rhel;opensuse;sles"><prompt>#</prompt> <userinput>reboot</userinput></screen>
<procedure xml:id="ubuntu-cloud-archive" os="ubuntu">
<title>To use the Ubuntu Cloud Archive for Juno</title>
<para>The <link
xlink:href="https://wiki.ubuntu.com/ServerTeam/CloudArchive"
>Ubuntu Cloud Archive</link> is a special repository that
allows you to install newer releases of OpenStack on the
stable supported version of Ubuntu.</para>
<step>
<para>On all nodes, install the Ubuntu Cloud Archive for
<glossterm>Juno</glossterm>:
<screen><prompt>#</prompt> <userinput>apt-get install python-software-properties</userinput>
<prompt>#</prompt> <userinput>add-apt-repository cloud-archive:juno</userinput></screen></para>
</step>
<step>
<para>Update the package database and upgrade your system:</para>
<screen><prompt>#</prompt> <userinput>apt-get update</userinput>
<prompt>#</prompt> <userinput>apt-get dist-upgrade</userinput></screen>
</step>
<step>
<para>Reboot the system for all changes to take effect:</para>
<screen><prompt>#</prompt> <userinput>reboot</userinput></screen>
</note>
</step>
</procedure>
<procedure xml:id="debian-cloud-archive" os="debian">
<procedure os="debian">
<title>To use the Debian Wheezy backports archive for
Juno</title>
<para>The <glossterm>Juno</glossterm> release is available
@ -150,7 +109,7 @@ Key Expires: Thu Dec 17 13:34:21 2015</programlisting>
mirrors is available at <link
xlink:href="http://archive.gplhost.com/readme.mirrors"
>http://archive.gplhost.com/readme.mirrors</link>.</para>
<section xml:id="basics-argparse" os="debian">
<procedure xml:id="basics-argparse" os="debian">
<title>Manually install python-argparse</title>
<para>The Debian OpenStack packages are maintained on Debian Sid
(also known as Debian Unstable) - the current development
@ -164,6 +123,7 @@ Key Expires: Thu Dec 17 13:34:21 2015</programlisting>
Python 2.7, this package is installed by default. Unfortunately,
in Python 2.7, this package does not include <code>Provides:
python-argparse</code> directive.</para>
<step>
<para>Because the packages are maintained in Sid where the
<code>Provides: python-argparse</code> directive causes an
error, and the Debian OpenStack maintainer wants to maintain one
@ -175,5 +135,29 @@ Key Expires: Thu Dec 17 13:34:21 2015</programlisting>
<screen><prompt>#</prompt> <userinput>apt-get install python-argparse</userinput></screen>
<para>This caveat applies to most OpenStack packages in
Wheezy.</para>
</section>
</step>
</procedure>
<procedure>
<title>To finalize installation</title>
<step>
<para>Upgrade the packages on your system:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get update &amp;&amp; apt-get dist-upgrade</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum upgrade</userinput></screen>
<screen os="sles;opensuse"><prompt>#</prompt> <userinput>zypper refresh &amp;&amp; zypper dist-upgrade</userinput></screen>
<note>
<para>If the upgrade process includes a new kernel, reboot your system
to activate it.</para>
</note>
</step>
<step os="rhel;centos">
<para>RHEL and CentOS enable <glossterm>SELinux</glossterm> by
by default. Install the <package>openstack-selinux</package> package
to automatically manage security policies for OpenStack
services:</para>
<screen os="rhel;centos"><prompt>#</prompt> <userinput>yum install openstack-selinux</userinput></screen>
<note>
<para>Fedora does not require this package.</para>
</note>
</step>
</procedure>
</section>

View File

@ -41,11 +41,17 @@
</procedure>
<procedure>
<title>To configure the message broker service</title>
<step os="sles;opensuse;rhel;centos;fedora">
<para>Start the message broker service and enable it to start when the
<step os="rhel;centos;fedora;sles;opensuse">
<para>Start the message broker service and configure it to start when the
system boots:</para>
<screen><prompt>#</prompt> <userinput>service rabbitmq-server start</userinput>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>systemctl enable rabbitmq-server.service</userinput>
<prompt>#</prompt> <userinput>systemctl start rabbitmq-server.service</userinput></screen>
<para os="sles">On SLES:</para>
<screen os="sles"><prompt>#</prompt> <userinput>service rabbitmq-server start</userinput>
<prompt>#</prompt> <userinput>chkconfig rabbitmq-server on</userinput></screen>
<para os="opensuse">On openSUSE:</para>
<screen os="opensuse"><prompt>#</prompt> <userinput>systemctl enable rabbitmq-server.service</userinput>
<prompt>#</prompt> <userinput>systemctl start rabbitmq-server.service</userinput></screen>
</step>
<step>
<para>The message broker creates a default account that uses