Setting up Keystone¶

Prerequisites¶

This document assumes you are using an Ubuntu, Fedora, or openSUSE platform and that you have the following tools pre-installed on your system:

• python 3.6, as the programming language;

• git, as the version control tool;

Reminder: If you are successfully using a different platform, or a different version of the above, please document your configuration here!

Installing from source¶

The source install instructions specifically avoid using platform specific packages. Instead, we recommend using the source for the code and the Python Package Index (PyPi) for development environment installations..

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

Clone the keystone repository:

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

Install the keystone web service:

$ pip install -e .

Development environment¶

For setting up the Python development environment and running tox testing environments, please refer to the Project Team Guide: Python Project Guide, the OpenStack guide on wide standard practices around the use of Python.

That documentation will help you configure your development environment and run keystone tests using tox, which uses virtualenv to isolate the Python environment. After running it, notice the existence of a .tox directory.

Deploying configuration files¶

You should be able to run keystone after installing via pip. Additional configuration files are required. The following file is required in order to run keystone:

• keystone.conf

$ tox -e genconfig

Bootstrapping a test deployment¶

You can use the keystone-manage bootstrap command to pre-populate the database with necessary data.

Verifying keystone is set up¶

Once set up, you should be able to invoke Python and import the libraries:

$ .tox/py36/bin/python -c "import keystone"

If you can import keystone without a traceback, you should be ready to move on to the next sections.

You can run keystone using a host of wsgi implementations or web servers. The following uses uwsgi:

$ uwsgi --http 127.0.0.1:5000 --wsgi-file $(which keystone-wsgi-public)

This runs Keystone with the configuration the etc/ directory of the project. See API Configuration options for details on how Keystone is configured. By default, Keystone is configured with SQL backends.

Database setup¶

The script tools/test-setup.sh sets up databases as used by the unit tests.

Initializing Keystone¶

Before using keystone, it is necessary to create the database tables and ensures the database schemas are up to date, perform the following:

$ keystone-manage db_sync

If the above commands result in a KeyError, or they fail on a .pyc file with the message, You can only have one Python script per version, then it is possible that there are out-of-date compiled Python bytecode files in the Keystone directory tree that are causing problems. This can occur if you have previously installed and ran older versions of Keystone. These out-of-date files can be easily removed by running a command like the following from the Keystone root project directory:

$ find . -name "*.pyc" -delete

$ ADMIN_PASSWORD=s3cr3t tools/sample_data.sh

$ export OS_USERNAME=admin
$ export OS_PASSWORD=s3cr3t
$ export OS_PROJECT_NAME=admin
$ export OS_USER_DOMAIN_ID=default
$ export OS_PROJECT_DOMAIN_ID=default
$ export OS_IDENTITY_API_VERSION=3
$ export OS_AUTH_URL=http://localhost:5000/v3
$ openstack user list

$ pip install python-openstackclient

Interacting with Keystone¶

You can also interact with keystone through its REST API. There is a Python keystone client library python-keystoneclient which interacts exclusively through the REST API, and a command-line interface python-openstackclient command-line interface.