openstack/openstack-manuals
Code Issues Proposed changes

Adds Debian support for the doc

Browse Source 
This patch adds notes to handle the differences
between Debian and Ubuntu.

backport: havana

Change-Id: I0fea68e65c3c3c4d0c2538a57f3ad4e9bad11cef
This commit is contained in:
Thomas Goirand 2013-10-24 00:20:17 +08:00
parent c2eb0a719b
commit 53c70cf219
17 changed files with 208 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/common/section_dashboard_sessions.xml
View File

@ -11,8 +11,8 @@
customize the session back end through the
<literal>SESSION_ENGINE</literal> setting in your <filename>local_settings</filename> file
(on Fedora/RHEL/CentOS: <filename>
/etc/openstack-dashboard/local_settings</filename>, on Ubuntu:
<filename>local_settings.py</filename> and on openSUSE: <filename
/etc/openstack-dashboard/local_settings</filename>, on Ubuntu and Debian:
<filename>/etc/openstack-dashboard/local_settings.py</filename> and on openSUSE: <filename
>/usr/share/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>).
</para>
<para>The following sections describe the pros and cons of each

20
doc/common/section_getstart_compute.xml
View File

@ -30,15 +30,16 @@
enforces some policies.</para>
</listitem>
<listitem>
<para><systemitem class="service"
>nova-api-metadata</systemitem> service. Accepts
metadata requests from instances. The <systemitem
class="service">nova-api-metadata</systemitem> service
<para><systemitem class="service">nova-api-metadata</systemitem> service. Accepts
metadata requests from instances. The <systemitem class="service">nova-api-metadata</systemitem> service
is generally only used when you run in multi-host mode
with <systemitem class="service">nova-network</systemitem>
installations. For details, see <link
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/section_metadata-service.html"
>Metadata service</link> in the <citetitle>Cloud Administrator Guide</citetitle>.</para>
installations. For details, see
<link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/section_metadata-service.html">Metadata service</link>
in the <citetitle>Cloud Administrator Guide</citetitle>.
</para>
<para>Note for Debian users: on Debian system, it is included in the <application>nova-api</application>
package, and can be selected through debconf.</para>
</listitem>
</itemizedlist>
<itemizedlist>
@ -140,6 +141,11 @@
daemon. Manages x509 certificates.</para>
</listitem>
</itemizedlist>
<para os="debian">Note for Debian users:
A unique package called <application>nova-consoleproxy</application> contains <application>nova-novncproxy</application>,
<application>nova-spicehtml5proxy</application>, and <application>nova-xvpvncproxy</application>.
Selection of which to use is done either by configuring
<filename>/etc/default/nova-consoleproxy</filename> or through Debconf.</para>
<itemizedlist>
<title>Image Management (EC2 scenario)</title>
<listitem>

20
doc/install-guide/bk_openstackinstallguide.xml
View File

@ -8,14 +8,14 @@
<title>OpenStack Installation Guide<phrase os="rhel;centos;fedora"
> for Red Hat Enterprise Linux, CentOS, and
Fedora</phrase>
<phrase os="ubuntu"> for Ubuntu 12.04 (LTS)</phrase>
<phrase os="ubuntu;debian"> for Ubuntu 12.04 (LTS) and Debian 7.0</phrase>
<phrase os="opensuse"> for openSUSE and SUSE Linux Enterprise Server</phrase>
</title>
<?rax subtitle.font.size="17px" title.font.size="32px"?>
<titleabbrev>OpenStack Installation Guide<phrase
os="rhel;centos;fedora"> for Red Hat Enterprise Linux,
CentOS, and Fedora</phrase>
<phrase os="ubuntu"> for Ubuntu 12.04 (LTS)</phrase>
<phrase os="ubuntu;debian"> for Ubuntu 12.04 (LTS) &amp; Debian 7.0</phrase>
<phrase os="opensuse"> for openSUSE and SUSE Linux Enterprise Server</phrase>
</titleabbrev>
<info>
@ -50,9 +50,9 @@
Service, OpenStack Networking, and the OpenStack Image Service.
You can install any of these projects separately and then
configure them either as standalone or connected entities.
<phrase os="ubuntu">This guide walks through an installation
using packages available through Ubuntu 12.04
(LTS).</phrase>
<phrase os="ubuntu;debian">This guide walks through an installation
using packages available through Ubuntu 12.04 (LTS) and
for Debian 7.0.</phrase>
<phrase os="rhel;centos;fedora">This guide shows you how to
install OpenStack by using packages available through Fedora
19 as well as on Red Hat Enterprise Linux and its
@ -64,6 +64,16 @@
files are included.</para>
</abstract>
<revhistory>
<revision>
<date>2013-10-25</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Added initial Debian support.</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
<revision>
<date>2013-10-17</date>
<revdescription>

