Install the OpenStack command-line clientsInstall the prerequisite software and the Python package for
each OpenStack client.Install the prerequisite softwareMost Linux distributions include packaged versions of the
command-line clients that you can install directly, see .
If you need to install the command-line packages source
packages, the following table lists the software that you
need to have to run the command-line clients, and provides
installation instructions as needed.
Prerequisite software
Prerequisite
Description
Python 2.6 or later
Currently, the clients do not support Python
3.
setuptools package
Installed by default on Mac OS X.Many Linux distributions provide packages to make
setuptools easy to install. Search
your package manager for setuptools
to find an installation package. If you cannot find
one, download the setuptools package
directly from http://pypi.python.org/pypi/setuptools.The recommended way to install
setuptools on Microsoft Windows is
to follow the documentation provided on the setuptools website. Another option is
to use the unofficial binary installer maintained by
Christoph Gohlke (http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools).
pip package
To install the clients on a Linux, Mac OS X,
or Microsoft Windows system, use
pip. It is easy to
use, ensures that you get the latest
version of the clients from the Python Package Index, and lets
you update or remove the packages later
on.Install pip through the
package manager for your system:MacOS#easy_install pipMicrosoft WindowsEnsure that the
C:\Python27\Scripts
directory is defined in the
PATH environment
variable, and use the
easy_install
command from the
setuptools
package:
C:\>easy_install pipAnother
option is to use the unofficial binary
installer provided by Christoph Gohlke
(http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip).Ubuntu and Debian#apt-get install python-pipRed Hat Enterprise Linux, CentOS, or FedoraA packaged version enables you to use yum
to install the package:
#yum install python-pip
There are also packaged versions of the
clients available in RDO
that enable yum to
install the clients as described in .
SUSE Linux Enterprise Linux 11A packaged
version available in the Open Build
Service enables you to use
or zypper to install the package.
First, add the Open Build Service repository:
#zypper addrepo -f obs://Cloud:OpenStack:Icehouse/SLE_11_SP3 Icehouse
Then install pip and use it to manage client installation:
#zypper install python-pip
There are also packaged versions of the clients available
that enable zypper to install the
clients as described in .
openSUSEYou can install
pip and use it to
manage client installation:
#zypper install python-pip
There are also packaged versions of the clients available
that enable zypper to install the
clients as described in
Install the clientsWhen following the instructions in this section, replace
PROJECT with the lowercase
name of the client to install, such as
nova. Repeat for each client. The
following values are valid:ceilometer - Telemetry
APIcinder - Block Storage API
and extensionsglance - Image Service
APIheat - Orchestration
APIkeystone - Identity service
API and extensionsneutron - Networking
APInova - Compute API and
extensionsswift - Object Storage
APItrove - Database Service
APIThe following example shows the command for installing
the nova client with
pip.#pip install python-novaclientInstalling with pipUse pip to install the OpenStack
clients on a Linux, Mac OS X, or Microsoft Windows
system. It is easy to use and ensures that you get the
latest version of the client from the Python
Package Index. Also, pip
enables you to update or remove a package.Install each client separately by using the
following command:For Mac OS X or Linux:#pip install python-PROJECTclientFor Microsoft Windows:C:\>pip install python-PROJECTclientInstalling from packagesRDO, openSUSE and SUSE Linux Enterprise have client packages that can be
installed without pip.On Red Hat Enterprise Linux, CentOS, or Fedora, use
yum to install the clients from
the packaged versions available in RDO:
#yum install python-PROJECTclientFor openSUSE, use zypper to install the clients
from the distribution packages
Service:
#zypper install python-PROJECTFor SUSE Linux Enterprise Server, use
zypper to install the clients from
the distribution packages in the Open Build Service. First,
add the Open Build Service repository:
#zypper addrepo -f obs://Cloud:OpenStack:Icehouse/SLE_11_SP3 Icehouse
Then you can install the packages:
#zypper install python-PROJECTUpgrade or remove clientsTo upgrade a client, add the
--upgrade option to the
pip install command:#pip install --upgrade python-PROJECTclientTo remove the a client, run the pip
uninstall command:#pip uninstall python-PROJECTclientWhat's nextBefore you can run client commands, you must create
and source the
PROJECT-openrc.sh
file to set environment variables. See .