Update the pom file for javadocs

Change-Id: I8342945f0266c51c6c2673c8919eb6f59c0b8e19
Signed-off-by: Venkata Harish K Kajur <vk250x@att.com>

1 files changed, 53 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..a705eff
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,53 @@
+# OpenECOMP AAI Traversal
+
+---
+---
+
+# Introduction
+
+OpenECOMP AAI Traversal is delivered with multiple docker containers with hbase, and gremlin docker container preinstalled and also have a aai-haproxy container installed for routing requests properly between resources and graph query docker containers
+
+For demo app use case you can install all three of the containers in one machine. Configuration and deployment of hbase for any other use cases should be evaluated and updated accordingly.
+
+# Compiling AAI Traversal
+
+AAI can be compiled easily with a `mvn clean install -DskipTests`. Integration tests are started by omitting the skipTests flag `mvn clean install`
+
+# Starting AAI
+
+In a developer local environment using the following: mvn -N -P runAjsc
+
+# Accessing AAI APIs
+
+Most of the AAI features within OpenECOMP are triggered by using **RESTful interfaces**. AAI  is configured on this release with HTTPS only using Basic Authentication. Two way SSL using client certificates should be considered and used for non demo use case deployments.
+
+The MSO APIs are configured to accept requests having a **basic auth. header** set with various **username and password** depending on which client is triggering the request. The realm.properties contains the credentials for the OpenECOMP components and these should be changed as appropriate.
+
+All API endpoints are exposed on port **8443**.
+
+##### Example API endpoints in the first open source release 
+
+http://aai.api.simpledemo.openecomp.org:8443/aai/v10/query
+
+The easy way to trigger these endpoints is to use a RESTful client or automation framework. HTTP GET/PUT/DELETE are supported for most resource endpoints. More information on the REST interface can be found in the AAI Service REST API specification.
+
+# Configuring AAI
+
+The Docker containers use a Chef based configuration file (JSON) in order to provision AAI basic configuration for the demo app use case set up. 
+ 
+# Logging
+
+EELF framework is used for **specific logs** (audit, metric and error logs). They are tracking inter component logs (request and response) and allow to follow a complete flow through the AAI subsystem
+ 
+EELF logs are located at the following location on the AAI Service container:
+
+- /opt/app/aai-traversal/logs (each module has its own folder)
+
+AJSC Jetty logs can be found under /opt/app/aai-traversal/logs/ajsc-jetty.
+The REST interface logs can be found under /opt/app/aai-traversal/logs/rest.
+
+# Testing AAI Functionalities
+Any RESTful client such as SoapUI may be configured and setup to use for testing AAI requests.
+
+
+