openstack/openstack-manuals
Code Issues Proposed changes

Created service table plus edits

Browse Source 
Moved itemized client list of into service/client table for clarity.
Also small edits in the installation chapter.

Change-Id: I5b6e31a77fa1c955f0078c3b791ed7cdc547d674
This commit is contained in:
Summer Long 2014-02-05 12:52:37 +10:00
parent c8b74cefd9
commit 41ac6ecacb
2 changed files with 96 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/common/section_cli_install.xml
View File

@ -165,46 +165,47 @@
through the clients or the APIs.</para> through the clients or the APIs.</para>
<procedure> <procedure>
<step> <step>
<para>You must install each client separately.</para> <para>Install each client separately using:</para>
<para>Run this command to install a client package.</para> <itemizedlist>
<para>For Mac OS X or Linux:</para> <listitem><para>For Mac OS X or Linux:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen> <screen><prompt>$</prompt> <userinput>sudo pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen></listitem>
<para>For Microsoft Windows:</para> <listitem><para>For Microsoft Windows:</para>
<screen><prompt>C:\></prompt><userinput>pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen> <screen><prompt>C:\></prompt><userinput>pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen></listitem>
</itemizedlist>
<para>Where <replaceable>PROJECT</replaceable> is the <para>Where <replaceable>PROJECT</replaceable> is the
project name and has one of the following project name and has one of the following
values:</para> values:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><literal>nova</literal>. Compute API and <para><literal>nova</literal> - Compute API and
extensions.</para> extensions.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>neutron</literal>. Networking <para><literal>neutron</literal> - Networking
API.</para> API.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>keystone</literal>. Identity <para><literal>keystone</literal> - Identity
Service API.</para> Service API.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>glance</literal>. Image Service <para><literal>glance</literal> - Image Service
API.</para> API.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>swift</literal>. Object Storage <para><literal>swift</literal> - Object Storage
API.</para> API.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>cinder</literal>. Block Storage <para><literal>cinder</literal> - Block Storage
Service API.</para> Service API.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>heat</literal>. Orchestration <para><literal>heat</literal> - Orchestration
API.</para> API.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>ceilometer</literal>. <para><literal>ceilometer</literal> -
Telemetry API.</para> Telemetry API.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -214,12 +215,12 @@
<para>To remove the nova client, run this <para>To remove the nova client, run this
command:</para> command:</para>
<screen><prompt>$</prompt> <userinput>sudo pip uninstall python-novaclient</userinput></screen> <screen><prompt>$</prompt> <userinput>sudo pip uninstall python-novaclient</userinput></screen>
<para>To upgrade a package, add the <note> <para>To upgrade a package, add the
<literal>--upgrade</literal> option to the <literal>--upgrade</literal> option to the
<command>pip</command> command.</para> <command>pip</command> command.</para>
<para>To update the nova client, run this <para>For example, to update the <systemitem>nova</systemitem> client, run this
command:</para> command:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install --upgrade python-novaclient</userinput></screen> <screen><prompt>$</prompt> <userinput>sudo pip install --upgrade python-novaclient</userinput></screen></note>
</step> </step>
<step audience="enduser"> <step audience="enduser">
<para>Before you can run client commands, you must <para>Before you can run client commands, you must

147
doc/common/section_cli_overview.xml
View File

