Add OAM-controller configuration

[oam.git] / solution / integration / README.md

diff --git a/solution/integration/README.md b/solution/integration/README.md
index 9ffd686..8d3800e 100644 (file)
--- a/solution/integration/README.md
+++ b/solution/integration/README.md
@@ -93,9 +93,59 @@ $ cat /etc/hosts
 
 It is beneficial (but not mandatory) adding the following line add the
 end of your ~/.bashrc file. I will suppress warnings when python script
-do not verify self signed certificates for HTTPS communication. 
-```
-export PYTHONWARNINGS="ignore:Unverified HTTPS request"  
+do not verify self signed certificates for HTTPS communication.
+```
+export PYTHONWARNINGS="ignore:Unverified HTTPS request"
+```
+
+Please ensure that you download and copy the required 3GPP OpenAPIs for VES-stndDefined
+message validation into the folder './solution/integration/smo/oam/ves-collector/externalRepo'.
+
+Please follow the instructions in ./solution/integration/smo/oam/ves-collector/externalRepo/3gpp/rep/sa5/MnS/blob/Rel16/OpenAPI/README.md.
+
+The following tree shows the successfully tested folder structure. It combines different versions of the schemas ('Rel16' and 'SA88-Rel16') using 3GPP branch names.
+
+```
+$ tree solution/integration/smo/oam/ves-collector/externalRepo/
+solution/integration/smo/oam/ves-collector/externalRepo/
+├── 3gpp
+│   └── rep
+│       └── sa5
+│           └── MnS
+│               └── blob
+│                   ├── Rel16
+│                   │   └── OpenAPI
+│                   │       ├── 5gcNrm.yaml
+│                   │       ├── PerfMeasJobCtrlMnS.yaml
+│                   │       ├── README.md
+│                   │       ├── comDefs.yaml
+│                   │       ├── coslaNrm.yaml
+│                   │       ├── faultMnS.yaml
+│                   │       ├── fileDataReportingMnS.yaml
+│                   │       ├── genericNrm.yaml
+│                   │       ├── heartbeatNtf.yaml
+│                   │       ├── nrNrm.yaml
+│                   │       ├── perfMnS.yaml
+│                   │       ├── provMnS.yaml
+│                   │       ├── sliceNrm.yaml
+│                   │       └── streamingDataMnS.yaml
+│                   └── SA88-Rel16
+│                       └── OpenAPI
+│                           ├── 5gcNrm.yaml
+│                           ├── PerDataFileReportMnS.yaml
+│                           ├── PerMeasJobCtlMnS.yaml
+│                           ├── PerThresMonMnS.yaml
+│                           ├── PerfDataStreamingMnS.yaml
+│                           ├── README.md
+│                           ├── comDefs.yaml
+│                           ├── coslaNrm.yaml
+│                           ├── faultMnS.yaml
+│                           ├── genericNrm.yaml
+│                           ├── heartbeatNtf.yaml
+│                           ├── nrNrm.yaml
+│                           ├── provMnS.yaml
+│                           ├── sliceNrm.yaml
+│                           └── streamingDataMnS.yaml
 ```
 
 ## Expected Folder Structure
@@ -155,7 +205,7 @@ The tested configuration uses the following external https ports:
 
  * 8443 for the ves-collector
  * 8453 for web access to ODLUX (SDNC_WEB_PORT)
- * 8463 for the keyclock web administrator user interface. 
+ * 8463 for the keyclock web administrator user interface.
 
 #### Startup solution
 
@@ -305,9 +355,17 @@ In case of trouble, please update the commands with your customized '.env' file.
 #### Access to Topology Service
 
 ```
-curl -u admin:admin http://localhost:18181/rests/data/network-topology:network-topology/topology=topology-netconf/node=o-ran-sc-topology-service/yang-ext:mount/tapi-common:context/tapi-topology:topology-context                              
+curl -u admin:admin http://localhost:18181/rests/data/network-topology:network-topology/topology=topology-netconf/node=o-ran-sc-topology-service/yang-ext:mount/tapi-common:context/tapi-topology:topology-context
+```
+
+#### Access to Wireshark
+
+```
+  http://localhost:3000
 ```
 
+Select the interfaces you would like to capture.
+As first guess, please select the bridge interfaces.
 ### Terminate solution
 
 To stop all container please respect the following order