ed8fd1c397
This new chapter is taken from the common/ section, and explains how to install clients on machines outside the OpenStack cluster. The install guide can be misleading about how to use clients to administrate the cloud, adding this section will hopefully help clarifying this. pom.xml is modified to add an audience target (installer), used to build specific parts of the common files. backport: none Change-Id: Ib4187d86bb2e3d7d9a26df426e17b4f4039a90fa
108 lines
5.1 KiB
XML
108 lines
5.1 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE section [
|
|
<!-- Some useful entities borrowed from HTML -->
|
|
<!ENTITY ndash "–">
|
|
<!ENTITY mdash "—">
|
|
<!ENTITY hellip "…">
|
|
<!ENTITY plusmn "±">
|
|
]>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xmlns:raxm="http://docs.rackspace.com/api/metadata" version="5.0"
|
|
xml:id="section_cli_overview">
|
|
<title>Overview</title>
|
|
<para>You can use the OpenStack command-line clients to run simple
|
|
commands that make API calls. You can run these commands from
|
|
the command line or in scripts to automate tasks. As long as
|
|
you provide OpenStack credentials, you can run these commands
|
|
on any machine.</para>
|
|
<para>Internally, each client command runs cURL commands that
|
|
embed API requests. The OpenStack APIs are RESTful APIs that
|
|
use the HTTP protocol, including methods, URIs, media types,
|
|
and response codes.</para>
|
|
<para>These open-source Python clients run on Linux or Mac OS X
|
|
systems and are easy to learn and use. Each OpenStack service
|
|
has its own command-line client. On some client commands, you
|
|
can specify a <parameter
|
|
xmlns:svg="http://www.w3.org/2000/svg"
|
|
xmlns:m="http://www.w3.org/1998/Math/MathML"
|
|
xmlns:html="http://www.w3.org/1999/xhtml"
|
|
xmlns:db="http://docbook.org/ns/docbook">debug</parameter>
|
|
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>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>
|
|
</section>
|