Gitiles
Code Review Sign In
gerrit.opencord.org / voltha / bee8f42bc2717aa1e2592230cd0264d3206f00d0
commitbee8f42bc2717aa1e2592230cd0264d3206f00d0[log] [tgz]
authorMatteo Scandolo <matteo.scandolo@gmail.com>Fri Nov 22 17:36:35 2019 -0800
committerMatteo Scandolo <matteo.scandolo@gmail.com>Fri Nov 22 17:36:37 2019 -0800
tree40004a66c8cfb3b18f97c4caf52e9cbc44a69b11
parent9cb00a7b515389132730ae7f7f41c993e54e971e [diff]
Adding Code of Conduct

Change-Id: Ie276dff8c28f365b0ca27dba2452abb6cfce1c87
1 file changed
tree: 40004a66c8cfb3b18f97c4caf52e9cbc44a69b11
  1. .dockerignore
  2. .gitignore
  3. .gitreview
  4. BUILD.md
  5. BuildingVolthaUsingVagrantOnKVM.md
  6. CODE_OF_CONDUCT.md
  7. DOCKER_BUILD.md
  8. GettingStartedLinux.md
  9. Jenkinsfile
  10. LICENSE.txt
  11. Makefile
  12. README.md
  13. TODO.md
  14. Vagrantfile
  15. alarm-generator/
  16. ansible/
  17. cli/
  18. common/
  19. compose/
  20. consul_config/
  21. dashd/
  22. docker/
  23. docs/
  24. env.sh
  25. envoy/
  26. experiments/
  27. fluentd_config/
  28. install/
  29. k8s/
  30. kafka/
  31. netconf/
  32. netopeer/
  33. nginx_config/
  34. obsolete/
  35. ofagent/
  36. pki/
  37. ponsim/
  38. portainer/
  39. reg_config/
  40. requirements.txt
  41. scripts/
  42. settings.vagrant.nightly-docker.yaml
  43. settings.vagrant.nightly.yaml
  44. settings.vagrant.yaml
  45. setup.mk
  46. setup.py
  47. shovel/
  48. tests/
  49. tmp_integration.md
  50. unum/
  51. vagrant-base/
  52. voltha/
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?

While we are still at the early phase of development, you can 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.

Contributing Unit Tests

To begin, make sure to have a development environement installed according to the OpenCord WIKI. Next, In a shell environment

source env.sh;             # Source the environment Settings and create a virtual environment
make utest-with-coverage;  # Execute the Unit Test with coverage reporting

Unit-testing the Core

New unit tests for the core can be written in the nosetest framework and can be found under /tests/utest/

Unit-testing an Adapter

Each adapter's unit tests are discovered by the presence of a test.mk submake file underneath the adapter's directory. for example)

# voltha/adapters/my_new_adapter/test.mk

.PHONY test
test:
   @echo "Testing my amazing new adapter"
   @./my_test_harness

Voltha's test framework will execute the FIRST Target in the submake file as the unit test function. It may include as many dependencies as needed, such as using a different python framework for testing (pytest, unittest, tox) or even alternate languages (go, rust, php).

In order for you adapter's test-coverage to be reported, make sure that your test_harness creates a coverage report in a junit xml format. Most test harnesses can easily produce this report format. The Jenkins Job will pick up your coverage report file if named appropriately junit-report.xml according to the Jenkins configuration.