openstack/openstack-manuals
Code Issues Proposed changes

Install Guide: Small edits on neutron

Browse Source 
Add line breaks as needed for screens
Move agent plugin install at the right place for openSUSE, fix description
Fix typo
Use NEUTRON_PASS,  service, controller consistently
Add some FIXMEs to remind us to add openSUSE/Fedora instructions

Change-Id: I3776ff8bf328840c3eae14ee236ebac8243cd959
backport: havana
This commit is contained in:
Andreas Jaeger 2013-10-25 16:07:39 +02:00
parent 43084d2e47
commit 0638317285
3 changed files with 36 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/install-guide/section_neutron-per-tenant-routers-with-private-networks.xml
View File

@ -115,8 +115,8 @@
<listitem> <listitem>
<para>Identity is installed, configured, and running. A Networking user named <emphasis <para>Identity is installed, configured, and running. A Networking user named <emphasis
role="bold">neutron</emphasis> should be created on tenant <emphasis role="bold" role="bold">neutron</emphasis> should be created on tenant <emphasis role="bold"
>servicetenant</emphasis> with password <emphasis role="bold" >service</emphasis> with password <emphasis role="bold"
>servicepassword</emphasis>.</para> >NEUTRON_PASS</emphasis>.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Additional services: <itemizedlist> <para>Additional services: <itemizedlist>
@ -156,9 +156,9 @@ rabbit_host = controller
notification_driver = neutron.openstack.common.notifier.rabbit_notifier notification_driver = neutron.openstack.common.notifier.rabbit_notifier
[keystone_authtoken] [keystone_authtoken]
admin_tenant_name=servicetenant admin_tenant_name=service
admin_user=neutron admin_user=neutron
admin_password=servicepassword admin_password=<replaceable>NEUTRON_PASS</replaceable>
</programlisting> </programlisting>
</listitem> </listitem>
<listitem> <listitem>
@ -195,10 +195,10 @@ enable_tunneling = True
<programlisting language="ini">network_api_class=nova.network.neutronv2.api.API <programlisting language="ini">network_api_class=nova.network.neutronv2.api.API
neutron_admin_username=neutron neutron_admin_username=neutron
neutron_admin_password=servicepassword neutron_admin_password=<replaceable>NEUTRON_PASS</replaceable>
neutron_admin_auth_url=http://controlnode:35357/v2.0/ neutron_admin_auth_url=http://controlnode:35357/v2.0/
neutron_auth_strategy=keystone neutron_auth_strategy=keystone
neutron_admin_tenant_name=servicetenant neutron_admin_tenant_name=service
neutron_url=http://controlnode:9696/ neutron_url=http://controlnode:9696/
libvirt_vif_driver=nova.virt.libvirt.vif.LibvirtHybridOVSBridgeDriver libvirt_vif_driver=nova.virt.libvirt.vif.LibvirtHybridOVSBridgeDriver

30
doc/install-guide/section_neutron-provider-router-with-private_networks.xml
View File

