diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..76ce1f1 --- /dev/null +++ b/readme.md @@ -0,0 +1,128 @@ +# OpenECOMP AAI + +--- +--- + +# Introduction + +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. + +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. + +# Compiling AAI + +AAI can be compiled easily with a `mvn clean install -DskipTests`. Integration tests are started by omitting the skipTests flag `mvn clean install` + +The following profiles should be set up in the settings.xml file: + + <profile> + <id>nexus</id> + <repositories> + <repository> + <id>repository.jboss.org-public</id> + <name>JBoss.org Maven repository</name> + <url>https://repository.jboss.org/nexus/content/groups/public</url> + </repository> + <repository> + <id>global maven repo</id> + <url>http://repo1.maven.org/maven2/</url> + <releases> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + </snapshots> + </repository> + <repository> + <id>maven-restlet</id> + <name>Public online Restlet repository</name> + <url>http://maven.restlet.com</url> + </repository> + </repositories> + </profile> + + <profile> + <id>eelf</id> + <!-- Enable snapshots for the built in central repo to direct --> + <!-- all requests to nexus via the mirror --> + <repositories> + <repository> + <id>repo2</id> + <url>http://repo2.maven.org/maven2/com/att/eelf/</url> + <releases> + <enabled>true</enabled> + <!-- <updatePolicy>always</updatePolicy> <updatePolicy>never</updatePolicy> + <updatePolicy>daily</updatePolicy> + <updatePolicy>interval:in minutes</updatePolicy> --> + <updatePolicy>never</updatePolicy> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>always</updatePolicy> + <!-- <updatePolicy>always</updatePolicy> <updatePolicy>never</updatePolicy> + <updatePolicy>daily</updatePolicy> <updatePolicy>interval:30</updatePolicy> --> + </snapshots> + </repository> + </repositories> + <pluginRepositories> + <pluginRepository> + <id>repo2</id> + <url>http://repo2.maven.org/maven2/com/att/eelf/</url> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + </snapshots> + </pluginRepository> + </pluginRepositories> + </profile> + +in the profiles section and also specified as an activeProfile in the activeProfiles section. + + <activeProfiles> + <activeProfile>nexus</activeProfile> + <activeProfile>eelf</activeProfile> + </activeProfiles> + + +# 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/v8/cloud-infrastructure/pservers/pserver/<pserver-id> + +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/logs (each module has its own folder) + +AJSC Jetty logs can be found under /opt/app/aai/logs/ajsc-jetty. +The REST interface logs can be found under /opt/app/aai/logs/rest. + +# Testing AAI Functionalities +Any RESTful client such as SoapUI may be configured and setup to use for testing AAI requests. + + + |