Atom feed of this document
  
 

 Install the OpenStack command-line clients

Install the prerequisite software and the Python package for each OpenStack client.

 Install the prerequisite software

The following table lists the software that you need to have to run the command-line clients, and provides installation instructions as needed.

Table 4.2. 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 pip

Microsoft Windows. Ensure 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 pip

Another option is to use the unofficial binary installer provided by Christoph Gohlke (http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip).

Ubuntu 12.04/14.04. A packaged version enables you to use dpkg or aptitude to install the python-novaclient:

# aptitude install python-novaclient 

Ubuntu and Debian. 

# aptitude install python-pip

Red Hat Enterprise Linux, CentOS, or Fedora. A packaged version available in RDO enables you to use yum to install the clients, or you can install pip and use it to manage client installation:

# yum install python-pip

openSUSE 12.2 and earlier. A packaged version available in the Open Build Service enables you to use rpm or zypper to install the clients, or you can install pip and use it to manage client installation:

# zypper install python-pip

openSUSE 12.3 and later. A packaged version enables you to use rpm or zypper to install the clients. See the section called “Install the clients”

 Install the clients

When 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 API

  • cinder - Block Storage API and extensions

  • glance - Image Service API

  • heat - Orchestration API

  • keystone - Identity service API and extensions

  • neutron - Networking API

  • nova - Compute API and extensions

  • swift - Object Storage API

  • trove - Database Service API

The following example shows the command for installing the nova client with pip.

# pip install python-novaclient

 Installing with pip

Use 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-PROJECTclient
  • For Microsoft Windows:

    C:\>pip install python-PROJECTclient

 Installing from packages

RDO and openSUSE 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-PROJECTclient

For openSUSE, use rpm or zypper to install the clients from the packaged versions available in the Open Build Service:

# zypper install python-PROJECT

 Upgrade or remove clients

To upgrade a client, add the --upgrade option to the pip install command:

# pip install --upgrade python-PROJECTclient

To remove the a client, run the pip uninstall command:

# pip uninstall python-PROJECTclient
Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page

loading table of contents...