• Native OpenStack API

  1. Help Center
  2. Native OpenStack API
  3. Developer Guide

Obtaining and Installing the Individual CLI Clients

Obtaining OpenStack Clients

Nova Client


Glance Client


Neutron Client


Cinder Client


Keystone Client


Heat Client


Installing OpenStack Clients

When installing OpenStack clients, ensure that the device where the client is to be installed can access the Internet.

Install Keystone Client, then Glance Client, and then Nova Client, Neutron Client, and Cinder Client. Nova Client, Neutron Client, and Cinder Client can be installed in any sequence.

This is because other clients rely on Keystone Client in the kilo version. The following uses ubuntu14.04 as an example to describe how to use the source code to install the Keystone Client.

  1. Log in to the system as user root.
  2. Run the following commands in any directories to update the system:

    apt-get update

    apt-get upgrade

  1. Run the following commands to install the mandatory components:

    apt-get install python-pip

    apt-get install git

    apt-get install python-dev

  1. On the GIT CLI, run the following command to download Keystone Client source code:

    git clone https://github.com/openstack/python-keystoneclient.git

    For addresses for downloading other client source codes, see Obtaining OpenStack Clients.

  1. Run the following commands to switch to the kilo version:

    cd python-keystoneclient

    git checkout -b kilo 1.2.0

  • kilo indicates the distribution name and can be customized.
  • 1.2.0 indicates the kilo version (Keystone client version) and cannot be changed.
  1. Run the following command to modify the requirements.txt file:

    vi requirements.txt

    Change >= in all versions starting with oslo of dependence libraries in the requirements.txt file to ==. This is because oslo libraries of a later version do not support Kilo clients.

    For Keystone Client, modify the configuration file as follows:

    • Change oslo.config>=1.6.0 to oslo.config==1.6.0.
    • Change oslo.i18n>=1.3.0 to oslo.i18n==1.3.0.
    • Change oslo.serialization>=1.2.0 to oslo.serialization==1.2.0.
    • Change oslo.utils>=1.2.0 to oslo.utils==1.2.0.
  2. Run the following command to install the client dependence library:

    pip install -r requirements.txt

  1. Run the following command to install Keystone Client:

    pip install .


In the preceding command, a dot (.) follows install.

  1. After installing the OpenStack client, run the following command on it to query the OpenStack client version:

    Service name --version

    For Keystone, run the following command:

    keystone --version

  2. Install Glance Client, Nova Client, Neutron Client, and Cinder Client, respectively. For details, see steps 4 to 9.