readme.md

   1 # OpenECOMP AAI
   2
   3 ---
   4 ---
   5
   6 # Introduction
   7
   8 OpenECOMP AAI is delivered with **3 Docker containers**, 1 hosting the **database** (Hbase), 1 hosting the AAI Model Loader micro-service  and 1 hosting the AAI Service. This readme only covers the AAI Service and not the AAI Model Loader.
   9
  10 For demo app use case the three containers run on the same VM. Configuration and deployment of hbase for any other use cases should be evaluated and updated accordingly.
  11
  12 # Compiling AAI
  13
  14 AAI can be compiled easily with a `mvn clean install -DskipTests`. Integration tests are started by omitting the skipTests flag `mvn clean install`
  15
  16 # Starting AAI
  17
  18 In a developer local environment using the following: mvn -N -P runAjsc
  19
  20 # Accessing AAI APIs
  21
  22 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.
  23
  24 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.
  25
  26 All API endpoints are exposed on port **8443**.
  27
  28 ##### Example API endpoints in the first open source release
  29
  30 http://aai.api.simpledemo.openecomp.org:8443/v8/cloud-infrastructure/pservers/pserver/<pserver-id>
  31
  32 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.
  33
  34 # Configuring AAI
  35
  36 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.
  37
  38 # Logging
  39
  40 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
  41
  42 EELF logs are located at the following location on the AAI Service container:
  43
  44 - /opt/app/aai/logs (each module has its own folder)
  45
  46 AJSC Jetty logs can be found under /opt/app/aai/logs/ajsc-jetty.
  47 The REST interface logs can be found under /opt/app/aai/logs/rest.
  48
  49 # Testing AAI Functionalities
  50 Any RESTful client such as SoapUI may be configured and setup to use for testing AAI requests.
  51
  52
  53