Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docs / ce1e0797381c1da1b3ff2c52eb105d835a24f12a / . / index.rst
blob: 92d62e3843015dd59cbb19cba588d530f735e6f1 [file] [log] [blame]
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]1VOLTHA Documentation
2====================
3
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]4`VOLTHA (Virtual OLT Hardware Abstraction
5<https://www.opennetworking.org/voltha/>`_ is an open source project to create a
6hardware abstraction for broadband access equipment. It supports the principle
7of multi-vendor, disaggregated, "any broadband access as a service" for the
8Telco Central Office.
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]9
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]10Key concepts in VOLTHA:
11
12- **Network as a Switch**: It makes a set of connected access network devices
13 to look like a SDN programmable switch.
14
15- **Evolution to virtualization**: it can work with a variety of access network
16 technologies and devices
17
18- **Unified OAM abstraction**: it provides unified, vendor- and technology
19 agnostic handling of device management tasks, such as service lifecycle,
20 device lifecycle (including discovery, upgrade), system monitoring, alarms,
21 troubleshooting, security, etc.
22
23- **Cloud/DevOps bridge to modernization**: it does all above while using a
24 microservices architecture running on top of Docker and/or Kubernetes.
25
26VOLTHA is a sub-project of the `Open Networking Foundation's
27<https://www.opennetworking.org>`_ `CORD project
28<https://www.opennetworking.org/cord/>`_.
29
Andrea Campanella71221c82021-02-01 14:40:48 +0100[diff] [blame]30.. figure:: ./_static/voltha_diagram.svg
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]31 :alt: VOLTHA Component Diagram
32 :width: 70%
Andrea Campanella71221c82021-02-01 14:40:48 +0100[diff] [blame]33 :align: center
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]34
35 VOLTHA Component Diagram
36
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]37Here some quick links to get you started:
38
Andrea Campanella71221c82021-02-01 14:40:48 +0100[diff] [blame]39- :doc:`./overview/architecture_overview`
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]40- :doc:`./overview/deployment_environment`
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]41- :doc:`./overview/troubleshooting`
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]42
43Community
44---------
45
Andrea Campanellaaf7db9c2021-07-21 10:04:25 +0200[diff] [blame]46VOLTHA is an open source project led by a technical steering team that holds weekly meetings.
47You can find more information about the TST, community, meetings, mailing lists and slack channels
48in the `VOLTHA wiki page <https://wiki.opennetworking.org/display/COM/VOLTHA>`_
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]49
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]50
51.. toctree::
52 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]53 :caption: Overview
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]54 :hidden:
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]55 :glob:
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]56
Andrea Campanella71221c82021-02-01 14:40:48 +0100[diff] [blame]57 overview/architecture_overview.rst
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]58 overview/deployment_environment.rst
Andrea Campanella882cfcc2021-02-04 10:53:57 +0100[diff] [blame]59 Deploy VOLTHA <voltha-helm-charts/README.md>
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]60 overview/workflows.rst
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]61 overview/operate.rst
Andrea Campanella3c4e5262021-05-18 11:47:57 +0200[diff] [blame]62 overview/lab_setup.rst
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]63 overview/troubleshooting.rst
Andrea Campanellaaf7db9c2021-07-21 10:04:25 +0200[diff] [blame]64 overview/releases.rst
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]65
66.. toctree::
Andrea Campanella4cf8ba02020-01-21 18:01:59 +0100[diff] [blame]67 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]68 :hidden:
69 :caption: Components
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]70
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]71 BBSIM <bbsim/docs/source/index.rst>
72 OpenFlow Agent <ofagent-go/README.md>
73 OpenOlt Adapter <voltha-openolt-adapter/README.md>
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]74 OpenOnu Adapter Go <voltha-openonu-adapter-go/README.md>
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]75 Openolt Agent <openolt/README.md>
76 VOLTHA CLI <voltctl/README.md>
77 VOLTHA Protos <voltha-protos/README.md>
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]78
79.. toctree::
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]80 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]81 :hidden:
Andrea Campanellae0a7e522021-03-26 15:45:48 +0100[diff] [blame]82 :caption: Operations
83
Andrea Campanella448fbc22021-05-13 15:39:00 +0200[diff] [blame]84 operations/software-upgrade.rst
Andrea Campanellace1e0792021-10-15 13:59:10 +0200[diff] [blame^]85 ONU software update <voltha-openonu-adapter-go/docs/ONU_Upgrade_Notes.md>
86 ONU Performance Metrics <voltha-openonu-adapter-go/docs/PM_Notes.md>
Andrea Campanellae0a7e522021-03-26 15:45:48 +0100[diff] [blame]87
88.. toctree::
89 :maxdepth: 1
90 :hidden:
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]91 :caption: Testing
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]92
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]93 VOLTHA system tests <voltha-system-tests/README.md>
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]94 testing/index.rst
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]95
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]96.. toctree::
97 :maxdepth: 1
98 :hidden:
divyadesaia702ba92020-08-31 11:27:46 +0000[diff] [blame]99 :caption: Logging
100
101 logging/centralised_log_analysis.rst
Andrea Campanellace1e0792021-10-15 13:59:10 +0200[diff] [blame^]102 ONU adapter per package logging <voltha-openonu-adapter-go/docs/Specific_Logging_Notes.md>
divyadesaia702ba92020-08-31 11:27:46 +0000[diff] [blame]103
104.. toctree::
105 :maxdepth: 1
106 :hidden:
Andrea Campanella13f26f52021-01-28 13:47:40 +0100[diff] [blame]107 :caption: Device Management Interface
108
109 Overview <device-management-interface/README.md>
110 Image management <device-management-interface/docs/DeviceImageManagement.md>
111 Events and Metrics <device-management-interface/docs/EventsMetrics.md>
112 Managing a device <device-management-interface/docs/ManagingDevice.md>
113 Examples <device-management-interface/docs/Examples.md>
114 Guidelines <device-management-interface/docs/RpcGuidelines.md>
115 Implementation on BBSIM <bbsim/docs/source/DMI_Server_README.md>
116
117.. toctree::
118 :maxdepth: 1
119 :hidden:
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]120 :caption: Releases
121 :glob:
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]122
Zack Williams6ebfe062020-04-09 16:08:29 -0700[diff] [blame]123 release_notes/*