@ -5,7 +5,7 @@
xml:id="section_networking-provider-router_with-provate-networks"> xml:id="section_networking-provider-router_with-provate-networks">
<title>Provider router with private networks</title> <title>Provider router with private networks</title>
<para>This section describes how to install the OpenStack Networking service and its components <para>This section describes how to install the OpenStack Networking service and its components
for a single router use case—a provider router with private networks.</para> for a single router use case: a provider router with private networks.</para>
<para>The following figure shows the setup:</para> <para>The following figure shows the setup:</para>
<note> <note>
<para>Because you run the DHCP agent and L3 agent on one node, you must set <para>Because you run the DHCP agent and L3 agent on one node, you must set
@ -86,7 +86,9 @@
node</title> node</title>
<step> <step>
<para>Run the following command:</para> <para>Run the following command:</para>
<screen><prompt>#</prompt> <userinput>apt-get install neutron-server</userinput></screen> <screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install neutron-server</userinput></screen>
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install openstack-neutron</userinput></screen>
<screen os="opensuse"><prompt>#</prompt> <userinput>zypper install openstack-neutron</userinput></screen>
</step> </step>
<step> <step>
<para>Configure Neutron services:</para> <para>Configure Neutron services:</para>
@ -105,7 +107,7 @@ rabbit_password = guest</programlisting>
/etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</filename> /etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</filename>
and modify:</para> and modify:</para>
<programlisting language="ini">[database] <programlisting language="ini">[database]
connection = mysql://neutron:password@localhost:3306/neutron connection = mysql://neutron:<replaceable>NEUTRON_DBPASS</replaceable>@localhost:3306/neutron
[ovs] [ovs]
tenant_network_type = vlan tenant_network_type = vlan
network_vlan_ranges = physnet1:100:2999</programlisting> network_vlan_ranges = physnet1:100:2999</programlisting>
@ -116,7 +118,7 @@ network_vlan_ranges = physnet1:100:2999</programlisting>
and modify:</para> and modify:</para>
<programlisting language="ini">admin_tenant_name = service <programlisting language="ini">admin_tenant_name = service
admin_user = neutron admin_user = neutron
admin_password = password</programlisting> admin_password = <replaceable>NEUTRON_PASS</replaceable></programlisting>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</step> </step>
@ -134,6 +136,7 @@ admin_password = password</programlisting>
node</title> node</title>
<step> <step>
<para>Install the packages:</para> <para>Install the packages:</para>
<!-- FIXME openSUSE, Fedora instructions -->
<screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-openvswitch-agent \ <screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-openvswitch-agent \
neutron-dhcp-agent neutron-l3-agent</userinput></screen> neutron-dhcp-agent neutron-l3-agent</userinput></screen>
</step> </step>
@ -159,7 +162,7 @@ rabbit_host = controller</programlisting>
/etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini /etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini
</filename>:</para> </filename>:</para>
<programlisting language="ini">[database] <programlisting language="ini">[database]
connection = mysql://neutron:password@192.168.0.1:3306/neutron connection = mysql://neutron:<replaceable>NEUTRON_DBPASS</replaceable>@controller:3306/neutron
[ovs] [ovs]
tenant_network_type=vlan tenant_network_type=vlan
network_vlan_ranges = physnet1:1:4094 network_vlan_ranges = physnet1:1:4094
@ -184,11 +187,11 @@ bridge_mappings = physnet1:br-eth1</programlisting>
/etc/neutron/l3_agent.ini</filename> /etc/neutron/l3_agent.ini</filename>
and modify:</para> and modify:</para>
<programlisting language="ini">[DEFAULT] <programlisting language="ini">[DEFAULT]
auth_url = http://192.168.0.1:35357/v2.0 auth_url = http://controller:35357/v2.0
admin_tenant_name = service admin_tenant_name = service
admin_user = neutron admin_user = neutron
admin_password = password admin_password = <replaceable>NEUTRON_PASS</replaceable>
metadata_ip = 192.168.0.1 metadata_ip = controller
use_namespaces = True</programlisting> use_namespaces = True</programlisting>
</step> </step>
<step> <step>
@ -196,10 +199,10 @@ use_namespaces = True</programlisting>
/etc/neutron/api-paste.ini</filename> /etc/neutron/api-paste.ini</filename>
and modify:</para> and modify:</para>
<programlisting language="ini">[DEFAULT] <programlisting language="ini">[DEFAULT]
auth_host = 192.168.0.1 auth_host = controller
admin_tenant_name = service admin_tenant_name = service
admin_user = neutron admin_user = neutron
admin_password = password</programlisting> admin_password = <replaceable>NEUTRON_PASS</replaceable></programlisting>
</step> </step>
<step> <step>
<para>Edit the file <filename> <para>Edit the file <filename>
@ -221,6 +224,7 @@ admin_password = password</programlisting>
<procedure> <procedure>
<title>To install and configure the compute node</title> <title>To install and configure the compute node</title>
<step> <step>
<!-- FIXME openSUSE, Fedora instructions -->
<para>Install the <para>Install the
packages:<screen><prompt>#</prompt> <userinput>apt-get install openvswitch-switch neutron-plugin-openvswitch-agent</userinput></screen></para> packages:<screen><prompt>#</prompt> <userinput>apt-get install openvswitch-switch neutron-plugin-openvswitch-agent</userinput></screen></para>
</step> </step>
@ -251,7 +255,7 @@ rabbit_host = controller</programlisting>
<para>Update the file <filename> <para>Update the file <filename>
/etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</filename>:</para> /etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</filename>:</para>
<programlisting language="ini">[database] <programlisting language="ini">[database]
connection = mysql://neutron:password@192.168.0.1:3306/neutron connection = mysql://neutron:<replaceable>NEUTRON_DBPASS</replaceable>@controller:3306/neutron
[ovs] [ovs]
tenant_network_type = vlan tenant_network_type = vlan
network_vlan_ranges = physnet1:1:4094 network_vlan_ranges = physnet1:1:4094
@ -279,8 +283,8 @@ bridge_mappings = physnet1:br-eth1</programlisting>
<programlisting language="bash">export OS_TENANT_NAME=provider_tenant <programlisting language="bash">export OS_TENANT_NAME=provider_tenant
export OS_USERNAME=admin export OS_USERNAME=admin
export OS_PASSWORD=password export OS_PASSWORD=password
export OS_AUTH_URL="http://192.168.0.1:5000/v2.0/" export OS_AUTH_URL="http://controller:5000/v2.0/"
export SERVICE_ENDPOINT="http://192.168.0.1:35357/v2.0" export SERVICE_ENDPOINT="http://controller:35357/v2.0"
export SERVICE_TOKEN=password</programlisting></para> export SERVICE_TOKEN=password</programlisting></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

26
doc/install-guide/section_neutron-single-flat.xml
View File

