summaryrefslogtreecommitdiffstats
path: root/Readme.md
diff options
context:
space:
mode:
authormark.j.leonard <mark.j.leonard@gmail.com>2018-06-06 14:47:42 +0100
committermark.j.leonard <mark.j.leonard@gmail.com>2018-06-06 15:37:53 +0100
commitc5aea4a8bc398fc1c6220875e55b9520fd7f7524 (patch)
treeb0aeef15bed28487c5827990d60fc3bdcf95b67e /Readme.md
parentce332032dd208c5c769a2297409d8aca3f780fa8 (diff)
Refactor for Sonar smells and code coverage
Various code formatting and style fixes (to address Sonar code smells). Introduce a BabelServiceClientException to replace the use of the base Exception class. Make both the BabelServiceClient class and its Factory class use an interface, to allow for Spring injection (using annotations) and for simplified mocking. Refactor the Notification Publishing by making this the responsibility of the main Service classes and not the deployment manager. Issue-ID: AAI-1207 Change-Id: I6bf8a504fa7b98e9158c9976fd1d88c6c54027c1 Signed-off-by: mark.j.leonard <mark.j.leonard@gmail.com>
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/Readme.md b/Readme.md
index 5456fc9..d8f1f02 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,7 +1,7 @@
# Introduction
-The A&AI Model Loader Service is an application that facilitates
-distribution and ingestion of new service and resource models from SDC to A&AI.
+The A&AI Model Loader Service is an application that facilitates the distribution and ingestion of
+new service and resource models from the SDC to the A&AI.
## Features
@@ -11,7 +11,7 @@ The Model Loader:
* polls the UEB/DMaap cluster for notification events
* downloads artifacts from SDC upon receipt of a distribution event
* pushes distribution components to A&AI
-
+
## Compiling Model Loader
Model Loader can be compiled by running `mvn clean install`
@@ -19,8 +19,6 @@ A Model Loader docker image can be created by running `docker build -t onap/mode
## Running Model Loader
-### Deploying The MicroService
-
Push the Docker image to your Docker repository. Pull this down to the host machine.
**Create the following directories on the host machine:**
@@ -37,7 +35,8 @@ You will be mounting these as data volumes when you start the Docker container.
The following file must be present in this directory on the host machine:
-_model-loader.properties_
+_model-loader.properties_
+
# Always false. TLS Auth currently not supported
ml.distribution.ACTIVE_SERVER_TLS_AUTH=false
@@ -73,7 +72,7 @@ _model-loader.properties_
ml.distribution.USER=<username>
# Artifact type we want to download from the SDC (the values below will typically suffice)
- ml.distribution.ARTIFACT_TYPES=MMODEL_QUERY_SPEC,TOSCA_CSAR
+ ml.distribution.ARTIFACT_TYPES=MODEL_QUERY_SPEC,TOSCA_CSAR
# List of message bus addresses on which to listen for distribution events
ml.distribution.MSG_BUS_ADDRESSES=<host1>,<host2>
@@ -118,7 +117,7 @@ The certificate used to connected to the A&AI
**Start the service:**
-You can now start the Docker container for the _Search Data Service_, in the following manner:
+You can now start the Docker container for the _Model Loader Service_, e.g:
docker run -d \
-e CONFIG_HOME=/opt/app/model-loader/config/ \
@@ -127,6 +126,7 @@ You can now start the Docker container for the _Search Data Service_, in the fol
--name model-loader \
{{your docker repo}}/model-loader
-Where,
-
- {{your docker repo}} = The Docker repository you have published your image to.
+where
+
+ {{your docker repo}}
+is the Docker repository you have published your image to.