openstack/openstack-manuals
Code Issues Proposed changes

Remove usage of sudo from admin-guide

Browse Source 
Update prompts as needed.

Change-Id: I29e3d620ef942be599e940023048e62df7e9d1f7
This commit is contained in:
Andreas Jaeger 2014-03-10 20:05:27 +01:00
parent 86e8364342
commit d3ae18b187
6 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/admin-guide-cloud/ch_compute.xml
View File

@ -459,7 +459,7 @@
install the latest version using the install the latest version using the
<application>pip</application> python package <application>pip</application> python package
installer:</para> installer:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install python-novaclient</userinput></screen> <screen><prompt>#</prompt> <userinput>pip install python-novaclient</userinput></screen>
<para>For more information about <para>For more information about
<application>python-novaclient</application> and other <application>python-novaclient</application> and other
available command-line tools, see the <link available command-line tools, see the <link
@ -1880,8 +1880,9 @@ net.bridge.bridge-nf-call-ip6tables=0</programlisting>
environment.</para> environment.</para>
<screen><prompt>$</prompt> <userinput>curl -O http://pypi.python.org/packages/source/p/python-novaclient/python-novaclient-2.6.3.tar.gz</userinput> <screen><prompt>$</prompt> <userinput>curl -O http://pypi.python.org/packages/source/p/python-novaclient/python-novaclient-2.6.3.tar.gz</userinput>
<prompt>$</prompt> <userinput>tar -zxvf python-novaclient-2.6.3.tar.gz</userinput> <prompt>$</prompt> <userinput>tar -zxvf python-novaclient-2.6.3.tar.gz</userinput>
<prompt>$</prompt> <userinput>cd python-novaclient-2.6.3</userinput> <prompt>$</prompt> <userinput>cd python-novaclient-2.6.3</userinput></screen>
<prompt>$</prompt> <userinput>sudo python setup.py install</userinput></screen> <para>As <systemitem class="username">root</systemitem> execute:</para>
<screen><prompt>#</prompt> <userinput>python setup.py install</userinput></screen>
</step> </step>
<step> <step>
<para>Now that you have installed the <para>Now that you have installed the

8
doc/admin-guide-cloud/section_networking-use.xml
View File

@ -6,10 +6,10 @@
<para>You can manage OpenStack Networking services using <para>You can manage OpenStack Networking services using
the <systemitem>service</systemitem> command. For the <systemitem>service</systemitem> command. For
example:</para> example:</para>
<screen><prompt>#</prompt> <userinput>sudo service neutron-server stop</userinput> <screen><prompt>#</prompt> <userinput>service neutron-server stop</userinput>
<prompt>#</prompt> <userinput>sudo service neutron-server status</userinput> <prompt>#</prompt> <userinput>service neutron-server status</userinput>
<prompt>#</prompt> <userinput>sudo service neutron-server start</userinput> <prompt>#</prompt> <userinput>service neutron-server start</userinput>
<prompt>#</prompt> <userinput>sudo service neutron-server restart</userinput></screen> <prompt>#</prompt> <userinput>service neutron-server restart</userinput></screen>
<para>Log files are in the <para>Log files are in the
<systemitem>/var/log/neutron</systemitem> <systemitem>/var/log/neutron</systemitem>
directory.</para> directory.</para>

51
doc/admin-guide-cloud/section_networking_introduction.xml
View File