14
doc/install-guide/ch_assumptions.xml
View File

@ -16,8 +16,8 @@
6.4, Scientific Linux 6.1 or CentOS 6 + CR
distributions (continuous release ( CR )
repository).</para>
<para os="ubuntu">You have a collection of compute nodes,
each installed with Ubuntu Server 12.04.</para>
<para os="ubuntu;debian">You have a collection of compute nodes,
each installed with Ubuntu Server 12.04 or Debian 7.0 (Wheezy).</para>
<para os="opensuse">You have a collection of compute nodes,
each installed with openSUSE 12.3.</para>
<note>
@ -28,11 +28,11 @@
xlink:href="http://docs.openstack.org/trunk/install-guide/install/apt/content/"
>OpenStack Install and Deploy Manual for
Ubuntu</link> and </phrase>
<phrase os="ubuntu;opensuse">an <link
<phrase os="ubuntu;debian;opensuse">an <link
xlink:href="http://docs.openstack.org/trunk/install-guide/install/yum/content/"
>OpenStack Install and Deploy Manual for
RHEL, CentOS and Fedora</link></phrase>
<phrase os="ubuntu"> and </phrase>
<phrase os="ubuntu;debian"> and </phrase>
<phrase os="rhel;centos;fedora;ubuntu;">an <link
xlink:href="http://docs.openstack.org/trunk/install-guide/install/zypper/content/"
>OpenStack Install and Deploy Manual for
@ -67,7 +67,7 @@
<listitem>
<para>Ensure that the server can resolve its own hostname,
otherwise you may have problems if you are using
RabbitMQ as the messaging backend. <phrase os="ubuntu"
RabbitMQ as the messaging backend. <phrase os="ubuntu;debian"
>RabbitMQ is the default messaging back-end on
Ubuntu</phrase>
<phrase os="opensuse">RabbitMQ is the default
@ -91,7 +91,7 @@
<para>KVM or Xen (XenServer or XCP) as the
hypervisor.</para>
</listitem>
<listitem os="ubuntu">
<listitem os="ubuntu;debian">
<para>On Ubuntu, enable the <link
xlink:href="https://wiki.ubuntu.com/ServerTeam/CloudArchive"
>Cloud Archive</link> repository by adding the
@ -118,7 +118,7 @@
<command>yum update</command> prior to the
installation.</para>
</listitem>
<listitem os="ubuntu">
<listitem os="ubuntu;debian">
<para>Ensure the operating system is up-to-date by running
<command>apt-get update</command> and
<command>apt-get upgrade</command> prior to the

41
doc/install-guide/ch_basics.xml
View File

