voltha

module
Version: v0.0.0-...-0f31291 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2020 License: Apache-2.0

README

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.

Directories

Path Synopsis
envoy
go/envoyd
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
netopeer
voltha-grpc-client
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
voltha-grpc-client/voltha
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/adapter
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/common
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/device
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/events
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/health
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/logical_device
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/meta
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/openflow_13
Package openflow_13 is a generated protocol buffer package.
Package openflow_13 is a generated protocol buffer package.
voltha-grpc-client/voltha/ponsim
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-grpc-client/voltha/schema
Package schema is a generated protocol buffer package.
Package schema is a generated protocol buffer package.
voltha-grpc-client/voltha/yang_options
Package voltha is a generated protocol buffer package.
Package voltha is a generated protocol buffer package.
voltha-netconf-model
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
ponsim
v2
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
v2/common
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
v2/core
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
v2/grpc
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
v2/grpc/nbi
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
v2/grpc/sbi
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
* Copyright 2017-present Open Networking Foundation * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
This micro-service provides an ONOS cluster manager capability to enable dynamic cluster configuration with in container orchestration environments.
This micro-service provides an ONOS cluster manager capability to enable dynamic cluster configuration with in container orchestration environments.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL