Remove remaining sudo usages

Remove sudo usage and adjust prompts as needed. Fixup markup to
follow our conventions.

Change-Id: I93e4d06c6ea778e8eb6904338bc9c36080a24dac
This commit is contained in:
Andreas Jaeger
2014-03-10 20:36:38 +01:00
parent 4f00b8bc36
commit 368fbd33ba
6 changed files with 59 additions and 75 deletions

View File

@@ -92,9 +92,10 @@
</listitem> </listitem>
<listitem> <listitem>
<formalpara> <formalpara>
<title>To install a client package the following command syntax is used: <title>To install a client package</title>
$ sudo pip install [--update] python-project client (True or False)</title> <para>
<para> Run this command:
<screen><prompt>#</prompt> <userinput>pip install [--update] python-project client (True or False)</userinput></screen>
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>True</para> <para>True</para>
@@ -108,9 +109,10 @@
</listitem> </listitem>
<listitem> <listitem>
<formalpara> <formalpara>
<title>To get a list of images in glance you can use the following command syntax: <title>To list images</title>
$ glance image-list</title> <para>
<para> Run this command:
<screen><prompt>$</prompt> <userinput>glance image-list</userinput></screen>
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>True</para> <para>True</para>

View File

@@ -81,11 +81,10 @@
<informaltable class="c25"> <informaltable class="c25">
<tbody> <tbody>
<tr> <tr>
<td rowspan="1" colspan="1">$sudo apt-get install <td rowspan="1" colspan="1"><screen><prompt>#</prompt> <userinput>apt-get install cpu-checker</userinput></screen></td>
cpu-checker</td>
</tr> </tr>
<tr> <tr>
<td>$sudo kvm-ok</td> <td><screen><prompt>#</prompt> <userinput>kvm-ok</userinput></screen></td>
</tr> </tr>
</tbody> </tbody>
</informaltable> </informaltable>
@@ -612,20 +611,16 @@
shutdown your 3. In case your VM's don't get internet.</para> shutdown your 3. In case your VM's don't get internet.</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>From your VM Instance, Use ping command to see whether <para>From your VM Instance, use <command>ping</command>
Internet is on.</para> command to see whether Internet is on.</para>
<screen><prompt>$</prompt> <userinput>ping www.google.com</userinput></screen>
</listitem> </listitem>
</itemizedlist>
<programlisting>$ping www.google.com</programlisting>
<itemizedlist>
<listitem> <listitem>
<para>If its not connected, restart networking <para>If its not connected, restart networking
service-</para> service:</para>
<screen><prompt>#</prompt> <userinput>service networking restart</userinput>
<prompt>#</prompt> <userinput>ping www.google.com</userinput></screen>
</listitem> </listitem>
</itemizedlist>
<programlisting>$sudo service networking restart
$ping www.google.com</programlisting>
<itemizedlist>
<listitem> <listitem>
<para>If this doesn't work, you need to check your network <para>If this doesn't work, you need to check your network
settings from Virtual Box, you may have left something or settings from Virtual Box, you may have left something or

View File

@@ -555,7 +555,7 @@ osapi_volume_listen_port=5900</programlisting>
<listitem> <listitem>
<para>Restart nova-* services (all nova services):</para> <para>Restart nova-* services (all nova services):</para>
<para> <para>
<screen><prompt>#</prompt> <userinput>cd /etc/init.d/; for i in $( ls nova-* ); do sudo service $i restart; done</userinput></screen> <screen><prompt>#</prompt> <userinput>cd /etc/init.d/; for i in $( ls nova-* ); do service $i restart; done</userinput></screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@@ -680,13 +680,13 @@ rabbit_port = 5672</programlisting>
<listitem> <listitem>
<para>Restart the Cinder services:</para> <para>Restart the Cinder services:</para>
<para> <para>
<screen><prompt>#</prompt> <userinput>cd /etc/init.d/; for i in $( ls cinder-* ); do sudo service $i restart; done</userinput></screen> <screen><prompt>#</prompt> <userinput>cd /etc/init.d/; for i in $( ls cinder-* ); do service $i restart; done</userinput></screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Verify if Cinder services are running:</para> <para>Verify if Cinder services are running:</para>
<para> <para>
<screen><prompt>#</prompt> <userinput>cd /etc/init.d/; for i in $( ls cinder-* ); do sudo service $i status; done</userinput></screen> <screen><prompt>#</prompt> <userinput>cd /etc/init.d/; for i in $( ls cinder-* ); do service $i status; done</userinput></screen>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

