2. Install the OpenStack command-line clients

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

2.1. 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 2.2. Prerequisite software

Prerequisite Description

Prerequisite	Description
Python 2.6 or later	Currently, the clients do not support Python 3.
setuptools package	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.
pip package	To install the clients on Red Hat Enterprise Linux. 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: Red Hat Enterprise Linux. A packaged version 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`

Python 2.6 or later

Currently, the clients do not support Python 3.

setuptools package

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.

pip package

To install the clients on Red Hat Enterprise Linux. 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:

Red Hat Enterprise Linux. A packaged version 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

2.2. 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

2.2.1. Installing with pip

Use pip to install the OpenStack clients on Red Hat Enterprise Linux. 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 Red Hat Enterprise Linux:
```
# pip install python-PROJECTclient
```

2.2.2. Installing from packages

On Red Hat Enterprise Linux, use yum to install the clients from the packaged versions:

# yum install python-PROJECTclient

2.3. 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

2.4. What's next

Before you can run client commands, you must create and source the PROJECT-openrc.sh file to set environment variables. See Section 4, “Set environment variables using the OpenStack RC file”.