openstack/openstack-manuals
Code Issues Proposed changes

Install Guide: Mark content properly as Debian only

Browse Source 
Some Debian specific content was shown on all systems, add proper os
tag.
Also, wrap mediaobjects in informalfigures.

Change-Id: I83df8d98e7843fd6ee8ce7f0d295473dd79fdf04
backport: havana
This commit is contained in:
Andreas Jaeger 2013-11-02 15:24:48 +01:00
parent 1c07fe0528
commit 8affa7cfed
2 changed files with 73 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -66,11 +66,13 @@ IDENTIFIED BY '<replaceable>KEYSTONE_DBPASS</replaceable>';</userinput></screen>
Fill-in the <systemitem class="library">debconf</systemitem> prompt with the value that will be put in the
<code>admin_token</code> directive of <filename>keystone.conf</filename>. It is
recommended to generate this password with <command>openssl rand -hex 10</command>.
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_1_admin_token.png"/>
</imageobject>
</mediaobject>
</informalfigure>
</para>
<para>Later on, you can verify that <filename>/etc/keystone/keystone.conf</filename>
contains the password you have set using <systemitem class="library">debconf</systemitem>:
@ -83,41 +85,53 @@ admin_token = ADMIN_TOKEN
</step>
<step os="debian">
<para>Answer to the <systemitem class="library">debconf</systemitem> prompts to create an admin tenant.
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_2_register_admin_tenant_yes_no.png"/>
</imageobject>
</mediaobject>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_3_admin_user_name.png"/>
</imageobject>
</mediaobject>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_4_admin_user_email.png"/>
</imageobject>
</mediaobject>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_5_admin_user_pass.png"/>
</imageobject>
</mediaobject>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_6_admin_user_pass_confirm.png"/>
</imageobject>
</mediaobject>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_2_register_admin_tenant_yes_no.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_3_admin_user_name.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_4_admin_user_email.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_5_admin_user_pass.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_6_admin_user_pass_confirm.png"/>
</imageobject>
</mediaobject>
</informalfigure>
</para>
</step>
<step>
<step os="debian">
<para>If this is the first time you install Keystone, then you should
register Keystone in the Keystone catalogue of services:
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/keystone_7_register_endpoint.png"/>
</imageobject>
</mediaobject>
</informalfigure>
</para>
</step>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu">

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

@ -12,19 +12,23 @@
when installing any package for the Networking service.</para>
<para os="debian">When installing a Neutron package, <systemitem class="library">debconf</systemitem>
will prompt you to choose configuration options including the plug-in to use:</para>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/neutron_1_plugin_selection.png"/>
</imageobject>
</mediaobject>
<para>This parameter sets the for the <parameter>core_plugin</parameter> option value in the
<informalfigure os="debian">
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/neutron_1_plugin_selection.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<para os="debian">This parameter sets the for the
<parameter>core_plugin</parameter> option value in the
<filename>/etc/neutron/neutron.conf</filename> file.</para>
<note><para>When you install the <systemitem class="service">neutron-common</systemitem> package,
all plug-ins are installed by default.</para></note>
<para>The following table lists the values for the
<note os="debian"><para>When you install the <systemitem class="service">neutron-common</systemitem> package,
all plug-ins are installed by default.</para>
</note>
<para os="debian">The following table lists the values for the
<parameter>core_plugin</parameter> option. These values depend on your
answer to the debconf prompt.</para>
<table rules="all">
answer to the <systemitem class="library">debconf</systemitem> prompt.</para>
<table rules="all" os="debian">
<caption>Plug-ins and the core_plugin option</caption>
<thead>
<tr>
@ -87,24 +91,29 @@
</tr>
</tbody>
</table>
<para>Depending on the value of <parameter>core_plugin</parameter>, the
start-up scripts start the daemons by using the corresponding plugin configuration file
as parameter directly. For example, if you selected the Open vSwitch
<para os="debian">Depending on the value of
<parameter>core_plugin</parameter>, the start-up scripts start the
daemons by using the corresponding plugin configuration file as
parameter directly. For example, if you selected the Open vSwitch
plugin, then <code>neutron-server</code> will be launched with
<code>--config-file /etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</code>
automatically.</para>
<para os="debian">The <systemitem class="library">neutron-common</systemitem> package
also prompt you for the default network configuration that you wish to use:
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/neutron_2_networking_type.png"/>
</imageobject>
</mediaobject>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/neutron_3_hypervisor_ip.png"/>
</imageobject>
</mediaobject>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/neutron_2_networking_type.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata scale="50" fileref="figures/debconf-screenshots/neutron_3_hypervisor_ip.png"/>
</imageobject>
</mediaobject>
</informalfigure>
</para>
<para os="rhel;centos;fedora;opensuse;sles;ubuntu">Before you configure individual nodes for Neutron, you must
perform the initial setup required for any OpenStack component: