fix CRITICAL xxe (XML External Entity) issues identified in sonarcloud

[aai/model-loader.git] / Readme.md

diff --git a/Readme.md b/Readme.md
index 5456fc9..3d7aaae 100644 (file)
--- 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 and VNF catalogs from the SDC to the A&AI.
 
 ## Features
 
@@ -12,6 +12,17 @@ The Model Loader:
 * downloads artifacts from SDC upon receipt of a distribution event
 * pushes distribution components to A&AI
                    
+### VNF Catalog loading
+
+The Model Loader supports two methods for supplying VNF Catalog data for loading into A&AI:
+
+* Embedded TOSCA image and vendor data<br/>VNF Catalog data can be embedded within the TOSCA yaml files contained in the CSAR.
+
+
+* VNF Catalog XML files<br/>VNF Catalog data in the form of XML files can be supplied in the CSAR under the path `Artifacts/Deployment/VNF_CATALOG`
+
+**Note: Each CSAR should provide VNF Catalog information using only one of the above methods. If a CSAR contains both TOSCA and XML VNF Catalog information, a deploy failure will be logged and published to SDC, and no VNF Catalog data will be loaded into A&AI** 
+                   
 ## Compiling Model Loader
 
 Model Loader can be compiled by running `mvn clean install`
@@ -19,8 +30,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:**
@@ -38,6 +47,7 @@ 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_  
+
     # Always false.  TLS Auth currently not supported 
     ml.distribution.ACTIVE_SERVER_TLS_AUTH=false
     
@@ -73,7 +83,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 +128,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 +137,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,
+where
 
-    {{your docker repo}} = The Docker repository you have published your image to.
+    {{your docker repo}}
+is the Docker repository you have published your image to.