openstack/keystone
Code Issues Proposed changes
90f2f96e69
keystone/doc/source/installing.rst
Gage Hugo b9c8963d0a Fixed multiple warnings in tox -edocs 
There are multiple tracebacks and warnings being thrown whenever
the keystone docs are built due to documents being moved/deleted as
well as formatting issues in a couple places.

This fixes a few of the warnings due to broken links and fixes a few
of the method docs.

Master: http://paste.openstack.org/show/591730/
This Patch: http://paste.openstack.org/show/591735/

Change-Id: I11cbbc7a10fa24dcbf67c76e3061a39a58529c06
Partial-Bug: #1602422
2016-12-07 16:26:53 -06:00

4.2 KiB
Raw Blame History

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 devref/development_best_practices and devref/development.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 configuration 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 configuration.

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

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