Test FTC100 fails since A1-SIM update

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

diff --git a/docker-compose/README.md b/docker-compose/README.md
index fdcb5f5..8fcca7e 100644 (file)
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -1,25 +1,51 @@
-# O-RAN-SC docker-compose files
-
-The docker-compose.yml file will create an entire nonrtric system with one command:
-docker-compose up
-
-Two docker-compose files are provided in this folder:
-
-nosdnc/docker-compose.yml
-This file is to create nonrtric system without sdnc a1-controller
-
-sdnc/docker-compose.yml
-This file is to create nonrtric system with sdnc a1-controller
+## License
+Copyright (C) 2020 Nordix Foundation.
+Licensed under the Apache License, Version 2.0 (the "License")
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at

 
 

-Howto:
-cd nosdnc/
-docker-compose up
+      http://www.apache.org/licenses/LICENSE-2.0

 
 

-or
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

 
 

-cd sdnc/
-docker-compose up
+For more information about license please see the [LICENSE](LICENSE.txt) file for details.

 
 

+## O-RAN-SC docker-compose files:
+The docker compose file helps the user to deploy all or partial components of nonrtric with one command.
+
+All the components in nonrtric has individual docker compose file so you can simply mix and match different components and deploy
+it at your preference.
+
+For ex.
+I want to Control Panel, A1 Policy Management Service & A1 Simulator,
+docker-compose -f docker-compose.yaml -f control-panel/docker-compose.yaml -f policy-service/docker-compose.yaml -f a1-sim/docker-compose.yaml up -d
+
+To remove all the containers use the same command,
+docker-compose -f docker-compose.yaml -f control-panel/docker-compose.yaml -f policy-service/docker-compose.yaml -f a1-sim/docker-compose.yaml down
+
+It can be used with any combination to deploy nonrtric components.
+
+## Policy Service Prerequisite:
+The A1 Policy Service can perform A1 Policy management with or without A1 Adapter. To enable/disable A1 Adapter all you have to do is,
+With SDNC A1 Adapter:
+Rename application_configuration.controller.json to application_configuration.json & start the container. Don't forget to add the A1 Adapter url,username & password in the application_configuration.json file.
+You also need to update the A1 Adapter url & credentials in the application_configuration file.
+Ex:
+For example if you use the OSC A1 Adapter then,
+"baseUrl": "http://a1controller:8282"
+"userName": "admin",
+"password": "Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U"
+docker-compose -f docker-compose.yaml -f policy-service/docker-compose.yaml -f a1-sim/docker-compose.yaml up -d
+Without SDNC A1 Adapter:
+Rename application_configuration.nocontroller.json to application_configuration.json & start the container.
+Ex:
+docker-compose -f docker-compose.yaml -f policy-service/docker-compose.yaml -f a1-sim/docker-compose.yaml up -d
+
+## To create sample data:

 The scripts in data/ will generate some dummy data in the running system.
 It will create:
 one policy type in a1-sim-OSC
 The scripts in data/ will generate some dummy data in the running system.
 It will create:
 one policy type in a1-sim-OSC


@@ -39,25 +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
 
 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
 
 
 prepareDmaapMsg.sh
 This is to generate some data into the Dmaap MR, so that PMS reads message from MR
 

-## License
+## O-RAN-SC Control Panel

 
 

-Copyright (C) 2020 Nordix Foundation.
-Licensed under the Apache License, Version 2.0 (the "License")
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+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.

 
 

-      http://www.apache.org/licenses/LICENSE-2.0
+### O-RAN-SC Control Panel Gateway:

 
 

-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+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.

 
 

-For more information about license please see the [LICENSE](LICENSE.txt) file for details.
+#### 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