Created service table plus edits
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
parent
c8b74cefd9
commit
41ac6ecacb
@ -165,46 +165,47 @@
|
||||
through the clients or the APIs.</para>
|
||||
<procedure>
|
||||
<step>
|
||||
<para>You must install each client separately.</para>
|
||||
<para>Run this command to install a client package.</para>
|
||||
<para>For Mac OS X or Linux:</para>
|
||||
<screen><prompt>$</prompt> <userinput>sudo pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen>
|
||||
<para>For Microsoft Windows:</para>
|
||||
<screen><prompt>C:\></prompt><userinput>pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen>
|
||||
<para>Install each client separately using:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>For Mac OS X or Linux:</para>
|
||||
<screen><prompt>$</prompt> <userinput>sudo pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen></listitem>
|
||||
<listitem><para>For Microsoft Windows:</para>
|
||||
<screen><prompt>C:\></prompt><userinput>pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen></listitem>
|
||||
</itemizedlist>
|
||||
<para>Where <replaceable>PROJECT</replaceable> is the
|
||||
project name and has one of the following
|
||||
values:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><literal>nova</literal>. Compute API and
|
||||
<para><literal>nova</literal> - Compute API and
|
||||
extensions.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>neutron</literal>. Networking
|
||||
<para><literal>neutron</literal> - Networking
|
||||
API.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>keystone</literal>. Identity
|
||||
<para><literal>keystone</literal> - Identity
|
||||
Service API.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>glance</literal>. Image Service
|
||||
<para><literal>glance</literal> - Image Service
|
||||
API.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>swift</literal>. Object Storage
|
||||
<para><literal>swift</literal> - Object Storage
|
||||
API.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>cinder</literal>. Block Storage
|
||||
<para><literal>cinder</literal> - Block Storage
|
||||
Service API.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>heat</literal>. Orchestration
|
||||
<para><literal>heat</literal> - Orchestration
|
||||
API.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>ceilometer</literal>.
|
||||
<para><literal>ceilometer</literal> -
|
||||
Telemetry API.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -214,12 +215,12 @@
|
||||
<para>To remove the nova client, run this
|
||||
command:</para>
|
||||
<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
|
||||
<command>pip</command> command.</para>
|
||||
<para>To update the nova client, run this
|
||||
command:</para>
|
||||
<screen><prompt>$</prompt> <userinput>sudo pip install --upgrade python-novaclient</userinput></screen>
|
||||
<para>For example, to update the <systemitem>nova</systemitem> client, run this
|
||||
command:</para>
|
||||
<screen><prompt>$</prompt> <userinput>sudo pip install --upgrade python-novaclient</userinput></screen></note>
|
||||
</step>
|
||||
<step audience="enduser">
|
||||
<para>Before you can run client commands, you must
|
||||
|
||||
@ -32,76 +32,83 @@
|
||||
parameter to show the underlying API request for the command.
|
||||
This is a good way to become familiar with the OpenStack API
|
||||
calls.</para>
|
||||
<para>These command-line clients are available for the respective
|
||||
services' APIs:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><command>ceilometer</command>
|
||||
(<package>python-ceilometerclient</package>).
|
||||
Client for the Telemetry API that lets you create and
|
||||
collect measurements across OpenStack.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><command>cinder</command>
|
||||
(<package>python-cinderclient</package>). Client
|
||||
for the Block Storage Service API that lets you create
|
||||
and manage volumes.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><command>glance</command>
|
||||
(<package>python-glanceclient</package>). Client
|
||||
for the Image Service API that lets you create and
|
||||
manage images.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><command>heat</command>
|
||||
(<package>python-heatclient</package>). Client for
|
||||
the Orchestration API that lets you launch stacks from
|
||||
templates, view details of running stacks including
|
||||
events and resources, and update and delete
|
||||
stacks.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><command>keystone</command>
|
||||
(<package>python-keystoneclient</package>). Client
|
||||
for the Identity Service API that lets you create and
|
||||
manage users, tenants, roles, endpoints, and
|
||||
credentials.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><command>neutron</command>
|
||||
(<package>python-neutronclient</package>). Client
|
||||
for the Networking API that lets you configure
|
||||
networks for guest servers. This client was previously
|
||||
known as <command>quantum</command>.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><command>nova</command>
|
||||
(<package>python-novaclient</package>). Client for
|
||||
the Compute API and its extensions. Use to create and
|
||||
manage images, instances, and flavors.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><command>swift</command>
|
||||
(<package>python-swiftclient</package>). Client
|
||||
for the Object Storage API that lets you gather
|
||||
statistics, list items, update metadata, upload,
|
||||
download and delete files stored by the Object Storage
|
||||
service. Provides access to a swift installation for
|
||||
ad hoc processing.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The following table lists the command-line client for each
|
||||
OpenStack service, together with its
|
||||
package name and description.</para>
|
||||
<table rules="all">
|
||||
<caption>OpenStack services and clients</caption>
|
||||
<col width="15%"/>
|
||||
<col width="10%"/>
|
||||
<col width="20%"/>
|
||||
<col width="55%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service</th>
|
||||
<th>Client</th>
|
||||
<th>Package</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Block Storage</td>
|
||||
<td><command>cinder</command></td>
|
||||
<td><package>python-cinderclient</package></td>
|
||||
<td>Create and manage volumes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Compute</td>
|
||||
<td><command>nova</command></td>
|
||||
<td><package>python-novaclient</package></td>
|
||||
<td>Create and manage images, instances, and flavors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Identity</td>
|
||||
<td><command>keystone</command></td>
|
||||
<td><package>python-keystoneclient</package></td>
|
||||
<td>Create and manage users, tenants, roles, endpoints, and credentials.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Image Service</td>
|
||||
<td><command>glance</command></td>
|
||||
<td><package>python-glanceclient</package></td>
|
||||
<td>Create and manage images.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Networking</td>
|
||||
<td><command>neutron</command></td>
|
||||
<td><package>python-neutronclient</package></td>
|
||||
<td>Configure networks for guest servers. This client was previously known as
|
||||
<command>quantum</command>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Object Storage</td>
|
||||
<td><command>swift</command></td>
|
||||
<td><package>python-swiftclient</package></td>
|
||||
<td>Gather statistics, list items, update metadata, and upload, download, and delete
|
||||
files stored by the Object Storage service. Gain access to an Object Storage
|
||||
installation for ad hoc processing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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
|
||||
development.</para>
|
||||
<para audience="adminuser">For client installation instructions,
|
||||
see <link
|
||||
xlink:href="http://docs.openstack.org/user-guide/content/install_clients.html"
|
||||
>Install the OpenStack command-line clients</link>. For
|
||||
information about the OpenStack RC file, see <link
|
||||
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>
|
||||
<para audience="adminuser">For client installation instructions, see <link
|
||||
xlink:href="http://docs.openstack.org/user-guide/content/install_clients.html">Install
|
||||
the OpenStack command-line clients</link>. For information about the OpenStack RC file,
|
||||
see <link xlink:href="http://docs.openstack.org/user-guide/content/cli_openrc.html">Download
|
||||
and source the OpenStack RC file</link>.</para>
|
||||
</section>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user