Update README to document new Wireshark function
[oam.git] / solution / integration / README.md
index 8ea8f40..73100a4 100644 (file)
@@ -93,9 +93,9 @@ $ 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. 
+do not verify self signed certificates for HTTPS communication.
 ```
-export PYTHONWARNINGS="ignore:Unverified HTTPS request"  
+export PYTHONWARNINGS="ignore:Unverified HTTPS request"
 ```
 
 ## Expected Folder Structure
@@ -117,6 +117,7 @@ export PYTHONWARNINGS="ignore:Unverified HTTPS request"
     │   ├── docker
     │   ├── identity
     │   ├── kafka
+    │   ├── o-ran-sc-topology-service
     │   └── zookeeper
     ├── non-rt-ric
     │   ├── docker-compose.yml
@@ -154,7 +155,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
 
@@ -177,7 +178,7 @@ docker-compose -f smo/oam/docker-compose.yml up -d
 docker-compose -f smo/non-rt-ric/docker-compose.yml up -d
 ```
 
-In order to create/deploy the apex policy for O-RU closed loop recovery usecase,
+In order to create/deploy the apex policy for O-RU closed loop recovery use case,
 refer to the section named "Create/Deploy apex policy for O-RU & O-DU use case" in
 this page:
 https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325
@@ -194,16 +195,16 @@ If you see the login page (https://sdnc-web:8453) you are good to go and can sta
 
 ### populate data into Non-RT-RIC
 
-Full instrucion on how to run Non-RT-RIC can be found in this page:
+Full instruction on how to run Non-RT-RIC can be found in this page:
 <https://wiki.o-ran-sc.org/display/RICNR/Release+D>
 
-When containers in Non-RT-RIC are all up, by default, there is no data running inside. Folder `non-rt-ric/data/` contains serveral scripts to populate data into Non-RT-RIC for test & demo purpose.
+When containers in Non-RT-RIC are all up, by default, there is no data running inside. Folder `non-rt-ric/data/` contains several scripts to populate data into Non-RT-RIC for test & demo purpose.
 
 ```
 bash prepareDmaapMsg.sh
 ```
 
-script `prepareDmaapMsg.sh` sends messages to dmaap message router, then Non-RT-RIC policy-agent service polls messages from dmaap, and creates policy instances accordingly.
+script `prepareDmaapMsg.sh` sends messages to DMaaP message router, then Non-RT-RIC policy-agent service polls messages from DMaaP, and creates policy instances accordingly.
 
 ```
 bash preparePmsData.sh
@@ -215,7 +216,7 @@ script `preparePmsData.sh` sends http requests to policy-agent service, and crea
 bash prepareEcsData.sh
 ```
 
-script `prepareEcsData.sh` sends http requests to ecs service, and creates data accordingly.
+script `prepareIcsData.sh` sends http requests to ics service, and creates data accordingly.
 
 Afterwards, open webpage:
 <http://localhost:8182/>
@@ -301,6 +302,20 @@ docker logs ecs
 
 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
+```
+
+#### 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