X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=Readme.md;h=5aa173339676a36acfe134d9093c130a4ded1bdb;hb=126843b5dbc7987fca4f03ea5c85f683474a0a53;hp=0d5e4e992cbb1b2ad80c3c5bc26fd702266ce4a0;hpb=7b1f813441f94261f43ec4f5bb0944ad2570fbdf;p=aai%2Fmodel-loader.git
diff --git a/Readme.md b/Readme.md
index 0d5e4e9..5aa1733 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,8 +1,7 @@
# Introduction
-The A&AI Model Loader Service is an application that facilitates
-distribution, ingestion of new service and resource models, and vnf
-catalogs from the SDC to the 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
@@ -13,16 +12,25 @@ 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
VNF Catalog data can be embedded within the TOSCA yaml files contained in the CSAR.
+
+
+* VNF Catalog XML files
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`
-A Model Loader docker image can be created by running `docker build -t openecomp/model-loader target`
+A Model Loader docker image can be created by running `docker build -t onap/model-loader target`
## Running Model Loader
-### Deploying The Micro Service
-
-Push the Docker image that you have built to your Docker repository and pull it down to the location that you will be running the search service from.
+Push the Docker image to your Docker repository. Pull this down to the host machine.
**Create the following directories on the host machine:**
@@ -39,16 +47,17 @@ 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
# Address/port of the SDC
ml.distribution.ASDC_ADDRESS=:8443
- # DMaaP consumer group.
+ # Kafka consumer group.
ml.distribution.CONSUMER_GROUP=aai-ml-group
- # DMaaP consumer ID
+ # Kafka consumer ID
ml.distribution.CONSUMER_ID=aai-ml
# SDC Environment Name. This must match the environment name configured on the SDC
@@ -64,20 +73,17 @@ _model-loader.properties_
# obfuscate the cleartext password: http://www.eclipse.org/jetty/documentation/9.4.x/configuring-security-secure-passwords.html
ml.distribution.PASSWORD=OBF:
- # How often (in seconds) to poll the DMaaP cluster for new model events
+ # How often (in seconds) to poll the Kafka topic for new model events
ml.distribution.POLLING_INTERVAL=
- # Timeout value (in seconds) when polling DMaaP for new model events
+ # Timeout value (in seconds) when polling the Kafka topic for new model events
ml.distribution.POLLING_TIMEOUT=
# Username to use when connecting to the SDC
ml.distribution.USER=
# Artifact type we want to download from the SDC (the values below will typically suffice)
- ml.distribution.ARTIFACT_TYPES=MODEL_INVENTORY_PROFILE,MODEL_QUERY_SPEC,VNF_CATALOG
-
- # List of message bus addresses on which to listen for distribution events
- ml.distribution.MSG_BUS_ADDRESSES=,
+ ml.distribution.ARTIFACT_TYPES=MODEL_QUERY_SPEC,TOSCA_CSAR
# URL of the A&AI
ml.aai.BASE_URL=https://:8443
@@ -89,7 +95,7 @@ _model-loader.properties_
ml.aai.NAMED_QUERY_URL=/aai/v*/service-design-and-creation/named-queries/named-query/
# A&AI endpoint to post vnf images
- ml.aai.VNF_IMAGE_URL=/aai/v8/service-design-and-creation/vnf-images
+ ml.aai.VNF_IMAGE_URL=/aai/v*/service-design-and-creation/vnf-images
# Name of certificate to use in connecting to the A&AI
ml.aai.KEYSTORE_FILE=aai-os-cert.p12
@@ -119,7 +125,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/ \
@@ -128,6 +134,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.