Update Readme file with control panel information 31/5931/1
authorychacon <yennifer.chacon@est.tech>
Sat, 24 Apr 2021 22:34:19 +0000 (00:34 +0200)
committerychacon <yennifer.chacon@est.tech>
Sat, 24 Apr 2021 22:34:19 +0000 (00:34 +0200)
Issue-ID: NONRTRIC-448
Signed-off-by: ychacon <yennifer.chacon@est.tech>
Change-Id: I11852e03fa4b30cc4e09affb95493ddc2add07e3

docker-compose/README.md

index e405131..d7a4f17 100644 (file)
@@ -14,10 +14,6 @@ limitations under the License.
 
 For more information about license please see the [LICENSE](LICENSE.txt) file for details.
 
-## O-RAN-SC ControlPanel Gateway:
-To view the policy or enrichment information in control panel gui along with Policy Management Service & Enrichment Coordinator Service you should also have nonrtric gateway because all the request from the gui is passed through this API gateway.
-To start all the necessary components,
-docker-compose -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml -f policy-service/docker-compose.yaml -f ecs/docker-compose.yaml -f a1-sim/docker-compose.yaml up
 ## O-RAN-SC docker-compose files:
 The docker compose file helps the user to deploy all or partial components of nonrtric with one command.
 
@@ -73,4 +69,20 @@ prepareEcsData.sh
 This is to generate some data into the ECS microservice
 
 prepareDmaapMsg.sh
-This is to generate some data into the Dmaap MR, so that PMS reads message from MR
\ No newline at end of file
+This is to generate some data into the Dmaap MR, so that PMS reads message from MR
+
+## O-RAN-SC Control Panel
+
+The Non-RT RIC Control Panel is a graphical user interface that enables the user to view and manage the A1 policies in the RAN and also view producers and jobs for the Enrichement coordinator service.
+
+### O-RAN-SC Control Panel Gateway:
+
+To view the policy or enrichment information in control panel gui along with Policy Management Service & Enrichment Coordinator Service you should also have nonrtric gateway because all the request from the gui is passed through this API gateway.
+
+#### Prerequisite:
+
+Make sure to follow the section regarding sample data so there is data available to see in the interface.
+
+To start all the necessary components, run the following command:
+
+docker-compose -f docker-compose.yaml -f control-panel/docker-compose.yaml -f nonrtric-gateway/docker-compose.yaml -f policy-service/docker-compose.yaml -f ecs/docker-compose.yaml -f a1-sim/docker-compose.yaml up
\ No newline at end of file