View File

@@ -278,11 +278,11 @@ osapi_volume_listen_port=5900
cinder_catalog_info=volume:cinder:internalURL</programlisting></para> cinder_catalog_info=volume:cinder:internalURL</programlisting></para>
</listitem> </listitem>
<listitem> <listitem>
<para>Restart Nova Services</para> <para>Restart nova services</para>
<screen><prompt>#</prompt> <userinput>cd /etc/init.d/; for i in $( ls nova-* ); do sudo service $i restart; done</userinput></screen> <screen><prompt>#</prompt> <userinput>cd /etc/init.d/; for i in $( ls nova-* ); do service $i restart; done</userinput></screen>
</listitem> </listitem>
<listitem> <listitem>
<para>List Nova Services (Check for the Smiley Faces to know if the services are running):</para> <para>List nova services (Check for the Smiley Faces to know if the services are running):</para>
<screen><prompt>#</prompt> <userinput>nova-manage service list</userinput></screen> <screen><prompt>#</prompt> <userinput>nova-manage service list</userinput></screen>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

View File

@@ -929,61 +929,47 @@
<listitem> <listitem>
<para>Run the following command to install or update a <para>Run the following command to install or update a
client package:</para> client package:</para>
</listitem> <screen><prompt>#</prompt> <userinput>pip install [--update] python-&lt;project>client</userinput></screen>
<listitem> <para>Where &lt;project> is the project name and has one
<para>$ sudo pip install [--update]
python-&lt;project>client</para>
</listitem>
<listitem>
<para>Where &lt;project> is the project name and has one
of the following values:</para> of the following values:</para>
<itemizedlist>
<listitem>
<para>nova. Compute API and extensions.</para>
</listitem>
<listitem>
<para>neutron. Networking API.</para>
</listitem>
<listitem>
<para>keystone. Identity Service API.</para>
</listitem>
<listitem>
<para>glance. Image Service API.</para>
</listitem>
<listitem>
<para>swift. Object Storage API.</para>
</listitem>
<listitem>
<para>cinder. Block Storage Service API.</para>
</listitem>
<listitem>
<para>heat. Orchestration API.</para>
</listitem>
</itemizedlist>
</listitem> </listitem>
</orderedlist>
<itemizedlist>
<listitem>
<para>nova. Compute API and extensions.</para>
</listitem>
<listitem>
<para>neutron. Networking API.</para>
</listitem>
<listitem>
<para>keystone. Identity Service API.</para>
</listitem>
<listitem>
<para>glance. Image Service API.</para>
</listitem>
<listitem>
<para>swift. Object Storage API.</para>
</listitem>
<listitem>
<para>cinder. Block Storage Service API.</para>
</listitem>
<listitem>
<para>heat. Orchestration API.</para>
</listitem>
</itemizedlist>
<orderedlist>
<listitem> <listitem>
<para>For example, to install the nova client, run the <para>For example, to install the nova client, run the
following command:</para> following command:</para>
</listitem> <screen><prompt>#</prompt> <userinput>pip install python-novaclient</userinput></screen>
<listitem>
<para>$ sudo pip install python-novaclient</para>
</listitem> </listitem>
<listitem> <listitem>
<para>To update the nova client, run the following <para>To update the nova client, run the following
command:</para> command:</para>
</listitem> <screen><prompt>#</prompt> <userinput>pip install --upgrade python-novaclient</userinput></screen>
<listitem>
<para>$ sudo pip install --upgrade
python-novaclient</para>
</listitem> </listitem>
<listitem> <listitem>
<para>To remove the nova client, run the following <para>To remove the nova client, run the following
command:</para> command:</para>
</listitem> <screen><prompt>#</prompt> <userinput>pip uninstall python-novaclient</userinput></screen>
<listitem>
<para>$ sudo pip uninstall python-novaclient</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Before you can issue client commands, you must <para>Before you can issue client commands, you must

