X-Git-Url: https://gerrit.onap.org/r/gitweb?p=aai%2Fmodel-loader.git;a=blobdiff_plain;f=Readme.md;h=5aa173339676a36acfe134d9093c130a4ded1bdb;hp=5456fc9c5c1d326d90d8a613f7fdfffb1b2e0ee1;hb=HEAD;hpb=6e4f04afea4c2d07fdd9c15eda38438c7baeb308 diff --git a/Readme.md b/Readme.md deleted file mode 100644 index 5456fc9..0000000 --- a/Readme.md +++ /dev/null @@ -1,132 +0,0 @@ -# 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. - -## Features - -The Model Loader: - -* registers with the SDC to receive notification events -* 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` -A Model Loader docker image can be created by running `docker build -t onap/model-loader target` - -## 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:** - - ./logs - ./opt/app/model-loader/appconfig - ./opt/app/model-loader/appconfig/auth - -You will be mounting these as data volumes when you start the Docker container. For examples of the files required in these directories, see the aai/test/config repository (https://gerrit.onap.org/r/#/admin/projects/aai/test-config) - -**Populate these directories as follows:** - -#### Contents of /opt/app/model-loader/appconfig - -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. - ml.distribution.CONSUMER_GROUP=aai-ml-group - - # DMaaP consumer ID - ml.distribution.CONSUMER_ID=aai-ml - - # SDC Environment Name. This must match the environment name configured on the SDC - ml.distribution.ENVIRONMENT_NAME= - - # Currently not used - ml.distribution.KEYSTORE_PASSWORD= - - # Currently not used - ml.distribution.KEYSTORE_FILE= - - # Obfuscated password to connect to the SDC. To obtain this value, use the following Jetty library to - # 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 - ml.distribution.POLLING_INTERVAL= - - # Timeout value (in seconds) when polling DMaaP 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=MMODEL_QUERY_SPEC,TOSCA_CSAR - - # List of message bus addresses on which to listen for distribution events - ml.distribution.MSG_BUS_ADDRESSES=, - - # URL of the A&AI - ml.aai.BASE_URL=https://:8443 - - # A&AI endpoint to post models - ml.aai.MODEL_URL=/aai/v*/service-design-and-creation/models/model/ - - # A&AI endpoint to post named queries - 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/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 - - # Obfuscated keystore password to connect to the A&AI. This is only required if using 2-way SSL (not basic auth). - # To obtain this value, use the following Jetty library to obfuscate the cleartext password: - # http://www.eclipse.org/jetty/documentation/9.4.x/configuring-security-secure-passwords.html - ml.aai.KEYSTORE_PASSWORD=OBF: - - # Name of user to use when connecting to the A&AI. This is only required if using basic auth (not 2-way SSL). - ml.aai.AUTH_USER= - - # Obfuscated password to connect to the A&AI. This is only required if using basic auth (not 2-way SSL). - # To obtain this value, use the following Jetty library to obfuscate the cleartext password: - # http://www.eclipse.org/jetty/documentation/9.4.x/configuring-security-secure-passwords.html - ml.aai.AUTH_PASSWORD=OBF: - - - -##### Contents of the /opt/app/model-loader/app-config/auth Directory - -The following files must be present in this directory on the host machine: - -_aai-os-cert.p12_ - -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: - - docker run -d \ - -e CONFIG_HOME=/opt/app/model-loader/config/ \ - -v /logs:/logs \ - -v /opt/app/model-loader/appconfig:/opt/app/model-loader/config \ - --name model-loader \ - {{your docker repo}}/model-loader - -Where, - - {{your docker repo}} = The Docker repository you have published your image to.