docs/overview.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019 highstreet technologies and others
   4
   5 OAM Operation and Maintenance Overview
   6 ======================================
   7
   8 The O-RAN SC OAM project provides administrative and operator
   9 functions for O-RAN components, such as Near-Realtime-RAN-Inelegent-Controller,
  10 O-RAN Centralized Unit, O-RAN Distributed Unit and O-RAN Radio Unit.
  11
  12 The project follows the specifications for the O1 interface as provided by
  13 O-RAN Working Group1.
  14
  15 The O-RAN-SC OAM project adds features and functions to the OpenDaylight-based ONAP
  16 controller 'CCSDK/SDNC'. It is built on the Common Controller Framework
  17 to control and manage O-RAN managed elements and O-RAN managed functions.
  18
  19 .. figure:: ./_static/o-ran-architecture.png
  20    :alt: SDN-R in ONAP
  21
  22    SDN-R in ONAP
  23
  24
  25 Project Resources
  26 -----------------
  27
  28 The project uses the following Linux Foundation resources:
  29
  30 * The source code is maintained in this Gerrit:
  31     `<https://gerrit.o-ran-sc.org/r/admin/repos/oam>`_
  32
  33 * The build (CI) jobs are in this Jenkins:
  34     `<https://jenkins.o-ran-sc.org/view/oam/>`_
  35
  36 * Issues are tracked in this Jira:
  37     `<https://jira.o-ran-sc.org/projects/OAM/>`_
  38
  39 * Project information is available in this Wiki:
  40     `<https://wiki.o-ran-sc.org/display/OAM/Operations+and+Maintenance>`_
  41
  42
  43 Scope
  44 -----
  45
  46 According to the O-RAN-SC-OAM-Architecture document all ManagedElements
  47 (near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU) implement the
  48 O1-interface.
  49
  50 The O-RAN-OAM-interface specification defines
  51
  52 - a NetConf-Server for Configuration Management (CM) and
  53 - a http-client for Fault Managment (FM), Performance Management (PM) and other
  54   events on each Management-Service-Provider (MnS-Provider) running on the
  55   ManagedElement (ME).
  56
  57 THe O-RAN-SC-OAM project provides reference implementation according to the
  58 O-RAN OAM (WG1) documents. In addition we provide a common MnS-Consumer for
  59 development and module test purposes.  The assumption is that the projects
  60 for the ManagedElements can concentrate on the more important user-plane.
  61
  62 Of cause each project needs its own OAM repo to address the specific needs
  63 of the ManagedElement.