@ -387,7 +387,7 @@
<para>Restart <systemitem class="service" <para>Restart <systemitem class="service"
>neutron-server</systemitem> to apply >neutron-server</systemitem> to apply
the new settings:</para> the new settings:</para>
<screen><prompt>$</prompt> <userinput>sudo service neutron-server restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service neutron-server restart</userinput></screen>
</step> </step>
</procedure> </procedure>
</section> </section>
@ -403,8 +403,9 @@
is available at <link is available at <link
xlink:href="https://github.com/brocade/ncclient" xlink:href="https://github.com/brocade/ncclient"
>https://github.com/brocade/ncclient</link>:</para> >https://github.com/brocade/ncclient</link>:</para>
<screen><prompt>$</prompt> <userinput>git clone https://www.github.com/brocade/ncclient</userinput> <screen><prompt>$</prompt> <userinput>git clone https://www.github.com/brocade/ncclient</userinput></screen>
<prompt>$</prompt> <userinput>cd ncclient; sudo python ./setup.py install</userinput></screen> <para>As <systemitem class="username">root</systemitem> execute:</para>
<screen><prompt>#</prompt> <userinput>cd ncclient;python setup.py install</userinput></screen>
</step> </step>
<step> <step>
<para>Edit the <para>Edit the
@ -488,7 +489,7 @@ local_ip=&lt;data-net-IP-address-of-node&gt;</programlisting>
<step> <step>
<para>Restart to apply the new <para>Restart to apply the new
settings:</para> settings:</para>
<screen><prompt>$</prompt> <userinput>sudo service neutron-server restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service neutron-server restart</userinput></screen>
</step> </step>
</procedure> </procedure>
</section> </section>
@ -503,7 +504,7 @@ local_ip=&lt;data-net-IP-address-of-node&gt;</programlisting>
<step> <step>
<para>Install the NSX plug-in, as <para>Install the NSX plug-in, as
follows:</para> follows:</para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install neutron-plugin-vmware</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-vmware</userinput></screen>
</step> </step>
<step> <step>
<para>Edit <para>Edit
@ -595,7 +596,7 @@ nsx_controllers = &lt;comma separated list of API endpoints></programlisting>
<para>Restart <systemitem class="service" <para>Restart <systemitem class="service"
>neutron-server</systemitem> to apply >neutron-server</systemitem> to apply
new settings:</para> new settings:</para>
<screen><prompt>$</prompt> <userinput>sudo service neutron-server restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service neutron-server restart</userinput></screen>
</step> </step>
</procedure> </procedure>
<para>Example <filename>nsx.ini</filename> <para>Example <filename>nsx.ini</filename>
@ -750,7 +751,7 @@ password = "PLUMgrid-director-admin-password"</programlisting>
<para>Restart <para>Restart
<systemitem class="service" <systemitem class="service"
>neutron-server</systemitem> to apply the new settings:</para> >neutron-server</systemitem> to apply the new settings:</para>
<screen><prompt>$</prompt> <userinput>sudo service neutron-server restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service neutron-server restart</userinput></screen>
</step> </step>
</procedure> </procedure>
</section> </section>
@ -762,7 +763,7 @@ password = "PLUMgrid-director-admin-password"</programlisting>
<step> <step>
<para>Install the Ryu plug-in, as <para>Install the Ryu plug-in, as
follows:</para> follows:</para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install neutron-plugin-ryu</userinput> </screen> <screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-ryu</userinput> </screen>
</step> </step>
<step> <step>
<para>Edit <para>Edit
@ -827,7 +828,7 @@ password = "PLUMgrid-director-admin-password"</programlisting>
<para>Restart <systemitem class="service" <para>Restart <systemitem class="service"
>neutron-server</systemitem> to apply >neutron-server</systemitem> to apply
the new settings:</para> the new settings:</para>
<screen><prompt>$</prompt> <userinput>sudo service neutron-server restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service neutron-server restart</userinput></screen>
</step> </step>
</procedure> </procedure>
</section> </section>
@ -880,7 +881,7 @@ password = "PLUMgrid-director-admin-password"</programlisting>
<para>Install the OVS agent package. This <para>Install the OVS agent package. This
action also installs the Open vSwitch action also installs the Open vSwitch
software as a dependency:</para> software as a dependency:</para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install neutron-plugin-openvswitch-agent</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-openvswitch-agent</userinput></screen>
</step> </step>
<step> <step>
<para>On each node that runs the <para>On each node that runs the
@ -906,11 +907,11 @@ password = "PLUMgrid-director-admin-password"</programlisting>
<step> <step>
<para>Restart Open vSwitch to properly load <para>Restart Open vSwitch to properly load
the kernel module:</para> the kernel module:</para>
<screen><prompt>$</prompt> <userinput>sudo service openvswitch-switch restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service openvswitch-switch restart</userinput></screen>
</step> </step>
<step> <step>
<para>Restart the agent:</para> <para>Restart the agent:</para>
<screen><prompt>$</prompt> <userinput>sudo service neutron-plugin-openvswitch-agent restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service neutron-plugin-openvswitch-agent restart</userinput></screen>
</step> </step>
<step> <step>
<para>All nodes that run <para>All nodes that run
@ -918,7 +919,7 @@ password = "PLUMgrid-director-admin-password"</programlisting>
must have an OVS <literal>br-int</literal> must have an OVS <literal>br-int</literal>
bridge. To create the bridge, bridge. To create the bridge,
run:</para> run:</para>
<screen><prompt>$</prompt> <userinput>sudo ovs-vsctl add-br br-int</userinput></screen> <screen><prompt>#</prompt> <userinput>ovs-vsctl add-br br-int</userinput></screen>
</step> </step>
</procedure> </procedure>
</section> </section>
@ -986,13 +987,13 @@ password = "PLUMgrid-director-admin-password"</programlisting>
plug-in</title> plug-in</title>
<step> <step>
<para>Install Ryu (there isn't currently an <para>Install Ryu (there isn't currently an
Ryu package for ubuntu):</para> Ryu package for Ubuntu):</para>
<screen><prompt>$</prompt> <userinput>sudo pip install ryu</userinput></screen> <screen><prompt>#</prompt> <userinput>pip install ryu</userinput></screen>
</step> </step>
<step> <step>
<para>Install the Ryu agent and Open vSwitch <para>Install the Ryu agent and Open vSwitch
packages:</para> packages:</para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install neutron-plugin-ryu-agent openvswitch-switch python-openvswitch openvswitch-datapath-dkms</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-ryu-agent openvswitch-switch python-openvswitch openvswitch-datapath-dkms</userinput></screen>
</step> </step>
<step> <step>
<para>Replicate the <para>Replicate the
@ -1005,11 +1006,11 @@ password = "PLUMgrid-director-admin-password"</programlisting>
<step> <step>
<para>Restart Open vSwitch to properly load <para>Restart Open vSwitch to properly load
the kernel module:</para> the kernel module:</para>
<screen><prompt>$</prompt> <userinput>sudo service openvswitch-switch restart</userinput></screen> <screen><prompt>#</prompt> <userinput>service openvswitch-switch restart</userinput></screen>
</step> </step>
<step> <step>
<para>Restart the agent:</para> <para>Restart the agent:</para>
<screen><prompt>$</prompt> <userinput>sudo service neutron-plugin-ryu-agent restart</userinput> </screen> <screen><prompt>#</prompt> <userinput>service neutron-plugin-ryu-agent restart</userinput> </screen>
</step> </step>
<step> <step>
<para>All nodes running <para>All nodes running
@ -1017,7 +1018,7 @@ password = "PLUMgrid-director-admin-password"</programlisting>
also require that an OVS bridge named also require that an OVS bridge named
"br-int" exists on each node. To create "br-int" exists on each node. To create
the bridge, run:</para> the bridge, run:</para>
<screen><prompt>$</prompt> <userinput>sudo ovs-vsctl add-br br-int</userinput></screen> <screen><prompt>#</prompt> <userinput>ovs-vsctl add-br br-int</userinput></screen>
</step> </step>
</procedure> </procedure>
</section> </section>
@ -1039,7 +1040,7 @@ password = "PLUMgrid-director-admin-password"</programlisting>
</step> </step>
<step> <step>
<para>Install the DHCP agent:</para> <para>Install the DHCP agent:</para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install neutron-dhcp-agent</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install neutron-dhcp-agent</userinput></screen>
</step> </step>
<step> <step>
<para>Finally, update any options in the <para>Finally, update any options in the
@ -1141,7 +1142,7 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
<para>Install the <para>Install the
<systemitem>neutron-l3-agent</systemitem> <systemitem>neutron-l3-agent</systemitem>
binary on the network node:</para> binary on the network node:</para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install neutron-l3-agent</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install neutron-l3-agent</userinput></screen>
</step> </step>
<step> <step>
<para>To uplink the node that runs <para>To uplink the node that runs
@ -1151,8 +1152,8 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
network to this bridge.</para> network to this bridge.</para>
<para>For example, with Open vSwitch and NIC eth1 <para>For example, with Open vSwitch and NIC eth1
connected to the external network, run:</para> connected to the external network, run:</para>
<screen><prompt>$</prompt> <userinput>sudo ovs-vsctl add-br br-ex</userinput></screen> <screen><prompt>#</prompt> <userinput>ovs-vsctl add-br br-ex</userinput>
<screen><prompt>$</prompt> <userinput>sudo ovs-vsctl add-port br-ex eth1</userinput></screen> <prompt>#</prompt> <userinput>ovs-vsctl add-port br-ex eth1</userinput></screen>
<para>Do not manually configure an IP address on <para>Do not manually configure an IP address on
the NIC connected to the external network for the NIC connected to the external network for
the node running the node running
@ -1220,7 +1221,7 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
node</title> node</title>
<step> <step>
<para>Install the agent by running:</para> <para>Install the agent by running:</para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install neutron-plugin-metering-agent</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install neutron-plugin-metering-agent</userinput></screen>
</step> </step>
<step> <step>
<para>If you use one of the following plugins, you need to configure the metering agent with these lines as well:</para> <para>If you use one of the following plugins, you need to configure the metering agent with these lines as well:</para>
@ -1261,7 +1262,7 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
<listitem> <listitem>
<para>Install the agent by running:</para> <para>Install the agent by running:</para>
<para> <para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install neutron-lbaas-agent</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install neutron-lbaas-agent</userinput></screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>

