Installing Keystone

Installing Keystone

This document describes how to install Keystone in order to use it. If you are intending to develop on or with Keystone, please read Contributor Documentation and Setting up the Environment.

Installing from Source

The source install instructions specifically avoid using platform specific packages, instead using the source for the code and the Python Package Index (PyPi).

It’s expected that your system already has python, pip, and git available.

Clone the Keystone repository:

$ git clone https://git.openstack.org/openstack/keystone.git
$ cd keystone

Install the Keystone web service:

$ pip install .

Note

This step is guaranteed to fail if you do not have the proper binary dependencies already installed on your development system. Maintaining a list of platform-specific dependencies is outside the scope of this documentation, but is within scope of DEVSTACK.

You should have all the pieces you need to run Keystone installed on your system. The following commands should be available on the command-line path:

  • keystone the Keystone client, used to interact with Keystone
  • keystone-manage used to bootstrap Keystone data

You will find sample configuration files in etc/:

  • keystone.conf
  • keystone-paste.ini
  • logging.conf
  • policy.json
  • default_catalog.templates

From here, refer to Configuring Keystone to choose which backend drivers to enable and use. Once configured, you should be able to run Keystone by issuing the command:

$ uwsgi --http 127.0.0.1:35357 --wsgi-file $(which keystone-wsgi-admin)

By default, this will show logging on the console from which it was started. Once started, you can initialize data in Keystone for use with the rest of OpenStack, as described in Configuring Keystone.

An excellent reference implementation of setting up Keystone is DEVSTACK, most commonly used for development and testing setup of not only Keystone, but all of the core OpenStack projects.

The script with the latest examples of initializing data in Keystone is a bash script called lib/keystone

Installing from packages: Ubuntu

To install keystone on Ubuntu:

$ sudo apt-get install keystone

In using Ubuntu’s packages, the packages will set up a user account for the Keystone service (keystone), and place default configurations in /etc/keystone. As of this writing, the defaults for Keystone backends are all SQL based, stored locally in SQLite.

Once installed, you still need to initialize data in Keystone, which you can find described in Configuring Keystone.

Installing from packages: Fedora

To install Keystone on Fedora refer to the steps found in the OpenStack Install Guide.

To install the packages:

$ sudo yum install openstack-keystone

Once installed, you still need to initialize data in Keystone, which you can find described in Configuring Keystone.

Creative Commons Attribution 3.0 License

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