Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-go / 125f8032890a385b5f6b3c4d7d3e5d827fb0a686
commit125f8032890a385b5f6b3c4d7d3e5d827fb0a686[log] [tgz]
authorJoey Armstrong <jarmstrong@linuxfoundation.org>Wed May 01 16:20:11 2024 -0400
committerJoey Armstrong <joey@opennetworking.org>Wed May 01 21:06:33 2024 +0000
tree092e2de26c39e0e8e2466aeb298ad5be1aa742da
parentf8a00bf19fc9f576b9bb635189d74bb6e9c13c56 [diff]
[VOL-5297] Install pypi module:pre-commit

[VOL-5335] - voltha-sanity failure, TT E2E ping test

howto/code/lint/pre-commit.rst
------------------------------
  o Document makefile convenience target pre-commit.

Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Change-Id: Id33e5ac259ed5634e5951fd7938f1528eddaf72f
2 files changed
tree: 092e2de26c39e0e8e2466aeb298ad5be1aa742da
  1. .gitignore
  2. .gitreview
  3. .golangci.yml
  4. .pre-commit-config.yaml
  5. BUILD.md
  6. CODE_OF_CONDUCT.md
  7. Makefile
  8. README.md
  9. VERSION
  10. compose/
  11. config.mk
  12. db/
  13. docker/
  14. go.mod
  15. go.sum
  16. makefiles/
  17. quickstart.md
  18. requirements.txt
  19. rw_core/
  20. vendor/
README.md

VOLTHA

What is Voltha?

Voltha aims to provide a layer of abstraction on top of legacy and next generation access network equipment for the purpose of control and management. Its initial focus is on PON (GPON, EPON, NG PON 2), but it aims to go beyond to eventually cover other access technologies (xDSL, Docsis, G.FAST, dedicated Ethernet, fixed wireless).

Key concepts of Voltha:

  • Network as a Switch: It makes a set of connected access network devices to look like a(n abstract) programmable flow device, a L2/L3/L4 switch. Examples:
    • PON as a Switch
    • PON + access backhaul as a Switch
    • xDSL service as a Switch
  • Evolution to virtualization: it can work with a variety of (access) network technologies and devices, including legacy, fully virtualized (in the sense of separation of hardware and software), and in between. Voltha can run on a decice, on general purpose servers in the central office, or in data centers.
  • Unified OAM abstraction: it provides unified, vendor- and technology agnostic handling of device management tasks, such as service lifecycle, device lifecycle (including discovery, upgrade), system monitoring, alarms, troubleshooting, security, etc.
  • Cloud/DevOps bridge to modernization: it does all above while also treating the abstracted network functions as software services manageable much like other software components in the cloud, i.e., containers.

Why Voltha?

Control and management in the access network space is a mess. Each access technology brings its own bag of protocols, and on top of that vendors have their own interpretation/extension of the same standards. Compounding the problem is that these vendor- and technology specific differences ooze way up into the centralized OSS systems of the service provider, creating a lot of inefficiencies.

Ideally, all vendor equipment for the same access technology should provide an identical interface for control and management. Moreover, there shall be much higher synergies across technologies. While we wait for vendors to unite, Voltha provides an increment to that direction, by confining the differences to the locality of access and hiding them from the upper layers of the OSS stack.

How can you work with Voltha?

You can start by reading the published documentation.
Another great way is to check out the BUILD.md file to see how you can build it, run it, test it, etc.

How can you help?

Contributions, small and large, are welcome. Minor contributions and bug fixes are always welcome in form of pull requests. For larger work, the best is to check in with the existing developers to see where help is most needed and to make sure your solution is compatible with the general philosophy of Voltha. Please check out the contributing page on the documentation.