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 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
  16 Project Resources
  17 -----------------
  18
  19 The source code is available from the Linux Foundation Gerrit server:
  20
  21     `<https://gerrit.o-ran-sc.org/r/admin/repos/oam>`_
  22
  23 The build (CI) jobs are in the Linux Foundation Jenkins server:
  24
  25     `<https://jenkins.o-ran-sc.org/view/oam/>`_
  26
  27 Issues are tracked in the Linux Foundation Jira server:
  28
  29     `<https://jira.o-ran-sc.org/projects/OAM/>`_
  30
  31 Project information is available in the Linux Foundation Wiki:
  32
  33     `<https://wiki.o-ran-sc.org/display/OAM/Operations+and+Maintenance>`_
  34
  35
  36 Scope
  37 -----
  38
  39 According to the O-RAN-SC-OAM-Architecture document all ManagedElements
  40 (near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU) implement the
  41 O1-interface.
  42
  43 The O-RAN-OAM-interface specification defines
  44
  45 - a NetConf-Server for Configuration Management (CM) and
  46 - a http-client for Fault Managment (FM), Performance Management (PM) and other
  47   events on each Management-Service-Provider (MnS-Provider) running on the
  48   ManagedElement (ME).
  49
  50 THe O-RAN-SC-OAM project provides reference implementation according to the
  51 O-RAN OAM (WG1) documents. In addition we provide a common MnS-Consumer for
  52 development and module test purposes.  The assumption is that the projects
  53 for the ManagedElements can concentrate on the more important user-plane.
  54
  55 Of cause each project needs its own OAM repo to address the specific needs
  56 of the ManagedElement.