Installing the OpenStack Command Line Client¶
This guide details how to install the OpenStack command line tool and project-specific modules. The client is currently available on most Linux distributions, Windows and MacOS. Every installation requires Python 2.7 or later.
Installing Pip¶
Ubuntu or Debian¶
# sudo apt install python-dev python-pip
Red Hat Enterprise Linux, CentOS, or Fedora¶
# sudo yum install python-devel python-pip
Microsoft Windows¶
c:\> easy_install pip
Note
Ensure that the C:\Python27\Scripts
directory is defined in the PATH
environment variable, and use the easy_install
command from the setuptools
package.
MacOS¶
# sudo easy_install pip
Installing the OpenStack client¶
Once python-pip
and other dependencies have been installed, we can use pip to install the OpenStack tools. Most tools that you will need to use will be in the default python-openstackclient
package, however you are also able to install individual project packages (legacy) using the second command (using Glance as an example).
# pip install python-openstackclient
# pip install python-glanceclient
We recommend using a Python virtual environment for installing any Python modules, as this keeps all the dependencies together in one place and separated from the system. You can find information about how to do this here.
Upgrading / Removing clients¶
In order to upgrade your pip packages, run the install
command with the --upgrade
flag.
# pip install --upgrade python-openstackclient
To remove the OpenStack client, run the uninstall
command.
# pip uninstall python-openstackclient
If you’d like to find out more about the OpenStack client, you can find more information here. We also have some documentation about setting up environment variables in order to authenticate with Keystone.
The next section of our documentation details managing the resources in your project, you can see more information about this below: