1. OOF
2. DCAE
2.1. SON-Handler MS
...
<Mention image version, git repo direct link to fetch the required version, config steps, any build steps, config file updates, dump file (attach it to this page), etc.>
Steps to build the RAN-Sim Controller setup:
1. Clone and Checkout Ran-Sim Controller(use Dublin branch)
git clone https://github.com/onap-oof-pci-poc/ran-sim.git
cd ran-sim/ransim/
2. Copy ‘m2_settings.xml’ from ‘<YOURFOLDER>/ransim/’ to <HOME>/.m2/ folder as settings.xml file after updating environment specific configurations.
If the file already exists in <HOME>/.m2/ folder, then merge this file content into the existing file appropriately.
Note: settings.xml entries are mandatory to include dependencies.
3. Open the terminal and navigate to the '<YOURFOLDER>/ransim/ransimctrlr'
4. The following capabilities can be modified in the 'ransim.properties' file based on user capabilities and configurations.
File directory:
<YOURFOLDER>/ransim/ransimctrlr/packages/base/src/files/install/servers/ransim/bin/ransim.properties
a) serverIdPrefix:
Netconf server comman prefix (use default value present in the file)
b) numberOfCellsPerNCServer:
Maximum number of cells that can be handled in a single netconf server(use default value present in the file).
c) numberOfProcessPerMc:
Maximum number of netconf servers that can run in a single machine(use default value present in the file, which is for a machine of 8 GB RAM)
(A single netconf server uses approximately 350MB).
d) numberOfMachines:
Maximum number of machines available(use default value present in the file).
e) GridSize: (Applicable only for HONEYCOMB representation)
The number of cells that can be accommodated along one side of the cluster for an auto-generated layout.
However, it has no relevance now, as the initial layout is generated from a file. So use default value as 1.
f) strictValidateRansimAgentsAvailability:
A boolean value to check if any RAN-Sim agents are running (use default value present in the file).
g) sdnrServerIp:
Neglect(Refer point 5 to update SDNR details).
h) sdnrServerPort:
Neglect(Refer point 5 to update SDNR details).
i) sdnrServerUserid:
Negelct (Refer point 5 to update SDNR details).
j) sdnrServerPassword:
Negelct (Refer point 5 to update SDNR details).
k) maxPciValueAllowed:
maximum value of the physical cell Id. (Default is 503).
l)dumpFileName
Location of the dumpfile to load the topology.
The dump file is loaded from '<YOURFOLDER>/ransim/docker/config'. A sample dump file - 'sample.json' contains deatils of 1000 cells.
For the controller to access the dump file from the the above location use the path - /tmp/ransim-install/config/sample.json
5. The SDNR details can be updated in the file '<YOURFOLDER>/ransim/docker/docker-compose.yml'.
environment:
- SDNR_IP={SDNR IP address}
- SDNR_PORT={SDNR port number}
- SDNR_USER={SDNR user ID}
- SDNR_PASSWORD={SDNR user password}
6. Run the following command in the terminal
mvn clean install
7. After successful build navigate to '<YOURFOLDER>/ransim/docker' directory.
8. Run the following three commands in the terminal:
'mvn prepare-package'
'docker build -t onap/ransim-demo ransim-docker'
'docker-compose up'
Note: Use docker compose version 1.6.0 or above.
Once the ransim and mariadb containers are started, you can see logs similar to below image
9. Access the GUI using the following url in the web browser:
‘http://<yourIP>:8081/ransimui/index.html
10. Access the swagger ui using the following url:
‘http://<yourIP>:8081/ransim/api/swagger-ui.html
11. Try the following url in Websocket client extension in the web browser to verify the connectivity:
‘ws://<yourIP>:8081/ransim/RansimAgent/hai’
Steps to check the RAN-Sim Controller logs
1. Open the console and enter the following command:
'docker ps'
2. Once the container details is displayed enter the following command:
docker exec -it ransim bash
3. Navigate to '/opt/app/policy/servers/ransim/logs' using the cd command.
4. Execute the following command to check the logs:
'tail -f ransim-rest.log'