@ -139,7 +139,7 @@ Subnet Mask: 255.255.255.0</programlisting>
</listitem>
</itemizedlist></para>
<example os="ubuntu">
<example os="ubuntu;debian">
<title><filename>/etc/network/interfaces</filename></title>
<programlisting language="ini"># Internal Network
auto eth0
@ -385,13 +385,37 @@ bind-address = 192.168.0.10</programlisting>
<screen><prompt>#</prompt> <userinput>apt-get update &amp;&amp; apt-get dist-upgrade</userinput> </screen></para>
</step>
</procedure>
<procedure xml:id="debian-cloud-archive" os="debian">
<title>To use the Debian Wheezy backports archive for Havana</title>
<para>The Havana release is available only in Debian Sid (otherwise
called Unstable). However, the Debian maintainers of OpenStack also
maintain a non-official Debian repository for OpenStack containing
Wheezy backports.</para>
<step>
<para>Install the Debian Wheezy backport repository Havana:
<screen><prompt>#</prompt> <userinput>echo "deb http://archive.gplhost.com/debian havana-backports main" >>/etc/apt/sources.list</userinput> </screen></para>
</step>
<step>
<para>Install the Debian Wheezy OpenStack repository for Havana:
<screen><prompt>#</prompt> <userinput>echo "deb http://archive.gplhost.com/debian havana main" >>/etc/apt/sources.list</userinput> </screen></para>
</step>
<step>
<para>Upgrade the system and install the repository key:
<screen><prompt>#</prompt> <userinput>apt-get update &amp;&amp; apt-get install gplhost-archive-keyring &amp;&amp; apt-get update &amp;&amp; apt-get dist-upgrade</userinput> </screen></para>
</step>
</procedure>
<para>There are also numerous mirrors of archive.gplhost.com available
from around the world, all available with both FTP and HTTP
protocols (you should use the closest mirror). The list of mirrors is
available at <link xlink:href="http://archive.gplhost.com/readme.mirrors">http://archive.gplhost.com/readme.mirrors</link>.
</para>
</section>
<section xml:id="basics-queue">
<title>Messaging Server</title>
<para>On the controller node, install the messaging queue server. Typically this is <phrase
os="ubuntu;opensuse;sles">RabbitMQ</phrase><phrase os="centos;rhel;fedora"
>Qpid</phrase> but <phrase os="ubuntu;opensuse;sles">Qpid</phrase><phrase
os="ubuntu;debian;opensuse;sles">RabbitMQ</phrase><phrase os="centos;rhel;fedora"
>Qpid</phrase> but <phrase os="ubuntu;debian;opensuse;sles">Qpid</phrase><phrase
os="centos;rhel;fedora">RabbitMQ</phrase> and ZeroMQ (0MQ) are also
available.</para>
@ -399,12 +423,19 @@ bind-address = 192.168.0.10</programlisting>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install rabbitmq-server</userinput></screen>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install qpid-cpp-server memcached</userinput></screen>
<note os="ubuntu;debian">
<note os="ubuntu;debian"><title>Important security consideration</title>
<para>The <package>rabbitmq-server</package> package configures
the RabbitMQ service to start automatically and creates a
<literal>guest</literal> user with a default
<literal>guest</literal> password. The RabbitMQ examples in
this guide use the <literal>guest</literal> account.</para>
this guide use the <literal>guest</literal> account, though it
is strongly advised to change its default password, especially
if you have IPv6 available: by default the RabbitMQ server will
allow anyone to connect to it using guest as login and password,
and with IPv6, it will be reachable from the outside.</para>
<para>To change the default guest password of RabbitMQ, you can do:
<screen><prompt>#</prompt> <userinput>rabbitmqctl change_password guest <replaceable>NEW_PASS</replaceable></userinput></screen>
</para>
</note>
<para os="fedora;centos;rhel">Disable Qpid authentication by editing <filename>/etc/qpidd.conf</filename> file and
changing the <literal>auth</literal> option to <literal>no</literal>.</para>

8
doc/install-guide/section_ceilometer-install.xml
View File

