Merge "Documentation about the initial configuration file and sample data."

This commit is contained in:
Jenkins 2013-05-21 18:09:03 +00:00 committed by Gerrit Code Review
commit 0a5cf439a0
1 changed files with 30 additions and 2 deletions

View File

@ -43,6 +43,18 @@ virtualenv. If you chose not to, simply exclude "tools/with_venv.sh" from the
example commands below.
Configuring Keystone
--------------------
keystone requires a configuration file. There is a sample configuration file
that can be used to get started::
$ cp etc/keystone.conf.sample etc/keystone.conf
The defaults are enough to get you going, but you can make any changes if
needed.
Running Keystone
----------------
@ -60,8 +72,7 @@ Interacting with Keystone
-------------------------
You can interact with Keystone through the command line using
keystonemanage_ which allows you to establish tenants, users, etc.
keystonemanage_ which allows you to initialize keystone, etc.
You can also interact with Keystone through its REST API. There is a python
keystone client library `python-keystoneclient`_ which interacts exclusively
@ -76,6 +87,23 @@ place::
.. _`python-keystoneclient`: https://github.com/openstack/python-keystoneclient
Initial Sample Data
-------------------
There is an included script which is helpful in setting up some initial sample
data for use with keystone::
$ SERVICE_TOKEN=ADMIN tools/with_venv.sh tools/sample_data.sh
Notice it requires a service token read from an environment variable for
authentication. The default value "ADMIN" is from the ``admin_token``
option in the ``[DEFAULT]`` section in ``etc/keystone.conf``.
Once run, you can see the sample data that has been created by using the
`python-keystoneclient`_ command-line interface::
$ tools/with_venv.sh keystone --token ADMIN --endpoint http://127.0.0.1:35357/v2.0/ user-list
Running Tests
=============