docs/user-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) <optionally add copywriters name>
   4
   5
   6 User Guide
   7 ==========
   8
   9 This is the user guide of OSC SMO O1 Interface
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15 ..  a user guide should be how to use the component or system; it should not be a requirements document
  16 ..  delete this content after edittng it
  17
  18
  19 Description
  20 -----------
  21 .. Describe the traget users of the projcet, for example, modeler/data scientist, ORAN-OSC platform admin, marketplace user, design studio end user, etc
  22 .. Descirbe how the target users can get use of a O-RAN SC component.
  23 .. If the guide contains sections on third-party tools, is it clearly stated why the O-RAN-OSC platform is using those tools? Are there instructions on how to install and configure each tool/toolset?
  24
  25 This project is intended for operators that want to configure the RAN Network Functions (NF), i.e., O-DU, O-CU, O-RU, and the Near RT-RIC over the O1 (NETCONF/RESTCONF) interface.
  26
  27 Each of the NFs advertise their own capabilities over a NETCONF session that is established between the SMO and each of the NFs. Thereafter the NETCONF session is used to configure and manage each of the NFs.
  28
  29 This user guide assumes that Installation Guide has been followed to install the necessary hardware and software.
  30
  31 Feature Introduction
  32 --------------------
  33 .. Provide enough information that a user will be able to operate the feature on a deployed scenario. content can be added from administration, management, using, Troubleshooting sections perspectives.
  34
  35 The GUI interface for O1 interface can be accessed at::
  36
  37     http://<host_ip>:8181/odlux/index.html
  38
  39 The username/password is:
  40
  41 admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
  42
  43 and can be updated by updating the .env file in the repository.
  44
  45
  46
  47
  48