@ -12,7 +12,7 @@
elsewhere, such as on the compute node.</para>
<step>
<para>Install the Metering Service on the controller node:</para>
<screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install ceilometer-api ceilometer-collector ceilometer-agent-central python-ceilometerclient</userinput></screen>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install ceilometer-api ceilometer-collector ceilometer-agent-central python-ceilometerclient</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install openstack-ceilometer-api openstack-ceilometer-collector openstack-ceilometer-agent-central python-ceilometerclient FIXME</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-ceilometer-api openstack-ceilometer-collector openstack-ceilometer-agent-central python-ceilometerclient</userinput></screen>
</step>
@ -69,10 +69,10 @@ connection = mongodb://ceilometer:<replaceable>CEILOMETER_DBPASS</replaceable>@<
<prompt>#</prompt> <userinput>openstack-config --set /etc/keystone/keystone.conf publisher_rpc metering_secret $ADMIN_TOKEN</userinput></screen>
<para os="sles;opensuse">For SUSE Linux Enterprise use instead as first command:</para>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>ADMIN_TOKEN=$(openssl rand 10|hexdump -e '1/1 "%.2x"')</userinput></screen>
<screen os="ubuntu"><prompt>#</prompt> <userinput>openssl rand -hex 10</userinput></screen>
<para os="ubuntu">Edit <filename>/etc/ceilometer/ceilometer.conf</filename> and
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>openssl rand -hex 10</userinput></screen>
<para os="ubuntu;debian">Edit <filename>/etc/ceilometer/ceilometer.conf</filename> and
change the <literal>[DEFAULT]</literal> section, replacing ADMIN_TOKEN with the results of the command.</para>
<programlisting os="ubuntu" language="ini">
<programlisting os="ubuntu;debian" language="ini">
...
[publisher_rpc]
...

6
doc/install-guide/section_ceilometer-nova.xml
View File

@ -11,7 +11,7 @@
that runs on compute nodes.</para>
<step>
<para>Install the Metering service on the compute node:</para>
<screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install ceilometer-agent-compute</userinput></screen>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install ceilometer-agent-compute</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install openstack-ceilometer-agent-compute FIXME</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-ceilometer-agent-compute</userinput></screen>
</step>
@ -41,9 +41,9 @@ notification_driver=ceilometer.compute.nova_notifier
<para>You need to set the secret key defined earlier that is used as a
shared secret between the Metering service nodes.</para>
<screen><prompt>#</prompt> <userinput>openstack-config --set /etc/keystone/keystone.conf publisher_rpc metering_secret $ADMIN_TOKEN</userinput></screen>
<para os="ubuntu">Edit <filename>/etc/ceilometer/ceilometer.conf</filename> and
<para os="ubuntu;debian">Edit <filename>/etc/ceilometer/ceilometer.conf</filename> and
change the <literal>[DEFAULT]</literal> section, replacing ADMIN_TOKEN with the one created earlier.</para>
<programlisting os="ubuntu" language="ini">
<programlisting os="ubuntu;debian" language="ini">
...
[publisher_rpc]
# Secret value for signing metering messages (string value)

15
doc/install-guide/section_cinder-controller.xml
View File

@ -18,6 +18,21 @@
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install cinder-api cinder-scheduler</userinput></screen>
<screen os="centos;rhel;fedora"><prompt>#</prompt> <userinput>yum install openstack-cinder openstack-utils openstack-selinux</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-cinder-api openstack-cinder-scheduler</userinput></screen>
<note os="debian"><title>Note for Debian users</title>
<para>As for the rest of OpenStack, the Block Storage service is configured through
debconf. So you will not need to manually configure the database, do the
<code>cinder-manage db sync</code> manually, configure the Keystone auth token, or
the RabbitMQ parameters of Cinder. Therefore, all the below steps can be
skipped.</para>
<para>If you need to reconfigure the Block Storage packages, you can use:
<screen><prompt>#</prompt> <userinput>dpkg-reconfigure -plow cinder-common</userinput></screen>
or edit the configuration files and manually restart the daemons.</para>
<para>Remember that if your database server is installed remotely,
before installing the Block Storage service, you will need to do:
<screen><prompt>#</prompt> <userinput>apt-get install dbconfig-common &amp;&amp; \
dpkg-reconfigure -plow dbconfig-common</userinput></screen>.</para>
</note>
</step>
<step os="rhel;centos;fedora;opensuse;sles"><para>The Block Storage Service stores volume information in a database.

2
doc/install-guide/section_cinder-node.xml
View File

