Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docs / 61fd666589c096e441be792fe82453eb8596cf90 / . / index.rst
blob: c1c9d01a388ac335443d3dad8fd3c62b80263983 [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
36
37Community
38---------
39
40Information about participating in the VOLTHA community and development process
41can be found on the `VOLTHA section of the CORD Wiki
42<https://wiki.opencord.org/display/CORD/VOLTHA>`_.
43
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]44
45.. toctree::
46 :maxdepth: 1
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]47 :caption: Overview
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]48 :hidden:
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]49 :glob:
Matteo Scandolo1f5530b2019-12-17 10:12:31 -0800[diff] [blame]50
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]51 overview/*
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]52 readme
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame^]53 VOLTHA Deployment Tool (kind-voltha) <kind-voltha/README.md>
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]54
55.. toctree::
Andrea Campanella4cf8ba02020-01-21 18:01:59 +0100[diff] [blame]56 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]57 :hidden:
58 :caption: Components
Zack Williamse377eae2019-12-20 16:40:38 -0700[diff] [blame]59
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame^]60 BBSIM <bbsim/docs/source/index.rst>
61 OpenFlow Agent <ofagent-go/README.md>
62 OpenOlt Adapter <voltha-openolt-adapter/README.md>
63 Openolt Agent <openolt/README.md>
64 VOLTHA CLI <voltctl/README.md>
65 VOLTHA Protos <voltha-protos/README.md>
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]66
67.. toctree::
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]68 :maxdepth: 1
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]69 :hidden:
70 :caption: Testing
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]71
Andrea Campanella61fd6662020-07-27 16:56:55 +0200[diff] [blame^]72 VOLTHA system tests <voltha-system-tests/README.md>
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]73 testing/index.rst
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]74
Zack Williams16042b62020-03-29 22:03:16 -0700[diff] [blame]75.. toctree::
76 :maxdepth: 1
77 :hidden:
78 :caption: Releases
79 :glob:
Zack Williams071eda22019-05-15 18:19:51 -0700[diff] [blame]80
Zack Williams6ebfe062020-04-09 16:08:29 -0700[diff] [blame]81 release_notes/*