Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docs / a1ee98810efc70ae8ac3f20025553d20d4437b1f / . / index.rst
blob: 60399049d859b82d45f61ddf39e9cb91f33739e7 [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
46Information about participating in the VOLTHA community and development process
Andrea Campanella9a859842021-09-10 12:01:38 +0200[diff] [blame]47can be found on the `VOLTHA section of the opennetworking Wiki
48<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
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]64
65.. toctree::
Andrea Campanella4cf8ba02020-01-21 18:01:59 +0100[diff] [blame]66 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]67 :hidden:
68 :caption: Components
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]69
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]70 BBSIM <bbsim/docs/source/index.rst>
71 OpenFlow Agent <ofagent-go/README.md>
72 OpenOlt Adapter <voltha-openolt-adapter/README.md>
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]73 OpenOnu Adapter Go <voltha-openonu-adapter-go/README.md>
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]74 Openolt Agent <openolt/README.md>
75 VOLTHA CLI <voltctl/README.md>
76 VOLTHA Protos <voltha-protos/README.md>
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]77
78.. toctree::
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]79 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]80 :hidden:
Andrea Campanellae0a7e522021-03-26 15:45:48 +0100[diff] [blame]81 :caption: Operations
82
Andrea Campanella448fbc22021-05-13 15:39:00 +0200[diff] [blame]83 operations/software-upgrade.rst
Andrea Campanellae0a7e522021-03-26 15:45:48 +0100[diff] [blame]84 ONU software update <voltha-openonu-adapter-go/ONU_Upgrade_Notes.md>
85 ONU Performance Metrics <voltha-openonu-adapter-go/PM_Notes.md>
86
87.. toctree::
88 :maxdepth: 1
89 :hidden:
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]90 :caption: Testing
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]91
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]92 VOLTHA system tests <voltha-system-tests/README.md>
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]93 testing/index.rst
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]94
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]95.. toctree::
96 :maxdepth: 1
97 :hidden:
divyadesaia702ba92020-08-31 11:27:46 +0000[diff] [blame]98 :caption: Logging
99
100 logging/centralised_log_analysis.rst
101
102.. toctree::
103 :maxdepth: 1
104 :hidden:
Andrea Campanella13f26f52021-01-28 13:47:40 +0100[diff] [blame]105 :caption: Device Management Interface
106
107 Overview <device-management-interface/README.md>
108 Image management <device-management-interface/docs/DeviceImageManagement.md>
109 Events and Metrics <device-management-interface/docs/EventsMetrics.md>
110 Managing a device <device-management-interface/docs/ManagingDevice.md>
111 Examples <device-management-interface/docs/Examples.md>
112 Guidelines <device-management-interface/docs/RpcGuidelines.md>
113 Implementation on BBSIM <bbsim/docs/source/DMI_Server_README.md>
114
115.. toctree::
116 :maxdepth: 1
117 :hidden:
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]118 :caption: Releases
119 :glob:
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]120
Zack Williams6ebfe062020-04-09 16:08:29 -0700[diff] [blame]121 release_notes/*