{"type":"doc","content":[{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Table of Contents","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"09585a3d-bcf4-485f-8d82-e928e5ae8bf5"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"e32f82e5-62dc-49ef-9a34-67ac0564c29c"}}]},{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"1. Introduction","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Detail the approach of steps for OAM deployment.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1.1 Description","type":"text"}]},{"type":"paragraph","content":[{"text":"With respect to Operation and Maintenance (OAM) the SMO implements the O1-interface consumers.","type":"text"},{"type":"hardBreak"},{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"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 treafik acts as reverse proxy to terminate all incoming https traffic.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1.2 System topology","type":"text"}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center","width":932,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":744,"alt":"image-20241023-111326.png","id":"2d2736b0-e32c-4188-840f-b763d3184855","collection":"contentId-131661827","type":"file","height":438}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":" 2. Minimum Requirements","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Detail the hardware and software requirements necessary for the installation.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"4x","type":"text","marks":[{"type":"strong"}]},{"text":" Cores","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"16 GB ","type":"text","marks":[{"type":"strong"}]},{"text":"RAM","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"100 GB","type":"text","marks":[{"type":"strong"}]},{"text":" Storage ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ubuntu 24.04.1 LTS","type":"text","marks":[{"type":"strong"}]},{"text":" Operating System ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Docker","type":"text","marks":[{"type":"strong"}]},{"text":" version 27.2.0, build 3ab4256","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Docker Compose","type":"text","marks":[{"type":"strong"}]},{"text":" version v2.29.2","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"git","type":"text","marks":[{"type":"strong"}]},{"text":" version 2.43.0","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python","type":"text","marks":[{"type":"strong"}]},{"text":" 3.12.3","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pip3 install ","type":"text"},{"text":"jproperties","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3. Installation","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" step-by-step instructions for deployment","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.1 Step 1: ","type":"text"}]},{"type":"paragraph","content":[{"text":"The reverse proxy implementation requires fully qualified domain names to route the traffic to the different SMO/OAM components. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Avoiding the setup of a DNS which may interfere with other DNS the following lines should be added in your /etc/hosts file. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": is the hostname of the system, where the browser is started","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":": is the IP address of the system where the solution will be deployed","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"In addition, please change in the different .env files the environment variable 'HOST_IP' to the IP address of the system where you deploy the solution - search for 'aaa.bbb.ccc.dd' and replace it. ","type":"text"}]},{"type":"paragraph","content":[{"text":"For development purposes and may reference the same system.","type":"text"}]},{"type":"codeBlock","content":[{"text":"# replace xxx.yyy.zzz.www by your routable IP address\ngrep -arl --include=*\\.env 'aaa.bbb.ccc.dd' * | while read -r file; do\n sed -i 's/aaa.bbb.ccc.dd/xxx.yyy.zzz.www/g' \"$file\"\ndone","type":"text"}]},{"type":"paragraph","content":[{"text":"Expected Result:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"$ cat /etc/hosts\n[...]\n\n# SMO OAM development system\n smo.o-ran-sc.org\n gateway.smo.o-ran-sc.org\n identity.smo.o-ran-sc.org\n messages.smo.o-ran-sc.org\n kafka-bridge.smo.o-ran-sc.org\n odlux.oam.smo.o-ran-sc.org\n flows.oam.smo.o-ran-sc.org\n tests.oam.smo.o-ran-sc.org\n controller.dcn.smo.o-ran-sc.org\n ves-collector.dcn.smo.o-ran-sc.org ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.2 Step 2:","type":"text"}]},{"type":"paragraph","content":[{"text":"Create an python environment. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"python3 -m venv .oam\nsource .oam/bin/activate\npip3 install jproperties\npip3 install jinja2\npip3 install requests\n\n# your system IP is required in .env files, please see explanations below\npython3 ./adopt_to_environment.py -i ","type":"text"}]},{"type":"paragraph","content":[{"text":"Please remember and ensure that you always run python scripts in this environment using the command","type":"text"}]},{"type":"codeBlock","content":[{"text":"source .oam/bin/activate","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3.3 Step 3:","type":"text"}]},{"type":"paragraph","content":[{"text":"Docker compose commands are used to bring up the solution. For configurations python scripts are available.","type":"text"}]},{"type":"codeBlock","content":[{"text":"source .oam/bin/activate\ndocker compose -f smo/common/docker-compose.yaml up -d --wait\npython smo/common/identity/config.py # user configuration\n\ndocker compose -f smo/oam/docker-compose.yaml up -d\ndocker compose -f smo/apps/docker-compose.yaml up -d\n\n# you can test the OAM functions using the simulaters of from O-RAN-SC Sim project\ndocker compose -f network/docker-compose.yaml up -d\ndocker compose -f network/docker-compose.yaml restart ntsim-ng-o-du-1122\npython network/config.py\n```","type":"text"}]},{"type":"paragraph","content":[{"text":"Expected Result:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"}]},{"type":"codeBlock","content":[{"text":"$ python3 network/config.py\nSet O-DU-1122 True\nSet O-RU-11222 True\nSet O-RU-11224 True\nSet O-RU-11223 True\nSet O-RU-11221 True","type":"text"}]},{"type":"paragraph","content":[{"text":"You can check our deployment using the docker ps command:","type":"text"}]},{"type":"codeBlock","content":[{"text":"$ docker ps -a --format \"table {{.Names}}\\t{{.Image}}\\t{{.Status}}\"\n\nNAMES IMAGE STATUS\nntsim-ng-o-du-1122 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-du:1.8.1 Up 55 seconds\nntsim-ng-o-ru-11222 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-ru-fh:1.8.1 Up About a minute\nntsim-ng-o-ru-11223 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-ru-fh:1.8.1 Up About a minute\nntsim-ng-o-ru-11224 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-ru-fh:1.8.1 Up About a minute\nntsim-ng-o-ru-11221 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-ru-fh:1.8.1 Up About a minute\nflows nodered/node-red:latest-configured Up 2 minutes (healthy)\nwireshark lscr.io/linuxserver/wireshark Up 2 minutes\ntests jenkins/jenkins:lts Up 2 minutes\nves-collector nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.10.1-configured Up 2 minutes (healthy)\ncontroller nexus3.onap.org:10001/onap/sdnc-image:2.6.1 Up 2 minutes (healthy)\nodlux nexus3.onap.org:10001/onap/sdnc-web-image:2.6.1 Up 2 minutes\nkafka-bridge http://quay.io/strimzi/kafka-bridge:0.25.0 Up 24 minutes (healthy)\nmessages nexus3.onap.org:10001/onap/dmaap/dmaap-mr:1.1.18 Up 24 minutes\nidentity bitnami/keycloak:18.0.2 Up 24 minutes\nkafka nexus3.onap.org:10001/onap/dmaap/kafka111:1.0.4 Up 24 minutes\ntopology nexus3.o-ran-sc.org:10002/o-ran-sc/smo-nts-ng-topology-server:1.5.2 Up 24 minutes (healthy)\nidentitydb bitnami/postgresql:13 Up 24 minutes\npersistence mariadb:11.1.2 Up 24 minutes (healthy)\nzookeeper nexus3.onap.org:10001/onap/dmaap/zookeeper:6.0.3 Up 24 minutes\ngateway traefik:v2.9.6 Up 24 minutes (healthy)4. Post-Installation Verification","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4. Post-Installation Verification","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Outline how to verify that the installation was successful.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.1 Step 1: Login","type":"text"}]},{"type":"paragraph","content":[{"text":"Please see the available users and there default password in file","type":"text"}]},{"type":"paragraph","content":[{"text":"smo/common/identity/authentication.json","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Open the ODLUX UI for login: ","type":"text"}]},{"type":"paragraph","content":[{"text":"https://odlux.oam.smo.o-ran-sc.org","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center","width":933,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1090,"alt":"image-20241023-112910.png","id":"32c8f16b-afa3-4a58-93c4-705bb46ddaeb","collection":"contentId-131661827","type":"file","height":746}}]},{"type":"paragraph","content":[{"text":"Please click on “ONAP-IDENTITY”.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":816,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1763,"alt":"image-20241023-113123.png","id":"0d60ca53-6a82-46ef-bbb5-ec35995cabd0","collection":"contentId-131661827","type":"file","height":1009}},{"type":"caption","content":[{"text":"First time login with default users and passwords as specified in ","type":"text"},{"text":"smo/common/identity/authentication.json","type":"text","marks":[{"type":"code"}]}]}]},{"type":"paragraph","content":[{"text":"When the user logs in the first time the default password must be changed.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":816,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1763,"alt":"image-20241023-113331.png","id":"c2ea8e8e-0d2f-4f76-a479-94b95842ba77","collection":"contentId-131661827","type":"file","height":1009}}]},{"type":"paragraph","content":[{"text":"Expected Result:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"successful login","type":"text"}]}]}]},{"type":"mediaSingle","attrs":{"layout":"center","width":816,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1763,"alt":"image-20241023-113509.png","id":"c87b58ea-3245-4bcc-ac6f-1242aae591ae","collection":"contentId-131661827","type":"file","height":1009}},{"type":"caption","content":[{"text":"See login name in the upper right corner.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4.2 Step 2:","type":"text"}]},{"type":"paragraph","content":[{"text":"Please move to “Connect” to see the connection status to the simulated O-RAN.","type":"text"}]},{"type":"paragraph","content":[{"text":"Expected Result:","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":933,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1662,"alt":"image-20241022-184725.png","id":"8e11579c-cc7b-4ea9-8203-3eb060a46afc","collection":"contentId-131661827","type":"file","height":626}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":" 5. Troubleshooting","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Provide common issues and their solutions.","type":"text"}]},{"type":"paragraph","content":[{"text":"In case of trouble please look into log files:","type":"text"}]},{"type":"codeBlock","content":[{"text":"### Log files and karaf console\n#### ODL karaf.logs\ndocker exec -it controller tail -f /opt/opendaylight/data/log/karaf.log\n\n#### ves-collector logs\ndocker logs -f ves-collector","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"6. Additional Resources","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" List of additional documentation, links, or resources that may be helpful.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Documentation: Please see README.md","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Support: ","type":"text"},{"type":"mention","attrs":{"id":"5c546ccb39ca604edaa6e227","localId":"c5d5ed67-bbb1-49c7-8ac5-7046626c7c4c","text":"@Martin Skorupski"}},{"text":" at ","type":"text"},{"text":"https://o-ran-sc-lf.slack.com/archives/D07CT4MKF2B","type":"text","marks":[{"type":"link","attrs":{"href":"https://o-ran-sc-lf.slack.com/archives/D07CT4MKF2B"}}]}]}]}]}]}]},{"type":"paragraph"}],"version":1}