Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docs / 1418e84e5ddc5e0a4fc85e73cec21c43ea41c450 / . / index.rst
blob: d698cbd5bbc4bb8887053d3bba9b890ba12f4c9d [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
30.. figure:: ./_static/voltha_components.svg
31 :alt: VOLTHA Component Diagram
32 :width: 70%
33
34 VOLTHA Component Diagram
35
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]36Here some quick links to get you started:
37
38- :doc:`./overview/deployment_environment`
39- :doc:`./overview/workflows`
40- :doc:`./overview/quickstart`
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
47can be found on the `VOLTHA section of the CORD Wiki
48<https://wiki.opencord.org/display/CORD/VOLTHA>`_.
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
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]57 overview/deployment_environment.rst
58 overview/workflows.rst
59 overview/quickstart.rst
60 overview/operate.rst
61 overview/troubleshooting.rst
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]62 readme
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]63
64.. toctree::
Andrea Campanella4cf8ba02020-01-21 18:01:59 +0100[diff] [blame]65 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]66 :hidden:
67 :caption: Components
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]68
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]69 BBSIM <bbsim/docs/source/index.rst>
70 OpenFlow Agent <ofagent-go/README.md>
71 OpenOlt Adapter <voltha-openolt-adapter/README.md>
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]72 OpenOnu Adapter <voltha-openonu-adapter/README.md>
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>
Matteo Scandoloef5d6f42020-07-27 16:46:38 -0700[diff] [blame]77 Kind-voltha <kind-voltha/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:
82 :caption: Testing
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]83
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame]84 VOLTHA system tests <voltha-system-tests/README.md>
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]85 testing/index.rst
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]86
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]87.. toctree::
88 :maxdepth: 1
89 :hidden:
divyadesaia702ba92020-08-31 11:27:46 +0000[diff] [blame]90 :caption: Logging
91
92 logging/centralised_log_analysis.rst
93
94.. toctree::
95 :maxdepth: 1
96 :hidden:
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]97 :caption: Releases
98 :glob:
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]99
Zack Williams6ebfe062020-04-09 16:08:29 -0700[diff] [blame]100 release_notes/*