Merge "Sample consumer to get kafka broker from ICS"

[nonrtric.git] / docker-compose / README.md

diff --git a/docker-compose/README.md b/docker-compose/README.md
index e405131..8fcca7e 100644 (file)
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -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.
 
@@ -69,8 +65,24 @@ All the generated data is shown on the web page
 By default, if the containers are started up and running by docker-compose file in the same directory, just run commands:
 ./preparePmsData.sh
 
-prepareEcsData.sh
-This is to generate some data into the ECS microservice
+prepareIcsData.sh
+This is to generate some data into the ICS 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 Information coordinator service.
+
+### O-RAN-SC Control Panel Gateway:
+
+To view the policy or information jobs and types in control panel gui along with Policy Management Service & Information 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 ics/docker-compose.yaml -f a1-sim/docker-compose.yaml up