summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorSai Krishna <saikrishna1511@gmail.com>2011-05-12 16:34:38 +0530
committerSai Krishna <saikrishna1511@gmail.com>2011-05-12 16:34:38 +0530
commite199cb4541a70709d94deab86657bbde487037e6 (patch)
treeffb455d72fc9b8ca072851b8e57806c1060993b7 /README
parentc98c32d0f1ee4d6f2fd13fad37e9abd0e8801362 (diff)
parenta0c43a05126d9cca83b58b788fbc8e24f004fb66 (diff)
downloadkeystone-e199cb4541a70709d94deab86657bbde487037e6.tar.gz
keystone-e199cb4541a70709d94deab86657bbde487037e6.tar.xz
keystone-e199cb4541a70709d94deab86657bbde487037e6.zip
Merge branch 'master' of https://git.hcleai.com/keystone
Conflicts: README
Diffstat (limited to 'README')
-rw-r--r--README100
1 files changed, 51 insertions, 49 deletions
diff --git a/README b/README
index ca31d5d6..35b27cc1 100644
--- a/README
+++ b/README
@@ -1,3 +1,4 @@
+
Keystone: Identity Service
==========================
@@ -60,13 +61,55 @@ Or using pip:
RUNNING KEYSTONE:
-----------------
+<<<<<<< HEAD
+From the topdir
+=======
+During development, you can simply run
+
+ $ bin/keystone-auth
+
+It dumps stdout and stderr onto the terminal.
+
+
+RUNNING KEYSOTNE IN AS ROOT IN PRODUCTION
+---------------------------------------------
+In production, stdout and stderr need to be closed and all theoutput needs tobe redirected to a log file.
+Once the package is installed through setup tools, RPM, deb, or ebuild keystone-control is installed
+as /usr/sbin/keystone-control. Typically, it will be started a script in /etc/init.d/keystoned
+
+keystone-control can invoke keystone-auth and start the keystone daemon with
+
+ $ /usr/sbin/keystone-control auth start
+
+It writes the process id of the daemon into /var/run/keystone/keystine-auth.pid. he daemon can be stopped with
+
+ $ /usr/sbin/keystone-control auth stop
+
+keystone-control has the infrastructure to start and stop multiple servers keystone-xxx
+
+
+DEVELOPMENT OF keystone-control
+-------------------------------
+
+During the development of keystone-control can be started as a user instead of root
+
From the topdir
+>>>>>>> a0c43a05126d9cca83b58b788fbc8e24f004fb66
+
+ $ bin/keystone-control --pid-file pidfile auth <start|stop|restart>
- $ bin/keystone-control --config-file etc/keystone.conf --pid-file=pidfile auth <start|stop|restart>
+config.py takes the config file from topdir/etc/keystone.conf
-The "start" command invokes bin/keystone-auth. During development you can also run
+If the keystone package is also intalled on the system
+/etc/keystone.conf or /etc/keystone/keystone.conf has higher priority
+than <top_dir>/etc/keystone.conf. If you are also doing development on a
+system that has keystone.conf installed in /etc/you need to disambiguate it by
- $ bin/keystone-auth etc/keystone.conf
+ $ bin/keystone-control --confg-file etc/keystone.conf --pid-file pidfile auth <start|stop|restart>
+
+Also, keystone-control calls keystone-auth and it need to be in the PATH
+
+ $ export PATH=<top_dir>/bin:$PATH
@@ -90,7 +133,6 @@ DEMO CLIENT:
$ cd echo/echo
$ python echo_client.py
-
INSTALLING KEYSTONE:
--------------------
@@ -98,11 +140,6 @@ INSTALLING KEYSTONE:
$ sudo python setup.py install
-RUNNING KEYSTONE (Eventlet Server):
------------------------------------
- sudo keystone (start|stop|restart)
-
-
INSTALLING TEST SERVICE:
------------------------
@@ -124,16 +161,11 @@ To clean the test database
$ sqlite3 keystone/keystone.db < test/kill.sql
-To run unit tests:
-
- $ python test/unit/test_identity.py
-
To run client demo (with all auth middleware running locally on sample service):
$ python echo/echo/echo.py
$ python echo/echo/echo_client.py
-
To perform contract validation and load testing, use SoapUI (for now).
Using SOAPUI:
@@ -152,45 +184,15 @@ Unit Test on Identity Services
In order to run the unit test on identity services start the auth sever
$ cd test/unit
- $ ../../bin/keystone-control --config-file ../..etc/keystone.conf --pid-file=pidfile auth start
-
-Once the Identity service is running, go to unit test/unit directory
-
- $ python test_identity.py
-
-You can run a sbuset of tests the following way
- $ grep class test_identity.py
-
-You get something like
-
-
-class identity_test(unittest.TestCase):
-class authorize_test(identity_test):
-class validate_token(authorize_test):
-class tenant_test(unittest.TestCase):
-class create_tenant_test(tenant_test):
-class get_tenants_test(tenant_test):
-class get_tenant_test(tenant_test):
-class update_tenant_test(tenant_test):
-class delete_tenant_test(tenant_test):
-class tenant_group_test(unittest.TestCase):
-class create_tenant_group_test(tenant_group_test):
-class get_tenant_groups_test(tenant_group_test):
-class get_tenant_group_test(tenant_group_test):
-class update_tenant_group_test(tenant_group_test):
-class delete_tenant_group_test(tenant_test):
-class global_group_test(unittest.TestCase):
-class create_global_group_test(global_group_test):
-class create_tenant_group_test(tenant_group_test):
-
-You can choose any class you like to test
+ $ ../../bin/keystone-auth
- $ python test_identity.py delete_tenant_test
+There are 8 groups of tests. They can be run individually or as an entire colection. To run the entire test suite run
-For more on unit testing please refer
+ $ python test_keystone
- $ python test_identity --help
+A test can also be run individually e.g.
+ $ python test_token
DATABASE SCHEMA