summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrian Lamar <brian.lamar@gmail.com>2011-05-24 11:53:06 -0400
committerBrian Lamar <brian.lamar@gmail.com>2011-05-24 11:53:06 -0400
commitada1c2137fbc976e87ed24214c6c5ea5df4494e6 (patch)
tree1aa23f9d7980ba41e52d7904bbb581b010adc45f
parent6fdc83234f821a3b893c92ab496e6170818fefd2 (diff)
Updates to README
-rw-r--r--README.md45
1 files changed, 32 insertions, 13 deletions
diff --git a/README.md b/README.md
index d290c106..ef8f4aa5 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,39 @@
Keystone: OpenStack Identity Service
====================================
-Keystone is a proposed independent authentication service for [OpenStack](http://www.openstack.org).
+Keystone is an open-source authentication service built to be integrated into [OpenStack](http://www.openstack.org).
+
+
+Core Concepts:
+--------------
+-Users
+-Tenants
+-Roles
+-Tokens
+-Groups
+-Authentication Protocol Plugins
+
+<table>
+ <tr>
+ <th>Concept</th><th>Description</th>
+ </tr>
+ <tr>
+ <td>User</td><td>A 'user' is a client who has been registered with Keystone.</td>
+ </tr>
+ <tr>
+ <td>Tenant</td><td>A 'tenant' describes an entity which houses multiple users. For example, a tenant might represent an 'account' or 'company' which contains an arbitrary number of users.</td>
+ </tr>
+</table>
+
+
+Built-In Services:
+------------------
+
+* bin/keystone - Provides HTTP API for users and administrators
+* bin/keystone-admin - Provides HTTP API for administrators
+* bin/keystone-service - Provides HTTP API for users
+* bin/keystone-manage - Provides command-line interface for managing all aspects of Keystone
-This initial proof of concept aims to address the current use cases in Swift and Nova which are:
-
-* REST-based, token auth for Swift
-* many-to-many relationship between identity and tenant for Nova.
-
-
-SERVICES:
----------
-
-* keystoned - Authentication service
-* AuthToken - WSGI middleware that can be used to handle token auth protocol (WSGI or remote proxy)
-* Echo - A sample service that responds by returning call details
Also included: