summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorsg481n <sg481n@att.com>2017-09-22 17:17:23 +0000
committersg481n <sg481n@att.com>2017-09-22 17:17:28 +0000
commitfaf7f2d997712433695d3324f91aa1b328e8ec93 (patch)
tree278fed8f751aaa349b13816194c898a5e868eb5b /docs/index.rst
parent70529ba6ff9206c26a6a4a4a3bae297f4474f182 (diff)
Adding rst files for the readthedocs documentation
created intital rst documents for the readthedocs documentation for aaf project. Issue-id: AAF-64 Change-Id: I4a7f259311b687a3cfe6fde1d068f0b1941bc6bb Signed-off-by: sg481n <sg481n@att.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..6f90b146
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,45 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+
+AAF - Application Authorization FrameworK
+==================================================
+.. The purpose of AAF (Application Authorization Framework) is to organize software authorizations so that applications, tools and services can match the access needed to perform job functions.
+
+AAF is designed to cover Fine-Grained Authorization, meaning that the Authorizations provided are able to used an Application's detailed authorizations, such as whether a user may be on a particular page, or has access to a particular Pub-SUB topic controlled within the App.
+
+This is a critical function for Cloud environments, as Services need to be able to be installed and running in a very short time, and should not be encumbered with local configurations of Users, Permissions and Passwords.
+
+To be effective during a computer transaction, Security must not only be secure, but very fast. Given that each transaction must be checked and validated for Authorization and Authentication, it is critical that all elements on this path perform optimally.
+
+
+
+.. toctree::
+ :maxdepth: 1
+
+
+Introduction
+------------
+AAF contains some elements of Role Based Authorization, but includes Attribute Based Authorization elements as well.
+
+.. image:: aaf-om.jpeg
+ :height: 600 px
+ :width: 800 px
+ :scale: 100 %
+ :alt: AAF highlevel Object Model
+ :align: center
+
+
+Essential Components
+--------------------
+The core component to deliver this Enterprise Access is a RESTful service, with runtime instances registered in a Cloud Directory (DME2) and backed by a resilient Datastore (Cassandra as of release 1.3)
+
+The Data is managed by RESTful API, with Admin functions supplemented by Character Based User interface and certain GUI elements.
+
+-The Service accessible by provided Caching Clients and by specialized plugins
+
+-CADI (A Framework for providing Enterprise Class Authentication and Authorization with minimal configuration to Containers and Standalone Services)
+
+-Cassandra (GRID Core)
+
+-Hadoop Plugin (a plugin via Hadoop Group Mapper mechanism)