update docs for solution deployment 73/14273/2
authorMartin Skorupski <martin.skorupski@highstreet-technologies.com>
Wed, 19 Mar 2025 09:29:03 +0000 (10:29 +0100)
committerMartin Skorupski <martin.skorupski@highstreet-technologies.com>
Wed, 19 Mar 2025 09:39:25 +0000 (09:39 +0000)
- update README
- remove unused import

Issue-ID: OAM-430
Change-Id: I4b3fdfadaf47b0df4665e7dc0d8eb3030f165528
Signed-off-by: Martin Skorupski <martin.skorupski@highstreet-technologies.com>
solution/README.md
solution/adopt_to_environment.py

index 5386d7d..9f66ea0 100644 (file)
@@ -5,12 +5,14 @@ This project focus on a docker-compose deployment solution for SMO/OAM Component
 ## Introduction
 
 With respect to Operation and Maintenance (OAM) the SMO implements the O1-interface and OpenFronthaul Management-Plane consumers.
-According to the O-RAN OAM Architecture and the O-RAN OAM Interface Specification, the SMO implements a NETCONF Client for configuration 
-and a HTTP/REST/VES server for receiving all kind of events in 
-VES format.
+According to the O-RAN OAM Architecture and the O-RAN OAM Interface Specification, the SMO implements a NETCONF Client for configuration
+and a HTTP/REST/VES server for receiving all kind of events in VES format.
 
 The O-RAN-SC OAM deployment contains an OpenDaylight based NETCONF client and an ONAP VES Collector. Kafka is used as massage router for communication between the components. The Keycloak implementation offers and Identity service, while traefik acts as reverse proxy to terminate all incoming https traffic. For storing data in a persistence way the implementation of the mariaDB project is used.
 
+Before you start please think about a nice full qualified domain name of your environment. Your DNS or /etc/hosts settings needs to be updated.
+Here an inspiration: smo.dev.o-ran-sc.<your-organization>.com
+
 ## SMO OAM Components
 
 This docker-compose file starts a pre-configured, self-contained SDN-R solution
@@ -69,6 +71,11 @@ $ docker compose version
 Docker Compose version v2.32.4
 ```
 
+In case your environment acts behind a proxy, please see related docker documentations:
+
+https://docs.docker.com/engine/daemon/proxy/
+
+
 ### GIT
 
 ```
index 7dce99f..116c551 100755 (executable)
@@ -17,7 +17,6 @@
 #!/usr/bin/env python3
 
 import os
-import socket
 import netifaces
 import argparse
 from jinja2 import Template