478428b28f
Add gnocchi to Chapter 1 (for CLI Ref) Add gnocchi to Appendix (common part includes CLI Ref/Config Ref) Add gnocchi CLI Ref XML 2.0.0 (autogenerated) Ref Gnocchi Ceilometer API v3 https://specs.openstack.org/openstack/ceilometer-specs/specs/juno/gnocchi.html P.S. some comments are missing periods in autogenerated file. I post it to gnocchiclient separately. Change-Id: I548bbadee2c42b3d23d1a5be6403cba6f2a88079
167 lines
7.3 KiB
XML
167 lines
7.3 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="section_cli_overview">
|
|
<title>Overview</title>
|
|
<para>
|
|
Each OpenStack project provides a command-line client, which
|
|
enables you to access the project API through easy-to-use
|
|
commands. For example, the Compute service provides a nova
|
|
command-line client.</para>
|
|
<para>
|
|
You can run the commands from the command line, or include the
|
|
commands within scripts to automate tasks. If you provide
|
|
OpenStack credentials, such as your user name and password, you
|
|
can run these commands on any computer.
|
|
</para>
|
|
<para>
|
|
Internally, each command uses cURL command-line tools, which embed
|
|
API requests. OpenStack APIs are RESTful APIs, and use the HTTP
|
|
protocol. They include methods, URIs, media types, and response
|
|
codes.</para>
|
|
<para>
|
|
OpenStack APIs are open-source Python clients, and can run on
|
|
Linux or Mac OS X systems. On some client commands, you can
|
|
specify a <command>debug</command> 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>The following table lists the command-line client for each
|
|
OpenStack service 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>Application catalog</td>
|
|
<td><command>murano</command></td>
|
|
<td><package>python-muranoclient</package></td>
|
|
<td>Creates and manages application catalog.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Block Storage</td>
|
|
<td><command>cinder</command></td>
|
|
<td><package>python-cinderclient</package></td>
|
|
<td>Creates and manages volumes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Compute</td>
|
|
<td><command>nova</command></td>
|
|
<td><package>python-novaclient</package></td>
|
|
<td>Creates and manages images, instances, and flavors.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Containers service</td>
|
|
<td><command>magnum</command></td>
|
|
<td><package>python-magnumclient</package></td>
|
|
<td>Creates and manages containers.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Database service</td>
|
|
<td><command>trove</command></td>
|
|
<td><package>python-troveclient</package></td>
|
|
<td>Creates and manages databases.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Data processing service</td>
|
|
<td><command>sahara</command></td>
|
|
<td><package>python-saharaclient</package></td>
|
|
<td>Creates and manages Hadoop clusters on OpenStack.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Deployment service</td>
|
|
<td><command>tuskar</command></td>
|
|
<td><package>python-tuskarclient</package></td>
|
|
<td>Plans Deployments.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Identity</td>
|
|
<td><command>openstack</command></td>
|
|
<td><package>python-openstackclient</package></td>
|
|
<td>Creates and manages 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>Creates and manages images.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Key Manager service</td>
|
|
<td><command>barbican</command></td>
|
|
<td><package>python-barbicanclient</package></td>
|
|
<td>Creates and manages keys.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Networking</td>
|
|
<td><command>neutron</command></td>
|
|
<td><package>python-neutronclient</package></td>
|
|
<td>Configures networks for guest servers. This client was
|
|
previously called <command>quantum</command>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Object Storage</td>
|
|
<td><command>swift</command></td>
|
|
<td><package>python-swiftclient</package></td>
|
|
<td>Gathers statistics, lists items, updates metadata, and uploads, downloads,
|
|
and deletes files stored by the Object Storage service. Gains 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>Launches stacks from templates, views details of running stacks including
|
|
events and resources, and updates and deletes stacks.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Shared file systems</td>
|
|
<td><command>manila</command></td>
|
|
<td><package>python-manilaclient</package></td>
|
|
<td>Creates and manages shared file systems.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Telemetry</td>
|
|
<td><command>ceilometer</command></td>
|
|
<td><package>python-ceilometerclient</package></td>
|
|
<td>Creates and collects measurements across OpenStack.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Telemetry v3</td>
|
|
<td><command>gnocchi</command></td>
|
|
<td><package>python-gnocchiclient</package></td>
|
|
<td>Creates and collects measurements across OpenStack.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Workflow service</td>
|
|
<td><command>mistral</command></td>
|
|
<td><package>python-mistralclient</package></td>
|
|
<td>Workflow service for OpenStack cloud.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Common client</td>
|
|
<td><command>openstack</command></td>
|
|
<td><package>python-openstackclient</package></td>
|
|
<td>Common client for the OpenStack project.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<para audience="adminuser">For client installation instructions, see <link
|
|
xlink:href="http://docs.openstack.org/user-guide/common/cli_install_openstack_command_line_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/common/cli_set_environment_variables_using_openstack_rc.html">Download
|
|
and source the OpenStack RC file</link>.</para>
|
|
</section>
|