3
doc/admin-guide-cloud/section_ts_failed_attach_vol_no_sysfsutils.xml
View File

@ -16,8 +16,7 @@ Failed to attach volume 13d5c633-903a-4764-a5a0-3336945b1db1 at /dev/vdk.</progr
<para>Run the following command on the compute node to install the <para>Run the following command on the compute node to install the
<filename>sysfsutils</filename> packages.</para> <filename>sysfsutils</filename> packages.</para>
<para> <para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install sysfsutils</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install sysfsutils</userinput></screen>
</para> </para>
</section> </section>
</section> </section>

3
doc/admin-guide-cloud/section_ts_multipath_warn.xml
View File

@ -21,8 +21,7 @@
<para>Run the following command on the compute node to install the <para>Run the following command on the compute node to install the
<filename>multipath-tools</filename> packages.</para> <filename>multipath-tools</filename> packages.</para>
<para> <para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install multipath-tools</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install multipath-tools</userinput></screen>
</para> </para>
</section> </section>
</section> </section>

2
doc/admin-guide-cloud/section_ts_vol_attach_miss_sg_scan.xml
View File

@ -24,6 +24,6 @@ Stdout: '/usr/local/bin/nova-rootwrap: Executable not found: /usr/bin/sg_scan</c
<title>Solution</title> <title>Solution</title>
<para>Run this command on the compute node to install the <para>Run this command on the compute node to install the
<package>sg3-utils</package> package:</para> <package>sg3-utils</package> package:</para>
<screen><prompt>$</prompt> <userinput>sudo apt-get install sg3-utils</userinput></screen> <screen><prompt>#</prompt> <userinput>apt-get install sg3-utils</userinput></screen>
</section> </section>
</section> </section>