@ -32,76 +32,83 @@
parameter to show the underlying API request for the command. parameter to show the underlying API request for the command.
This is a good way to become familiar with the OpenStack API This is a good way to become familiar with the OpenStack API
calls.</para> calls.</para>
<para>These command-line clients are available for the respective <para>The following table lists the command-line client for each
services' APIs:</para> OpenStack service, together with its
<itemizedlist> package name and description.</para>
<listitem> <table rules="all">
<para><command>ceilometer</command> <caption>OpenStack services and clients</caption>
(<package>python-ceilometerclient</package>). <col width="15%"/>
Client for the Telemetry API that lets you create and <col width="10%"/>
collect measurements across OpenStack.</para> <col width="20%"/>
</listitem> <col width="55%"/>
<listitem> <thead>
<para><command>cinder</command> <tr>
(<package>python-cinderclient</package>). Client <th>Service</th>
for the Block Storage Service API that lets you create <th>Client</th>
and manage volumes.</para> <th>Package</th>
</listitem> <th>Description</th>
<listitem> </tr>
<para><command>glance</command> </thead>
(<package>python-glanceclient</package>). Client <tbody>
for the Image Service API that lets you create and <tr>
manage images.</para> <td>Block Storage</td>
</listitem> <td><command>cinder</command></td>
<listitem> <td><package>python-cinderclient</package></td>
<para><command>heat</command> <td>Create and manage volumes.</td>
(<package>python-heatclient</package>). Client for </tr>
the Orchestration API that lets you launch stacks from <tr>
templates, view details of running stacks including <td>Compute</td>
events and resources, and update and delete <td><command>nova</command></td>
stacks.</para> <td><package>python-novaclient</package></td>
</listitem> <td>Create and manage images, instances, and flavors.</td>
<listitem> </tr>
<para><command>keystone</command> <tr>
(<package>python-keystoneclient</package>). Client <td>Identity</td>
for the Identity Service API that lets you create and <td><command>keystone</command></td>
manage users, tenants, roles, endpoints, and <td><package>python-keystoneclient</package></td>
credentials.</para> <td>Create and manage users, tenants, roles, endpoints, and credentials.</td>
</listitem> </tr>
<listitem> <tr>
<para><command>neutron</command> <td>Image Service</td>
(<package>python-neutronclient</package>). Client <td><command>glance</command></td>
for the Networking API that lets you configure <td><package>python-glanceclient</package></td>
networks for guest servers. This client was previously <td>Create and manage images.</td>
known as <command>quantum</command>.</para> </tr>
</listitem> <tr>
<listitem> <td>Networking</td>
<para><command>nova</command> <td><command>neutron</command></td>
(<package>python-novaclient</package>). Client for <td><package>python-neutronclient</package></td>
the Compute API and its extensions. Use to create and <td>Configure networks for guest servers. This client was previously known as
manage images, instances, and flavors.</para> <command>quantum</command>.</td>
</listitem> </tr>
<listitem> <tr>
<para><command>swift</command> <td>Object Storage</td>
(<package>python-swiftclient</package>). Client <td><command>swift</command></td>
for the Object Storage API that lets you gather <td><package>python-swiftclient</package></td>
statistics, list items, update metadata, upload, <td>Gather statistics, list items, update metadata, and upload, download, and delete
download and delete files stored by the Object Storage files stored by the Object Storage service. Gain access to an Object Storage
service. Provides access to a swift installation for installation for ad hoc processing.</td>
ad hoc processing.</para> </tr>
</listitem> <tr>
</itemizedlist> <td>Orchestration</td>
<td><command>heat</command></td>
<td><package>python-heatclient</package></td>
<td>Launch stacks from templates, view details of running stacks including events
and resources, and update and delete stacks.</td>
</tr>
<tr>
<td>Telemetry</td>
<td><command>ceilometer</command></td>
<td><package>python-ceilometerclient</package></td>
<td>Create and collect measurements across OpenStack.</td>
</tr>
</tbody>
</table>
<para>An OpenStack <command>common</command> client is in <para>An OpenStack <command>common</command> client is in
development.</para> development.</para>
<para audience="adminuser">For client installation instructions, <para audience="adminuser">For client installation instructions, see <link
see <link xlink:href="http://docs.openstack.org/user-guide/content/install_clients.html">Install
xlink:href="http://docs.openstack.org/user-guide/content/install_clients.html" the OpenStack command-line clients</link>. For information about the OpenStack RC file,
>Install the OpenStack command-line clients</link>. For see <link xlink:href="http://docs.openstack.org/user-guide/content/cli_openrc.html">Download
information about the OpenStack RC file, see <link and source the OpenStack RC file</link>.</para>
xlink:href="http://docs.openstack.org/user-guide/content/cli_openrc.html"
>Download and source the OpenStack RC file</link>. Both
topics are in the <link
xlink:href="http://docs.openstack.org/user-guide/content/index.html"
><citetitle>OpenStack End User
Guide</citetitle></link>.</para>
</section> </section>