Install the OpenStack command-line clients

updated: 2019-08-23 18:47

Install the OpenStack command-line clients

Install the OpenStack command-line clients¶

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

Install the prerequisite software¶

Most Linux distributions include packaged versions of the command-line clients. You can directly install the clients from the packages with prerequisites. For more information, see Installing_from_packages.

If you need to install the source package for the command-line package, the following table lists the software needed to run the command-line clients, and provides installation instructions as needed.

OpenStack command-line clients prerequisites¶
Prerequisite	Description
Python 2.7 or later	Supports Python 2.7, 3.4, and 3.5.
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 Python Setuptools. The recommended way to install setuptools on Microsoft Windows is to follow the documentation provided on the Python Setuptools website. Another option is to use the unofficial binary installer maintained by Christoph Gohlke.
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. Since the installation process compiles source files, this requires the related Python development package for your operating system and distribution. 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. Ubuntu or Debian # apt install python-dev python-pip Note that extra dependencies may be required, per operating system, depending on the package being installed, such as is the case with Tempest. Red Hat Enterprise Linux or CentOS A packaged version enables you to use yum to install the package: # yum install python-devel python-pip On Red Hat Enterprise Linux, this command assumes that you have enabled the OpenStack repository. For more information, see the Installation Tutorial for Red Hat Enterprise Linux and CentOS. There are also packaged versions of the clients available that enable yum to install the clients as described in Installing_from_packages. Fedora A packaged version enables you to use dnf to install the package: # dnf install python-devel python-pip SUSE Linux Enterprise Server A packaged version available in the Open Build Service enables you to use YaST or zypper to install the package. First, add the Open Build Service repository as described in the Installation Tutorial. Then install pip and use it to manage client installation: # zypper install python-devel python-pip There are also packaged versions of the clients available that enable zypper to install the clients as described in Installing_from_packages. openSUSE You can install pip and use it to manage client installation: # zypper install python-devel python-pip There are also packaged versions of the clients available that enable zypper to install the clients as described in Installing_from_packages.

Install the OpenStack client¶

The following example shows the command for installing the OpenStack client with pip, which supports multiple services.

# pip install python-openstackclient

The following individual clients are deprecated in favor of a common client. Instead of installing and learning all these clients, we recommend installing and using the OpenStack client. You may need to install an individual project’s client because coverage is not yet sufficient in the OpenStack client. If you need to install an individual client’s project, replace the PROJECT name in this pip install command using the list below.

# pip install python-PROJECTclient

barbican - Key Manager Service API
ceilometer - Telemetry API
cinder - Block Storage API and extensions
cloudkitty - Rating service API
designate - DNS service API
fuel - Deployment service API
glance - Image service API
gnocchi - Telemetry API v3
heat - Orchestration API
magnum - Container Infrastructure Management service API
manila - Shared file systems API
mistral - Workflow service API
monasca - Monitoring API
murano - Application catalog API
neutron - Networking API
nova - Compute API and extensions
senlin - Clustering service API
swift - Object Storage API
trove - Database service API

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, openSUSE, SUSE Linux Enterprise, Debian, and Ubuntu have client packages that can be installed without pip.

Note

The packaged version might install older clients. If you want to make sure the latest clients are installed, you might need to install the clients with pip.

On Red Hat Enterprise Linux or CentOS, use yum to install the clients from the packaged versions:
```
# yum install python-PROJECTclient
```
This command assumes that you have enabled the OpenStack repository for your distribution. For more information, see the Installation Tutorial for Red Hat Enterprise Linux and CentOS.
For Ubuntu or Debian, use apt-get to install the clients from the packaged versions:
```
# apt-get install python-PROJECTclient
```
For openSUSE, use zypper to install the clients from the distribution packages service:
```
# zypper install python-PROJECTclient
```
For SUSE Linux Enterprise Server, use zypper to install the clients from the packaged versions:
```
# zypper install python-PROJECTclient
```
This command assumes that you have enabled the OpenStack repository for your distribution. For more information, see the Installation Tutorial for openSUSE and SUSE Linux Enterprise.

Upgrade or remove clients¶

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

# pip install --upgrade python-PROJECTclient

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

# pip uninstall python-PROJECTclient

What’s next¶

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

updated: 2019-08-23 18:47

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.