@ -35,7 +35,7 @@
are required to deploy VMs (<systemitem class="service">nova-api</systemitem>, are required to deploy VMs (<systemitem class="service">nova-api</systemitem>,
<systemitem class="service">nova-scheduler</systemitem>, for example). The <systemitem class="service">nova-scheduler</systemitem>, for example). The
node must have at least one network interface, which is connected to the node must have at least one network interface, which is connected to the
"Management Network". The hostname is 'controlnode', which every other node "Management Network". The hostname is 'controller', which every other node
resolve to the controller node's IP. <emphasis role="bold">Note</emphasis> The resolve to the controller node's IP. <emphasis role="bold">Note</emphasis> The
nova-network service should not be running. This is replaced by Networking.</td> nova-network service should not be running. This is replaced by Networking.</td>
</tr> </tr>
@ -77,8 +77,8 @@
<listitem> <listitem>
<para>OpenStack Identity is installed, configured and running. A Networking user <para>OpenStack Identity is installed, configured and running. A Networking user
<emphasis role="bold">neutron</emphasis> should be created on tenant <emphasis <emphasis role="bold">neutron</emphasis> should be created on tenant <emphasis
role="bold">servicetenant</emphasis> with password <emphasis role="bold" role="bold">service</emphasis> with password <emphasis role="bold"
>servicepassword</emphasis>.</para> >NEUTRON_PASS</emphasis>.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Additional services: <itemizedlist> <para>Additional services: <itemizedlist>
@ -103,7 +103,7 @@
<para> <para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis role="bold">Controller node—Networking server</emphasis><orderedlist> <para><emphasis role="bold">Controller node - Networking server</emphasis><orderedlist>
<listitem> <listitem>
<para>Install the Networking server.</para> <para>Install the Networking server.</para>
</listitem> </listitem>
@ -122,16 +122,16 @@ rabbit_host = controller
notification_driver = neutron.openstack.common.notifier.rabbit_notifier notification_driver = neutron.openstack.common.notifier.rabbit_notifier
[keystone_authtoken] [keystone_authtoken]
admin_tenant_name=servicetenant admin_tenant_name=service
admin_user=neutron admin_user=neutron
admin_password=servicepassword admin_password=<replaceable>NEUTRON_PASS</replaceable>
</programlisting> </programlisting>
</listitem> </listitem>
<listitem> <listitem>
<para>Update the plugin configuration file, <filename> <para>Update the plugin configuration file, <filename>
/etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</filename>:</para> /etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</filename>:</para>
<programlisting language="ini">[database] <programlisting language="ini">[database]
connection = mysql://root:root@controlnode:3306/ovs_neutron?charset=utf8 connection = mysql://root:root@controller:3306/ovs_neutron?charset=utf8
[ovs] [ovs]
network_vlan_ranges = physnet1 network_vlan_ranges = physnet1
bridge_mappings = physnet1:br-eth0 bridge_mappings = physnet1:br-eth0
@ -143,7 +143,7 @@ bridge_mappings = physnet1:br-eth0
</orderedlist></para> </orderedlist></para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold">Compute node—Compute </emphasis><orderedlist> <para><emphasis role="bold">Compute node - Compute </emphasis><orderedlist>
<listitem> <listitem>
<para>Install the <systemitem class="service" <para>Install the <systemitem class="service"
>nova-compute</systemitem> service.</para> >nova-compute</systemitem> service.</para>
@ -155,11 +155,11 @@ bridge_mappings = physnet1:br-eth0
<programlisting language="ini">network_api_class=nova.network.neutronv2.api.API <programlisting language="ini">network_api_class=nova.network.neutronv2.api.API
neutron_admin_username=neutron neutron_admin_username=neutron
neutron_admin_password=servicepassword neutron_admin_password=<replaceable>NEUTRON_PASS</replaceable>
neutron_admin_auth_url=http://controlnode:35357/v2.0/ neutron_admin_auth_url=http://controller:35357/v2.0/
neutron_auth_strategy=keystone neutron_auth_strategy=keystone
neutron_admin_tenant_name=servicetenant neutron_admin_tenant_name=service
neutron_url=http://controlnode:9696/ neutron_url=http://controller:9696/
libvirt_vif_driver=nova.virt.libvirt.vif.LibvirtHybridOVSBridgeDriver libvirt_vif_driver=nova.virt.libvirt.vif.LibvirtHybridOVSBridgeDriver
</programlisting> </programlisting>
@ -194,7 +194,7 @@ notification_driver = neutron.openstack.common.notifier.rabbit_notifier</program
<para>Update the plugin configuration file, <filename> <para>Update the plugin configuration file, <filename>
/etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</filename>:</para> /etc/neutron/plugins/openvswitch/ovs_neutron_plugin.ini</filename>:</para>
<programlisting language="ini">[database] <programlisting language="ini">[database]
connection = mysql://root:root@controlnode:3306/ovs_neutron?charset=utf8 connection = mysql://root:root@controller:3306/ovs_neutron?charset=utf8
[ovs] [ovs]
network_vlan_ranges = physnet1 network_vlan_ranges = physnet1
bridge_mappings = physnet1:br-eth0</programlisting> bridge_mappings = physnet1:br-eth0</programlisting>