Merge "Adopt new docs/tox API"
[oam.git] / 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-Intelligent-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 <https://www.o-ran.org/specifications>`_
13 as provided by O-RAN Working Group 1 (new 10).
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 to manage O-RAN ManagedElements and O-RAN ManagedFunctions.
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 The project uses the following Linux Foundation resources:
28
29 * The source code is maintained in this Gerrit:
30     `<https://gerrit.o-ran-sc.org/r/admin/repos/oam>`_
31
32 * The build (CI) jobs are in this Jenkins:
33     `<https://jenkins.o-ran-sc.org/view/oam/>`_
34
35 * Issues are tracked in this Jira:
36     `<https://jira.o-ran-sc.org/projects/OAM/issues>`_
37
38 * Project information is available in this Wiki:
39     `<https://wiki.o-ran-sc.org/display/OAM/Operations+and+Maintenance>`_
40
41
42 Scope
43 -----
44
45 According to the `O-RAN-OAM-Architecture document <https://www.o-ran.org/specifications>`_
46 all ManagedElements (ME) (near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU)
47 implement the O1-interface.
48
49 The O-RAN-OAM-interface specification defines
50
51 - a NetConf-Server for Configuration Management (CM) and
52 - a http-client for Fault Management (FM), Performance Management (PM) and other
53   events on each Management-Service-Provider (MnS-Provider) running on the
54   ManagedElement.
55
56 THe O-RAN-SC-OAM project provides reference implementation according to the
57 O-RAN OAM documents. In addition it provides a lightweight MnS-Consumer for
58 development and module test purposes. The assumption is that the projects
59 for the ManagedElements can concentrate on the more important user-plane.
60
61 Each project requires its own OAM repository to address the specific needs
62 of the ManagedFunction.
63
64 The following O-RAN specifications are considered during implementations:
65
66 +------------------------------------------+---------------------------------------------------------+----------------------+
67 | Workgroup                                | Specification                                           | Version              |
68 +==========================================+=========================================================+======================+
69 | WG1 - Use Cases and Overall Architecture | O-RAN Architecture Description                          | 3.0 - November 2020  |
70 +                                          +---------------------------------------------------------+----------------------+
71 |                                          | O-RAN Operations and Maintenance Architecture           | 4.0 - November 2020  |
72 +                                          +---------------------------------------------------------+----------------------+
73 |                                          | O-RAN Operations and Maintenance Interface              | 4.0 - November 2020  |
74 +                                          +---------------------------------------------------------+----------------------+
75 |                                          | O-RAN Information Model and Data Models Specification   | November 2020        |
76 +------------------------------------------+---------------------------------------------------------+----------------------+
77 | WG4 - The Open Fronthaul Interfaces      | O-RAN Open Fronthaul Conformance Test Specification     | 2.00 - November 2020 |
78 +                                          +---------------------------------------------------------+----------------------+
79 |                                          | O-RAN Management Plane Specification                    | 5.0 - November 2020  |
80 +                                          +---------------------------------------------------------+----------------------+
81 |                                          | O-RAN Management Plane Specification - YANG Models      | 5.0 - November 2020  |
82 +------------------------------------------+---------------------------------------------------------+----------------------+
83 | TIFG - Test & Integration Focus Group    | O-RAN End-to-End System Testing Framework Specification | 1.0 - July 2020      |
84 +------------------------------------------+---------------------------------------------------------+----------------------+