Utilize markdown lint/preview tools to improve syntax
Signed-off-by: ecaiyanlinux <martin.c.yan@est.tech>
Issue-ID: NONRTRIC-517
Change-Id: Ib9a6e297ed1a4a0a8136df7c2549f61485de82e9
19 files changed:
This module builds the sdnc-a1-northbound which inturn creates the nonrt-ric-api-provider & nonrt-ric-api-model bundles.
This module builds the sdnc-a1-northbound which inturn creates the nonrt-ric-api-provider & nonrt-ric-api-model bundles.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module builds the submodule sdnc-a1-northbound-all,features-sdnc-a1-northbound & installer which creates the features & installers which can be installed in Karaf Server.
This module builds the submodule sdnc-a1-northbound-all,features-sdnc-a1-northbound & installer which creates the features & installers which can be installed in Karaf Server.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module creates features-sdnc-a1-northbound features from sdnc-a1-northbound-all feature.
This module creates features-sdnc-a1-northbound features from sdnc-a1-northbound-all feature.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module is responsible for creating sdnc-a1-northbound-features-installer installer which contains sdnc-a1-northbound-all feature. This is then installed into Karaf Server when deployed.
This module is responsible for creating sdnc-a1-northbound-features-installer installer which contains sdnc-a1-northbound-all feature. This is then installed into Karaf Server when deployed.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module creates the sdnc-a1-northbound-all feature from sdnc-nonrt-ric-api feature.
This module creates the sdnc-a1-northbound-all feature from sdnc-nonrt-ric-api feature.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module builds the model, provider, install & features to create the bundles, features & installers.
This module builds the model, provider, install & features to create the bundles, features & installers.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module builds the two submodules sdnc-nonrt-ric-api & features-nonrt-ric-api which creates the A1 northbound feature.
This module builds the two submodules sdnc-nonrt-ric-api & features-nonrt-ric-api which creates the A1 northbound feature.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module creates the features-nonrt-ric-api feature from sdnc-nonrt-ric-api feature
This module creates the features-nonrt-ric-api feature from sdnc-nonrt-ric-api feature
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module creates the sdnc-nonrt-ric-api feature from the nonrt-ric-api-model & nonrt-ric-api-provider bundles.
This module creates the sdnc-nonrt-ric-api feature from the nonrt-ric-api-model & nonrt-ric-api-provider bundles.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module installs the sdnc-nonrt-ric-api feature into the Karaf Server.
This module installs the sdnc-nonrt-ric-api feature into the Karaf Server.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module contains the yang definition of the A1 northbound API and creates the nonrt-ric-api-model bundle.
This module contains the yang definition of the A1 northbound API and creates the nonrt-ric-api-model bundle.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module provides the implementation for the A1 Northbound API and creates the nonrt-ric-api-provider bundle.
This module provides the implementation for the A1 Northbound API and creates the nonrt-ric-api-provider bundle.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module builds the submodule sdnc-a1 which inturn creates the SDNC A1 docker image
This module builds the submodule sdnc-a1 which inturn creates the SDNC A1 docker image
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
The docker-compose file is also included in this directory.
The docker-compose file is also included in this directory.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module is responsible for creating Docker images. The feature installers are added into the docker images so that it can be installed in karaf server.
This module is responsible for creating Docker images. The feature installers are added into the docker images so that it can be installed in karaf server.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
The SDNC-A1 controller uses the default keystore and truststore that are built into the container.
The paths and passwords for these stores are located in a properties file:
The SDNC-A1 controller uses the default keystore and truststore that are built into the container.
The paths and passwords for these stores are located in a properties file:
-nonrtric/sdnc-a1-controller/oam/installation/src/main/properties/https-props.properties
+`nonrtric/sdnc-a1-controller/oam/installation/src/main/properties/https-props.properties`
The default truststore includes the a1simulator cert as a trusted cert which is located here:
The default truststore includes the a1simulator cert as a trusted cert which is located here:
-https://gerrit.o-ran-sc.org/r/gitweb?p=sim/a1-interface.git;a=tree;f=near-rt-ric-simulator/certificate;h=172c1e5aacd52d760e4416288dc5648a5817ce65;hb=HEAD
+<https://gerrit.o-ran-sc.org/r/gitweb?p=sim/a1-interface.git;a=tree;f=near-rt-ric-simulator/certificate;h=172c1e5aacd52d760e4416288dc5648a5817ce65;hb=HEAD>
The default keystore, truststore, and https-props.properties files can be overridden by mounting new files using the "volumes" field of docker-compose. Uncommment the following lines in docker-compose to do this, and provide paths to the new files:
The default keystore, truststore, and https-props.properties files can be overridden by mounting new files using the "volumes" field of docker-compose. Uncommment the following lines in docker-compose to do this, and provide paths to the new files:
- # - <path_to_keystore>:/etc/ssl/certs/java/keystore.jks:ro
- # - <path_to_truststore>:/etc/ssl/certs/java/truststore.jks:ro
- # - <path_to_https-props>:/opt/onap/sdnc/data/properties/https-props.properties:ro
+# - <path_to_keystore>:/etc/ssl/certs/java/keystore.jks:ro
+# - <path_to_truststore>:/etc/ssl/certs/java/truststore.jks:ro
+# - <path_to_https-props>:/opt/onap/sdnc/data/properties/https-props.properties:ro
+```
The target paths in the container should not be modified.
For example, assuming that the keystore, truststore, and https-props.properties files are located in the same directory as docker-compose:
The target paths in the container should not be modified.
For example, assuming that the keystore, truststore, and https-props.properties files are located in the same directory as docker-compose:
volumes:
- ./new_keystore.jks:/etc/ssl/certs/java/keystore.jks:ro
- ./new_truststore.jks:/etc/ssl/certs/java/truststore.jks:ro
- ./new_https-props.properties:/opt/onap/sdnc/data/properties/https-props.properties:ro
volumes:
- ./new_keystore.jks:/etc/ssl/certs/java/keystore.jks:ro
- ./new_truststore.jks:/etc/ssl/certs/java/truststore.jks:ro
- ./new_https-props.properties:/opt/onap/sdnc/data/properties/https-props.properties:ro
This module builds the submodule setup & installer
This module builds the submodule setup & installer
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module builds the platform-logic-installer which contains the DG's but A1 controller in O-RAN doesn't support DG.
This module builds the platform-logic-installer which contains the DG's but A1 controller in O-RAN doesn't support DG.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
This module should contains the Directed Graphs (DG) but A1 controller in O-RAN doesn't support DG.
This module should contains the Directed Graphs (DG) but A1 controller in O-RAN doesn't support DG.
-To compile, run "mvn clean install".
+To compile, run
+>`mvn clean install`
Code Review / nonrtric.git / commitdiff