summaryrefslogtreecommitdiffstats
path: root/doc/source
diff options
context:
space:
mode:
authorJames Slagle <james.slagle@gmail.com>2013-04-03 17:59:56 -0400
committerJames Slagle <james.slagle@gmail.com>2013-04-23 19:48:51 -0400
commit4112353f85ff0e4e8b62207000b6c94b00e14706 (patch)
treed6cd42348dd2d18d5bd38e3dbeeb381cd4fd0c9f /doc/source
parenteefc8e047392c80388391a5d1ae815e93df10849 (diff)
downloadkeystone-4112353f85ff0e4e8b62207000b6c94b00e14706.tar.gz
keystone-4112353f85ff0e4e8b62207000b6c94b00e14706.tar.xz
keystone-4112353f85ff0e4e8b62207000b6c94b00e14706.zip
Documentation about the initial configuration file and sample data.
The initial configuration file and sample data are both are helpful in getting setup with a keystone development environment. Change-Id: Ic100177abe8dda1510a183463e61e0b757986e97
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/developing.rst32
1 files changed, 30 insertions, 2 deletions
diff --git a/doc/source/developing.rst b/doc/source/developing.rst
index e1cb5767..e6c01883 100644
--- a/doc/source/developing.rst
+++ b/doc/source/developing.rst
@@ -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
=============