View File

@@ -105,7 +105,7 @@
<para>Create the <para>Create the
<filename>apache-maven</filename> <filename>apache-maven</filename>
directory:</para> directory:</para>
<screen><prompt>$</prompt> <userinput>sudo mkdir /usr/local/apache-maven</userinput></screen> <screen><prompt>#</prompt> <userinput>mkdir /usr/local/apache-maven</userinput></screen>
</step> </step>
<step> <step>
<para>Copy the latest stable binary from <link <para>Copy the latest stable binary from <link
@@ -116,8 +116,8 @@
</step> </step>
<step> <step>
<para>Extract the distribution archive to the directory you wish to install Maven:</para> <para>Extract the distribution archive to the directory you wish to install Maven:</para>
<screen><prompt>$</prompt> <userinput>cd /usr/local/apache-maven/</userinput> <screen><prompt>#</prompt> <userinput>cd /usr/local/apache-maven/</userinput>
<prompt>$</prompt> <userinput>sudo tar -xvzf apache-maven-x.x.x-bin.tar.gz</userinput></screen> <prompt>#</prompt> <userinput>tar -xvzf apache-maven-x.x.x-bin.tar.gz</userinput></screen>
<para>The <filename>apache-maven-<replaceable>x.x.x</replaceable></filename> subdirectory is created from the archive file, where <replaceable>x.x.x</replaceable> is your Maven version.</para> <para>The <filename>apache-maven-<replaceable>x.x.x</replaceable></filename> subdirectory is created from the archive file, where <replaceable>x.x.x</replaceable> is your Maven version.</para>
</step> </step>
<step> <step>
@@ -212,9 +212,10 @@
</step> </step>
<step> <step>
<para>Install git-review. If pip is not already <para>Install git-review. If pip is not already
installed, use <code>sudo easy_install pip</code> installed, run <code>easy_install pip</code> as
to install it on a Mac or Ubuntu</para> <systemitem class="username">root</systemitem> to
<screen><prompt>$</prompt> <userinput>sudo pip install git-review</userinput></screen> install it on a Mac or Ubuntu.</para>
<screen><prompt>#</prompt> <userinput>pip install git-review</userinput></screen>
</step> </step>
<step> <step>
<para>Change to the directory:</para> <para>Change to the directory:</para>
@@ -309,7 +310,7 @@
Jenkins runs gating scripts to check that the patch is fine. Locally, Jenkins runs gating scripts to check that the patch is fine. Locally,
you can use the <command>tox</command> tool to run the same checks and ensure that a patch works. you can use the <command>tox</command> tool to run the same checks and ensure that a patch works.
Install the tox package and run it from the top level directory which has the <filename>tox.ini</filename> file.</para> Install the tox package and run it from the top level directory which has the <filename>tox.ini</filename> file.</para>
<screen><prompt>$</prompt> <userinput>sudo pip install tox</userinput> <screen><prompt>#</prompt> <userinput>pip install tox</userinput>
<prompt>$</prompt> <userinput>tox</userinput></screen> <prompt>$</prompt> <userinput>tox</userinput></screen>
<para>Jenkins runs the following four checks. You can run them individually:</para> <para>Jenkins runs the following four checks. You can run them individually:</para>
<substeps> <substeps>
@@ -484,7 +485,7 @@ blueprint training-manuals</computeroutput></screen>
Jenkins runs gating scripts to check that the patch is fine. Locally, Jenkins runs gating scripts to check that the patch is fine. Locally,
you can use the <command>tox</command> tool to run the same checks and ensure that a patch works. you can use the <command>tox</command> tool to run the same checks and ensure that a patch works.
Install the tox package and run it from the top level directory which has the <filename>tox.ini</filename> file.</para> Install the tox package and run it from the top level directory which has the <filename>tox.ini</filename> file.</para>
<screen><prompt>$</prompt> <userinput>sudo pip install tox</userinput> <screen><prompt>#</prompt> <userinput>pip install tox</userinput>
<prompt>$</prompt> <userinput>tox</userinput></screen> <prompt>$</prompt> <userinput>tox</userinput></screen>
</step> </step>
<step> <step>