@ -50,7 +50,7 @@ admin_password=<replaceable>CINDER_PASS</replaceable>
message broker by setting the following configuration keys. They are found in
the <literal>DEFAULT</literal> configuration group of the
<filename>/etc/cinder/cinder.conf</filename> file.</para>
<programlisting os="ubuntu" language="ini">rpc_backend = cinder.openstack.common.rpc.impl_kombu
<programlisting os="ubuntu;debian" language="ini">rpc_backend = cinder.openstack.common.rpc.impl_kombu
rabbit_host = controller
rabbit_port = 5672
# Change the following settings if you're not using the default RabbitMQ configuration

12
doc/install-guide/section_dashboard-install.xml
View File

@ -30,7 +30,7 @@
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install memcached libapache2-mod-wsgi openstack-dashboard</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install memcached python-memcached mod_wsgi openstack-dashboard</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install memcached python-python-memcached apache2-mod_wsgi openstack-dashboard</userinput></screen>
<note os="ubuntu">
<note os="ubuntu"><title>Note for Ubuntu users</title>
<para>Remove the
<literal>openstack-dashboard-ubuntu-theme</literal>
@ -39,6 +39,16 @@
<screen><prompt>#</prompt> <userinput>apt-get remove --purge openstack-dashboard-ubuntu-theme</userinput></screen>
</para>
</note>
<note os="debian"><title>Note for Debian users</title>
<para>It is as well possible to install the apache package:
<screen><prompt>#</prompt> <userinput>apt-get install openstack-dashboard-apache</userinput></screen>
This will install and configure Apache correctly, provided that
the user asks for it during the debconf prompts. The default SSL
certificate is self-signed, and it is probably wise to have it
signed by a root CA (Certificate Authority).
</para>
</note>
</step>
<step>
<para>Modify the value of

13
doc/install-guide/section_glance-install.xml
View File

@ -61,6 +61,19 @@ sql_connection = mysql://glance:GLANCE_DBPASS@localhost/glance
<screen><prompt>#</prompt> <userinput>openstack-db --init --service glance --password <replaceable>GLANCE_DBPASS</replaceable></userinput></screen></step>
<step os="ubuntu;debian">
<note os="debian"><title>Note for Debian users</title>
<para>As for the rest of OpenStack, the Image Service is configured through
debconf. So you will not need to manually configure the database, do the
<code>glance-manage db_sync</code> manually, configure the Keystone auth token, or
the RabbitMQ parameters of Glance. Therefore, all the below steps can be
skipped. If you need to reconfigure the Image Service, you can use:</para>
<screen><prompt>#</prompt> <userinput>dpkg-reconfigure -plow glance-common</userinput></screen>
<para>or edit the configuration files and manually restart the daemons.
Remember that if your database server is installed remotely, before
installing the Image Service, you will need to do:</para>
<screen><prompt>#</prompt> <userinput>apt-get install dbconfig-common &amp;&amp; \
dpkg-reconfigure -plow dbconfig-common</userinput></screen>
</note>
<para>The Ubuntu packages create an sqlite database by
default. Delete the <filename>glance.sqlite</filename> file created in
the <filename>/var/lib/glance/</filename> directory so it is not used by mistake.</para>

6
doc/install-guide/section_heat-install.xml
View File

@ -7,7 +7,7 @@
<procedure>
<step>
<para>Install the Orchestration Service on the controller node:</para>
<screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install heat-api heat-api-cfn heat-engine python-heat-client</userinput></screen>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install heat-api heat-api-cfn heat-engine</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install openstack-heat-api openstack-heat-engine FIXME</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-heat-api openstack-heat-api-cfn openstack-heat-engine</userinput></screen>
</step>
@ -21,8 +21,8 @@
with a suitable password for the database user.</para>
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/heat/heat.conf \
database connection mysql://heat:<replaceable>HEAT_DBPASS</replaceable>@controller/heat</userinput></screen>
<para os="ubuntu">Edit <filename>/etc/heat/heat.conf</filename> and change the <literal>[DEFAULT]</literal> section.</para>
<programlisting os="ubuntu" language="ini">[database]
<para os="ubuntu;debian">Edit <filename>/etc/heat/heat.conf</filename> and change the <literal>[DEFAULT]</literal> section.</para>
<programlisting os="ubuntu;debian" language="ini">[database]
# The SQLAlchemy connection string used to connect to the database
connection = mysql://heat:<replaceable>HEAT_DBPASS</replaceable>@controller/heat
...

