Skip to content

Commit

Permalink
Slight fleshing of nova-manage doc
Browse files Browse the repository at this point in the history
This is perhaps a stop-gap change until the proper CLI doc is in
place. As most commandline use is moving towards nova client, rather
than nova-manage simply extending
the phrasing a little and encouraging users to read the man page.

Placing nova client first, based on feedback

fixes bug 766703

Second patch - addresses concerns from previous patches about leading
with novaclient, and emphasising that nova-manage is only for
administrators.

Change-Id: Id94fe752a86c0e6c6ebeb2ed88a2f7526716f854
  • Loading branch information
fifieldt committed Aug 18, 2012
1 parent 8f5fba6 commit 09c68d4
Showing 1 changed file with 26 additions and 18 deletions.
44 changes: 26 additions & 18 deletions doc/src/docbkx/openstack-compute-admin/computeadmin.xml
Expand Up @@ -138,25 +138,11 @@ format="SVG" scale="60"/>
<section xml:id="managing-the-cloud">

<title>Managing the Cloud</title><para>There are three main tools that a system administrator will find useful to manage their cloud;
the nova-manage command, and the novaclient or the Euca2ools commands. </para>
<para>The nova-manage command may only be run by users with admin privileges. Both
the nova client, the nova-manage command, and the Euca2ools commands. </para>
<para>The nova-manage command may only be run by cloud administrators. Both
novaclient and euca2ools can be used by all users, though specific commands may be
restricted by Role Based Access Control in the deprecated nova auth system or in the Identity Management service. </para>
<simplesect><title>Using the nova-manage command</title>
<para>The nova-manage command may be used to perform many essential functions for
administration and ongoing maintenance of nova, such as network creation.</para>

<para>The standard pattern for executing a nova-manage command is: </para>
<screen>
<prompt>$</prompt> <userinput>nova-manage category command <replaceable>[args]</replaceable></userinput>
</screen>

<para>For example, to obtain a list of all projects:
<command>nova-manage project list</command></para>

<para>Run without arguments to see a list of available command categories: nova-manage</para>
<para>You can also run with a category argument such as user to see a list of all commands in that category: nova-manage user</para>
</simplesect><simplesect><title>Using the nova command-line tool</title>
<simplesect><title>Using the nova command-line tool</title>
<para>Installing the python-novaclient gives you a <code>nova</code> shell command that enables
Compute API interactions from the command line. You install the client, and then provide
your username and password, set as environment variables for convenience, and then you
Expand Down Expand Up @@ -203,7 +189,29 @@ usage: nova [--debug] [--os_username OS_USERNAME] [--os_password OS_PASSWORD]
<prompt>$</prompt> <userinput>export NOVA_VERSION=1.1</userinput>
</screen>
</para></simplesect>
<simplesect><title>Using the euca2ools commands</title>

<simplesect><title>Using the nova-manage command</title>
<para>The nova-manage command may be used to perform many essential functions for
administration and ongoing maintenance of nova, such as network creation or user
manipulation.</para>
<para>The man page for nova-manage has a good explanation for each of its functions, and is
recommended reading for those starting out. Access it by running:
</para>
<screen>
<prompt>$</prompt> <userinput>man nova-manage</userinput>
</screen>

<para>For administrators, the standard pattern for executing a nova-manage command is: </para>
<screen>
<prompt>$</prompt> <userinput>nova-manage category command <replaceable>[args]</replaceable></userinput>
</screen>

<para>For example, to obtain a list of all projects:
<command>nova-manage project list</command></para>

<para>Run without arguments to see a list of available command categories: nova-manage</para>
<para>You can also run with a category argument such as user to see a list of all commands in that category: nova-manage user</para>
</simplesect> <simplesect><title>Using the euca2ools commands</title>
<para>For a command-line interface to EC2 API calls, use
the euca2ools command line tool. It is documented at
<link
Expand Down

0 comments on commit 09c68d4

Please sign in to comment.