README.md

   1 # OpenECOMP AAI Traversal
   2
   3 ## Introduction
   4 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
   5
   6 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.
   7
   8 ## Development
   9 ### Compile
  10
  11 AAI can be compiled with
  12 ``` bash
  13 mvn clean install -DskipTests
  14 ```
  15 ### Test
  16 ``` bash
  17 mvn test
  18 ```
  19 Run individual tests
  20 ```
  21 mvn test -Dtest=EchoResponseTest#testEchoResultWhenValidHeaders
  22 ```
  23
  24 ### Run
  25 Run the project with
  26 ``` bash
  27 mvn -N -P runAjsc
  28 ```
  29 Make sure to be in `aai-traversal` before executing it!
  30
  31 ## Accessing AAI APIs
  32 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.
  33
  34 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.
  35
  36 All API endpoints are exposed on port **8443**.
  37
  38 ##### Example API endpoints in the first open source release
  39 http://aai.api.simpledemo.openecomp.org:8443/aai/v10/query
  40
  41 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.
  42
  43 ## Configuring AAI
  44 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.
  45
  46 ## Logging
  47 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
  48
  49 EELF logs are located at the following location on the AAI Service container:
  50
  51 - `/opt/app/aai-traversal/logs` (each module has its own folder)
  52
  53 AJSC Jetty logs can be found under /opt/app/aai-traversal/logs/ajsc-jetty.
  54 The REST interface logs can be found under /opt/app/aai-traversal/logs/rest.
  55
  56 ## Testing AAI Functionalities
  57 Any RESTful client such as SoapUI may be configured and setup to use for testing AAI requests.
  58
  59 ## Integration Tests
  60 Integration tests are located in `it` directory, and disabled by default in the pom file:
  61 `<skipITs>true</skipITs>`
  62
  63 As a naming convention, All integration test classes should end with `IT`, and will be executed by changing the `skipITs` value in pom file, or through the command line `-DskipITs=false`
  64