43
doc/install-guide/section_keystone-install.xml
View File

@ -6,12 +6,33 @@
<title>Installing the Identity Service</title>
<procedure>
<step>
<para>Install the Identity Service on the controller node:</para>
<screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install keystone python-keystone python-keystoneclient</userinput></screen>
<para>Install the Identity Service on the controller node, together
with python-keystoneclient (which is a dependency):</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install keystone</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install openstack-keystone python-keystoneclient</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-keystone python-keystoneclient openstack-utils</userinput></screen>
<note os="debian"><title>Note for Debian users</title>
<para>Note that on Debian system, the above is all what is needed
to install the Identity Service. During the setup, the debconf system will prompt
the user for the database access information. It will then
automatically create the database, configure access rights,
and then modify <filename>/etc/keystone/keystone.conf</filename> to reflect this
configuration. Debconf will also be used to configure the AUTH_TOKEN
administrator password.</para>
<para>The Debian package will then perform the
<code>keystone-manage db_sync</code> for you, and create an "admin/admin" tenant
and user, which you can later use for setting-up the other OpenStack
service (later called "auth token" in this documentation). Finally,
the package will also ask the user to setup the keystone endpoint.
Therefore, if you use Debian, you can skip all the remaining steps below.</para>
<para>If you need to reconfigure Keystone, you can use:
<screen><prompt>#</prompt> <userinput>dpkg-reconfigure -plow keystone</userinput></screen>
or edit the configuration files and manually restart the daemon.</para>
<para>Remember that for using a database server that is installed remotely,
you need to call before installing the Identity Service:
<screen><prompt>#</prompt> <userinput>apt-get install dbconfig-common &amp;&amp; dpkg-reconfigure -plow dbconfig-common</userinput></screen></para>
</note>
</step>
<step>
<para>The Identity Service uses a database to store information.
Specify the location of the database in the configuration file.
@ -21,8 +42,8 @@
with a suitable password for the database user.</para>
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/keystone/keystone.conf \
sql connection mysql://keystone:<replaceable>KEYSTONE_DBPASS</replaceable>@controller/keystone</userinput></screen>
<para os="ubuntu">Edit <filename>/etc/keystone/keystone.conf</filename> and change the <literal>[sql]</literal> section.</para>
<programlisting os="ubuntu" language="ini">
<para os="ubuntu;debian">Edit <filename>/etc/keystone/keystone.conf</filename> and change the <literal>[sql]</literal> section.</para>
<programlisting os="ubuntu;debian" language="ini">
...
[sql]
# The SQLAlchemy connection string used to connect to the database
@ -40,7 +61,7 @@ connection = mysql://keystone:KEYSTONE_DBPASS@controller/keystone
<screen><prompt>#</prompt> <userinput>openstack-db --init --service keystone --password <replaceable>KEYSTONE_DBPASS</replaceable></userinput></screen>
</step>
<step os="ubuntu">
<step os="ubuntu;debian">
<para>First, we need to create a database user called <literal>keystone</literal>, by logging in
as root using the password we set earlier.</para>
<screen><prompt>#</prompt> <userinput>mysql -u root -p</userinput>
@ -50,7 +71,7 @@ IDENTIFIED BY '<replaceable>KEYSTONE_DBPASS</replaceable>';</userinput>
<prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON keystone.* TO 'keystone'@'%' \
IDENTIFIED BY '<replaceable>KEYSTONE_DBPASS</replaceable>';</userinput></screen>
</step>
<step os="ubuntu">
<step os="ubuntu;debian">
<para>We now start the keystone service and create its tables.</para>
<screen><prompt>#</prompt> <userinput>keystone-manage db_sync</userinput>
<prompt>#</prompt> <userinput>service keystone restart</userinput></screen>
@ -64,12 +85,12 @@ IDENTIFIED BY '<replaceable>KEYSTONE_DBPASS</replaceable>';</userinput></screen>
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>ADMIN_TOKEN=$(openssl rand -hex 10)</userinput>
<prompt>#</prompt> <userinput>echo $ADMIN_TOKEN</userinput>
<prompt>#</prompt> <userinput>openstack-config --set /etc/keystone/keystone.conf DEFAULT admin_token $ADMIN_TOKEN</userinput></screen>
<screen os="ubuntu"><prompt>#</prompt> <userinput>openssl rand -hex 10</userinput></screen>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>openssl rand -hex 10</userinput></screen>
<para os="sles;opensuse">For SUSE Linux Enterprise use instead as first command:</para>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>ADMIN_TOKEN=$(openssl rand 10|hexdump -e '1/1 "%.2x"')</userinput></screen>
<para os="ubuntu">Edit <filename>/etc/keystone/keystone.conf</filename> and
<para os="ubuntu;debian">Edit <filename>/etc/keystone/keystone.conf</filename> and
change the <literal>[DEFAULT]</literal> section, replacing ADMIN_TOKEN with the results of the command.</para>
<programlisting os="ubuntu" language="ini">
<programlisting os="ubuntu;debian" language="ini">
[DEFAULT]
# A "shared secret" between keystone and other openstack services
admin_token = ADMIN_TOKEN
@ -95,7 +116,7 @@ admin_token = ADMIN_TOKEN
<prompt>#</prompt> <userinput>sed -e "s,%SERVICE_HOST%,192.168.0.10,g" -e "s/%S3_SERVICE_PORT%/8080/" \
$KEYSTONE_CATALOG.sample > $KEYSTONE_CATALOG</userinput></screen>
</step>
<step os="ubuntu">
<step os="ubuntu;debian">
<para>Restart the Identity service.</para>
<screen><prompt>#</prompt> <userinput>service keystone restart</userinput></screen>
</step>

