openstack
/
keystone
Code Issues Proposed changes

Removed old sections; improved syntax consistency 

Change-Id: Iff07ce0f0eac8f64fab30af92a82a1fdca5278de
This commit is contained in:
Dolph Mathews 2012-05-02 09:57:45 -05:00
parent d62a913f38
commit 4c842ca9bf
1 changed files with 5 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -15,6 +15,7 @@ for most deployments will actually be shims in front of existing user systems.
Development
-----------
Setting up a development environment
------------------------------------
@ -22,20 +23,22 @@ Please see the documentation under ``doc/source/`` for development setup
(``doc/source/setup.rst``) and configuration
(``doc/source/configuration.rst``).
Building the Documentation
--------------------------
The documentation is all generated with Sphinx from within the docs directory.
To generate the full set of HTML documentation:
To generate the full set of HTML documentation::
cd docs
make autodoc
make html
make man
the results are in the docs/build/html and docs/build/man directories
the results are in the ``docs/build/html`` and ``docs/build/man`` directories
respectively.
------------
The Services
------------
@ -81,7 +84,6 @@ The Policy service provides a rule-based authorization engine and the
associated rule management interface.
----------
Data Model
----------
@ -170,12 +172,6 @@ of checks and will possibly write completely custom backends. Backends included
in Keystone are:
Trivial True
------------
Allows all actions.
Simple Match
------------
@ -219,11 +215,3 @@ to which capabilities are allowed for that role. For example::
In the backend this would look up the policy for 'action:nova:add_network' and
then do what is effectively a 'Simple Match' style match against the creds.
-----------
Still To Do
-----------
* LDAP backend.
* Diablo migration.