5fca287eb5
There are several instances of "Block Storage Service" in the upstream documentation. As was recently clarified in the docs mailing list, these should be "Block Storage service". This patch applies the fix. Change-Id: I591c100ab031b75f1c0d27d45f53e32401a26e30 Partial-Bug: #1217503
233 lines
12 KiB
XML
233 lines
12 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" version="5.0"
|
|
xml:id="install_clients">
|
|
<?dbhtml stop-chunking?>
|
|
<title>Install the OpenStack command-line clients</title>
|
|
<para>Install the prerequisite software and the Python package for
|
|
each OpenStack client.</para>
|
|
<note>
|
|
<para>For each command, replace
|
|
<replaceable>PROJECT</replaceable> with the lower case
|
|
name of the client to install, such as
|
|
<literal>nova</literal>. Repeat for each
|
|
client.</para>
|
|
</note>
|
|
<table rules="all" width="75%">
|
|
<caption>Prerequisite software</caption>
|
|
<col width="15%"/>
|
|
<col width="85%"/>
|
|
<thead>
|
|
<tr>
|
|
<th>Prerequisite</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td valign="top">
|
|
<para>Python 2.6 or newer</para>
|
|
</td>
|
|
<td>
|
|
<para>Currently, the clients do not support Python
|
|
3.</para>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">
|
|
<para><package>setuptools</package> package</para>
|
|
</td>
|
|
<td>
|
|
<para>Installed by default on Mac OS X.</para>
|
|
<para>Many Linux distributions provide packages to make
|
|
<package>setuptools</package> easy to install. Search
|
|
your package manager for <package>setuptools</package>
|
|
to find an installation package. If you cannot find
|
|
one, download the <package>setuptools</package> package
|
|
directly from <link
|
|
xlink:href="http://pypi.python.org/pypi/setuptools"
|
|
>http://pypi.python.org/pypi/setuptools</link>.</para>
|
|
<para>The recommended way to install
|
|
<package>setuptools</package> on Microsoft Windows is
|
|
to follow the documentation provided <link
|
|
xlink:href="https://pypi.python.org/pypi/setuptools#windows"
|
|
>on the setuptools website</link>. Another option is
|
|
to use the unofficial binary installer maintained by
|
|
Christoph Gohlke (<link
|
|
xlink:href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools"
|
|
>http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools</link>).
|
|
</para>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><package>pip</package> package</td>
|
|
<td>
|
|
<para>To install the clients on a Linux, Mac OS X or Microsoft
|
|
Windows system, use <package>pip</package>. It
|
|
is easy to use, ensures that you get the
|
|
latest version of the clients from the <link
|
|
xlink:href="http://pypi.python.org/pypi/python-novaclient/"
|
|
>Python Package Index</link>, and lets you
|
|
update or remove the packages later on.</para>
|
|
<para>Install <package>pip</package> through the
|
|
package manager for your system:</para>
|
|
<formalpara>
|
|
<title>Mac OS X</title>
|
|
<para>
|
|
<screen><prompt>#</prompt> <userinput>easy_install pip</userinput></screen></para>
|
|
</formalpara>
|
|
<formalpara>
|
|
<title>Microsoft Windows</title>
|
|
<para>Make sure that the
|
|
<filename>C:\Python27\Scripts</filename> directory
|
|
is defined in the <literal>PATH</literal>
|
|
environment variable, and use the
|
|
<command>easy_install</command> command from the
|
|
<package>setuptools</package> package:
|
|
<screen><prompt>C:\></prompt><userinput>easy_install pip</userinput></screen>
|
|
Another option is to use the unofficial binary
|
|
installer provided by Christoph Gohlke (<link
|
|
xlink:href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip"
|
|
>http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip</link>).</para>
|
|
</formalpara>
|
|
<formalpara>
|
|
<title>Ubuntu 12.04</title>
|
|
<para>A packaged version enables you to use
|
|
<package>dpkg</package> or
|
|
<package>aptitude</package> to install
|
|
the
|
|
<package>python-novaclient</package>:<screen><prompt>#</prompt> <userinput>aptitude install python-novaclient</userinput></screen></para>
|
|
</formalpara>
|
|
<formalpara>
|
|
<title>Ubuntu</title>
|
|
<para><screen><prompt>#</prompt> <userinput>aptitude install python-pip</userinput></screen></para>
|
|
</formalpara>
|
|
<formalpara>
|
|
<title>RHEL, CentOS, or Fedora</title>
|
|
<para>A packaged version available in <link
|
|
xlink:href="http://openstack.redhat.com/"
|
|
>RDO</link> enables you to use
|
|
<package>yum</package> to install the
|
|
clients:
|
|
<screen><prompt>#</prompt> <userinput>yum install python-<replaceable>PROJECT</replaceable>client</userinput></screen></para>
|
|
</formalpara>
|
|
<para>Alternatively, install
|
|
<package>pip</package> and use it to
|
|
manage client installation:</para>
|
|
<screen><prompt>#</prompt> <userinput>yum install python-pip</userinput></screen>
|
|
<formalpara>
|
|
<title>openSUSE 12.2 and earlier</title>
|
|
<para>A <link
|
|
xlink:href="https://build.opensuse.org/package/show?package=python-novaclient&project=Cloud:OpenStack:Master"
|
|
>packaged version available in the
|
|
Open Build Service</link> enables you
|
|
to use <package>rpm</package> or
|
|
<package>zypper</package> to install
|
|
the
|
|
python-novaclient:<screen><prompt>#</prompt> <userinput>zypper install python-<replaceable>PROJECT</replaceable></userinput></screen></para>
|
|
</formalpara><para>Alternatively, install
|
|
<package>pip</package> and use it to
|
|
manage client installation:
|
|
<screen><prompt>#</prompt> <userinput>zypper install python-pip</userinput></screen></para>
|
|
<formalpara>
|
|
<title>openSUSE 12.3 and newer</title>
|
|
<para>A packaged version enables you to use
|
|
<package>rpm</package> or
|
|
<package>zypper</package> to install
|
|
the clients:
|
|
<screen><prompt>#</prompt> <userinput>zypper install python-<replaceable>PROJECT</replaceable>client</userinput></screen></para>
|
|
</formalpara>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<section xml:id="cli_clients_install">
|
|
<title>Install the clients</title>
|
|
<para>Use <package>pip</package> to install the OpenStack
|
|
clients on a Linux, Mac OS X or Microsoft Windows system. It is
|
|
easy and ensures that you get the latest version of the client
|
|
from the <link xlink:href="http://pypi.python.org/pypi">Python
|
|
Package Index</link>. Also, <package>pip</package>
|
|
lets you update or remove a package. After you install the
|
|
clients, you must source an <filename
|
|
xmlns:raxm="http://docs.rackspace.com/api/metadata"
|
|
>openrc.sh</filename> file to set required environment
|
|
variables before you can request OpenStack services
|
|
through the clients or the APIs.</para>
|
|
<procedure>
|
|
<step>
|
|
<para>Install each client separately using:</para>
|
|
<itemizedlist>
|
|
<listitem><para>For Mac OS X or Linux:</para>
|
|
<screen><prompt>#</prompt> <userinput>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>ceilometer</literal> - Telemetry API.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>cinder</literal> - Block Storage
|
|
API and extensions.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>glance</literal> - Image Service
|
|
API.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>heat</literal> - Orchestration
|
|
API.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>keystone</literal> - Identity
|
|
Service API and extensions.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>neutron</literal> - Networking
|
|
API.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>nova</literal> - Compute API and
|
|
extensions.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>swift</literal> - Object Storage
|
|
API.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>For example, to install the nova client, run
|
|
this command:</para>
|
|
<screen><prompt>#</prompt> <userinput>pip install python-novaclient</userinput></screen>
|
|
<para>To remove the nova client, run this
|
|
command:</para>
|
|
<screen><prompt>#</prompt> <userinput>pip uninstall python-novaclient</userinput></screen>
|
|
<note> <para>To upgrade a package, add the
|
|
<literal>--upgrade</literal> option to the
|
|
<command>pip</command> command.</para>
|
|
<para>For example, to update the <systemitem>nova</systemitem> client, run this
|
|
command:</para>
|
|
<screen><prompt>#</prompt> <userinput>pip install --upgrade python-novaclient</userinput></screen></note>
|
|
</step>
|
|
<step audience="enduser">
|
|
<para>Before you can run client commands, you must
|
|
create and source the <filename>openrc.sh</filename>
|
|
file to set environment variables. See <xref
|
|
linkend="cli_openrc"/>.</para>
|
|
</step>
|
|
</procedure>
|
|
</section>
|
|
</section>
|