8
doc/install-guide/section_keystone-services.xml
View File

@ -3,6 +3,14 @@
xml:id="keystone-services">
<title>Defining Services and API Endpoints</title>
<note os="debian"><title>Note for Debian users</title>
<para>On Debian systems, the Keystone package
will prompt the user for automatically creating the service end API
endpoint of Keystone (in the Keystone database itself). So if you
directed the package to do so, you don't need to perform the commands
detailed in this section, as it will have been done automatically.
However, it is advised to still read it to understand what has been
done by the Keystone package.</para></note>
<para>The Identity Service also tracks what OpenStack services are
installed and where to locate them on the network. For each service
on your OpenStack installation, you must call

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

@ -43,7 +43,7 @@
<step>
<para>Install the OpenStack Networking service on the controller
node:</para>
<screen os="ubuntu"><prompt>#</prompt> <userinput>apt-get install neutron-server neutron-dhcp-agent neutron-plugin-openvswitch neutron-l3-agent</userinput></screen>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install neutron-server neutron-dhcp-agent neutron-plugin-openvswitch neutron-l3-agent</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install openstack-neutron</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-neutron openstack-neutron-l3-agent openstack-neutron-dhcp-agent</userinput></screen>
</step>
@ -60,7 +60,7 @@ net.ipv4.conf.default.rp_filter=0</programlisting>
you might need to restart the network service to get the
configurations to take effect. Do so with the following
command:</para>
<screen os="ubuntu"><prompt>#</prompt> <userinput>service networking restart</userinput></screen>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>service networking restart</userinput></screen>
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>service network restart</userinput></screen>
</note>
</step>

33
doc/install-guide/section_nova-compute.xml
View File

