Secure all created user accounts

[oam.git] / solution / README-O-RU-Controller.md

diff --git a/solution/README-O-RU-Controller.md b/solution/README-O-RU-Controller.md
index e5f6bd3..c57a696 100644 (file)
--- a/solution/README-O-RU-Controller.md
+++ b/solution/README-O-RU-Controller.md
@@ -5,24 +5,66 @@ as component for O-DU and/or SMO implementations.
 
 ## Prerequisites
 
+### Resources
+
+The solution was tested on a VM with
+
+- 4x Core
+- 16 GBit RAM 
+- 50 Gbit Storage
+
+### Operating (HOST) System
+
 ```
 $ cat /etc/os-release | grep PRETTY_NAME
-PRETTY_NAME="Ubuntu 22.04.1 LTS"
+PRETTY_NAME="Ubuntu 22.04.2 LTS"
+```
+
+### Docker
 
+```
 $ docker --version
-Docker version 20.10.12, build 20.10.12-0ubuntu4
+Docker version 23.0.1, build a5ee5b1
+```
+Please follow the required docker daemon configuration as documented in the following README.md:
+- [./smo/common/docker/README.md](./smo/common/docker/README.md)
+
+### Docker Compose
 
-$ docker-compose version
-docker-compose version 1.29.2, build unknown
-docker-py version: <module 'docker.version' from '/usr/local/lib/python3.10/dist-packages/docker/version.py'>
-CPython version: 3.10.6
-OpenSSL version: OpenSSL 3.0.2 15 Mar 2022
+```
+$ docker compose version
+Docker Compose version v2.17.2
+```
 
+### GIT
 
+```
 $ git --version
 git version 2.34.1
+```
 
+### Python
+
+```
+$ python3 --version
+Python 3.10.6
+
+```
+sudo apt install python3-pip
+pip install jproperties
 ```
+
+```
+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.
+
+```
+export PYTHONWARNINGS="ignore:Unverified HTTPS request"
+```
+
+### ETC Host (DNS function)
+
 Please modify the /etc/hosts of your system.
 
 * \<your-system>: is the hostname of the system, where the browser is started
@@ -46,20 +88,20 @@ $ cat /etc/hosts
 <deployment-system-ipv4>    controller.oam.smo.o-ran-sc.org
 
 ```
+
 ## Bring Up Solution
 
 The following commands should be invoked. More detailed can be found in the
 next chapters.
 
 ```
-docker-compose -f smo/common/docker-compose.yml up -d
+docker compose -f smo/common/docker-compose.yml up -d
 python smo/common/identity/config.py
-docker-compose -f smo/oam/docker-compose.yml up -d odlux controller
-docker-compose -f network/docker-compose.yml up -d ntsim-ng-o-ru-fh-11221
+docker compose -f smo/oam/docker-compose.yml up -d odlux controller
+docker compose -f network/docker-compose.yml up -d ntsim-ng-o-ru-fh-11221
 python network/config.py
 ```
 
-
 ## Verification Solution
 
 ### Login into O-RU-Controller UI
@@ -89,7 +131,7 @@ In the O-RU Controller UI you should see the generated alarm notifications of th
 To stop all container please respect the following order
 
 ```
-docker-compose -f network/docker-compose.yml down
-docker-compose -f smo/oam/docker-compose.yml down
-docker-compose -f smo/common/docker-compose.yml down
+docker compose -f network/docker-compose.yml down
+docker compose -f smo/oam/docker-compose.yml down
+docker compose -f smo/common/docker-compose.yml down
 ```