Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docs / 71221c817a1e93edae411401bc5476fdce17b3b9 / . / index.rst
blob: 646f32012473810609b9cede1d0713ebbef0aad3 [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`
41- :doc:`./overview/workflows`
42- :doc:`./overview/quickstart`
43- :doc:`./overview/troubleshooting`
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]44
45Community
46---------
47
48Information about participating in the VOLTHA community and development process
49can be found on the `VOLTHA section of the CORD Wiki
50<https://wiki.opencord.org/display/CORD/VOLTHA>`_.
51
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]52
53.. toctree::
54 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]55 :caption: Overview
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]56 :hidden:
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]57 :glob:
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]58
Andrea Campanella71221c82021-02-01 14:40:48 +0100[diff] [blame^]59 overview/architecture_overview.rst
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]60 overview/deployment_environment.rst
61 overview/workflows.rst
62 overview/quickstart.rst
63 overview/operate.rst
64 overview/troubleshooting.rst
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]65 readme
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]66
67.. toctree::
Andrea Campanella4cf8ba02020-01-21 18:01:59 +0100[diff] [blame]68 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]69 :hidden:
70 :caption: Components
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]71
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]72 BBSIM <bbsim/docs/source/index.rst>
73 OpenFlow Agent <ofagent-go/README.md>
74 OpenOlt Adapter <voltha-openolt-adapter/README.md>
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]75 OpenOnu Adapter Go <voltha-openonu-adapter-go/README.md>
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]76 Openolt Agent <openolt/README.md>
77 VOLTHA CLI <voltctl/README.md>
78 VOLTHA Protos <voltha-protos/README.md>
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]79 Kind-voltha <kind-voltha/README.md>
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]80
81.. toctree::
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]82 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]83 :hidden:
84 :caption: Testing
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]85
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]86 VOLTHA system tests <voltha-system-tests/README.md>
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]87 testing/index.rst
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]88
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]89.. toctree::
90 :maxdepth: 1
91 :hidden:
divyadesaia702ba92020-08-31 11:27:46 +0000[diff] [blame]92 :caption: Logging
93
94 logging/centralised_log_analysis.rst
95
96.. toctree::
97 :maxdepth: 1
98 :hidden:
Andrea Campanella13f26f52021-01-28 13:47:40 +0100[diff] [blame]99 :caption: Device Management Interface
100
101 Overview <device-management-interface/README.md>
102 Image management <device-management-interface/docs/DeviceImageManagement.md>
103 Events and Metrics <device-management-interface/docs/EventsMetrics.md>
104 Managing a device <device-management-interface/docs/ManagingDevice.md>
105 Examples <device-management-interface/docs/Examples.md>
106 Guidelines <device-management-interface/docs/RpcGuidelines.md>
107 Implementation on BBSIM <bbsim/docs/source/DMI_Server_README.md>
108
109.. toctree::
110 :maxdepth: 1
111 :hidden:
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]112 :caption: Releases
113 :glob:
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]114
Zack Williams6ebfe062020-04-09 16:08:29 -0700[diff] [blame]115 release_notes/*