@ -28,7 +28,8 @@
An IP address will be assigned and configured by the networking component of OpenStack.</para>
</listitem>
<listitem>
<para>Set the hostname to <literal>compute1</literal>. Ensure that the
<para>Set the hostname to <literal>compute1</literal> (this can be
checked using <code>uname -n</code>). Ensure that the
IP addresses and hostnames for both nodes are listed in the
<filename>/etc/hosts</filename> file on each system.</para>
</listitem>
@ -48,12 +49,38 @@
<step><para>After configuring the operating system, install the appropriate
packages for the compute service.</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install nova-compute-kvm python-novaclient python-guestfs</userinput></screen>
<note os="debian"><title>Note for Debian users</title>
<para>Before installing anything, make sure that you have installed dbconfig-common, and that
you configured it correctly to allow the use of remote database servers:</para>
<screen><prompt>#</prompt> <userinput>dpkg-reconfigure dbconfig-common</userinput></screen>
<para>Then, on the host running the MySQL server (which is the controller
node in this manual), simply run:
<screen><prompt>#</prompt> <userinput>/usr/share/openstack-proxy-node/mysql-remote-root</userinput></screen>
(available from the openstack-proxy-node package) so that your
controller node is configured to allow the compute node to access it.</para>
</note>
<para os="ubuntu;debian">Then do:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install nova-compute-kvm python-guestfs</userinput></screen>
<para os="ubuntu;debian">Select "Yes" when asked to create a supermin appliance during install.</para>
<note os="debian"><title>Note for Debian users</title>
<para>You can also use the meta-package with:
<screen><prompt>#</prompt> <userinput>apt-get install openstack-compute-node</userinput></screen>
which will also install other components on your compute node, like the OVS
Neutron agent, Ceilometer agent, and more.</para>
<para>As for the rest of OpenStack, the Nova packages are configured through
debconf. So you will not need to manually configure the database, do the
"nova-manage db sync" manually, configure the keystone auth token, or
the RabbitMQ parameters of Nova. Therefore, all the below steps can be
skipped. If you need to reconfigure Nova, you can use:
<screen><prompt>#</prompt> <userinput>dpkg-reconfigure -plow nova-common</userinput></screen>
or edit the configuration files and manually restart the daemons.
Remember that if your database server is installed remotely, before
installing the Compute service, you will need to do:
<screen><prompt>#</prompt> <userinput>apt-get install dbconfig-common &amp;&amp; dpkg-reconfigure -plow dbconfig-common</userinput></screen></para></note>
<screen os="centos;rhel;fedora"><prompt>#</prompt> <userinput>yum install openstack-nova-compute</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-nova-compute kvm openstack-utils</userinput></screen>
</step>
<step os="ubuntu">
<step os="ubuntu;debian">
<para>Due to <link xlink:href="https://bugs.launchpad.net/ubuntu/+source/linux/+bug/759725">this bug</link>
that is marked "Won't Fix", guestfs is restricted.
Run the following command to relax the restriction:</para>

15
doc/install-guide/section_nova-controller.xml
View File

@ -24,8 +24,19 @@
the OpenStack Compute services that will be run on the controller node in this
guide.</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install nova-novncproxy novnc nova-api nova-ajax-console-proxy nova-cert \
nova-conductor nova-consoleauth nova-doc nova-scheduler python-novaclient</userinput></screen>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install nova-novncproxy novnc nova-api \
nova-ajax-console-proxy nova-cert nova-conductor \
nova-consoleauth nova-doc nova-scheduler</userinput></screen>
<note os="debian"><title>Note for Debian users</title>
<para>You can use <code>nova-consoleproxy</code>
instead of <code>nova-novncproxy</code> and <code>novnc</code>. The Debconf system will prompt
the user for setting-up the database, which will be automatically created
and configured with the correct access rights. Then <code>nova-manage db sync</code>
will automatically be called. The system will also prompt you for the
keystone auth token configuration, the RabbitMQ server access, and the
API service and endpoint configuration. You can therefore skip the steps
below.</para></note>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install openstack-nova-api openstack-nova-scheduler \
openstack-nova-cert openstack-nova-conductor openstack-nova-console \
openstack-nova-consoleauth openstack-nova-doc \