commit	40d2b34951806e978eb8658881fb228d1c073c8f	[log] [tgz]
author	Andrea Campanella <andrea@opennetworking.org>	Fri Feb 04 18:13:37 2022 +0100
committer	Andrea Campanella <andrea@opennetworking.org>	Mon Feb 07 21:16:18 2022 +0100
tree	ffbd1a553f8931af002acc722bed6a7ea08ddea3
parent	0823c9371b0df2509eaa3d6c9ae0a22a86bfa0a8 [diff]

tree: ffbd1a553f8931af002acc722bed6a7ea08ddea3

README.md

org.opencord.org

This ONOS applications is responsible to configure the flows required to manage an OLT Device as reported by VOLTHA.

Configuration

The org.opencord.olt application depends on org.opencord.sadis and exposes the following configuration:

karaf@root > cfg get org.opencord.olt.impl.Olt
org.opencord.olt.impl.Olt
    name=defaultBpId, type=string, value=Default, defaultValue=Default, description=Default bandwidth profile id that is used for authentication trap flows.
    name=flowProcessingThreads, type=integer, value=8, defaultValue=8, description=Number of threads used to process flows.
    name=multicastServiceName, type=string, value=MC, defaultValue=MC, description=Default multicast service name.
    name=requeueDelay, type=integer, value=500, defaultValue=500, description=Delay in ms to put an event back in the queue, used to avoid retrying things to often if conditions are not met.
    name=subscriberProcessingThreads, type=integer, value=8, defaultValue=8, description=Number of threads used to process flows.

karaf@root > cfg get org.opencord.olt.impl.OltFlowService
org.opencord.olt.impl.OltFlowService
    name=enableDhcpOnNni, type=boolean, value=true, defaultValue=false, description=Create DHCP trap flow on NNI port(s).
    name=enablePppoe, type=boolean, value=false, defaultValue=false, description=Send PPPoED authentication trap flows before subscriber provisioning.
    name=defaultTechProfileId, type=integer, value=64, defaultValue=64, description=Default technology profile id that is used for authentication trap flows.
    name=enableIgmpOnNni, type=boolean, value=false, defaultValue=false, description=Create IGMP trap flow on NNI port(s).
    name=enableEapol, type=boolean, value=true, defaultValue=true, description=Send EAPOL authentication trap flows before subscriber provisioning.
    name=enableDhcpV6, type=boolean, value=false, defaultValue=false, description=Enable flows for DHCP v6 if dhcp is required in sadis config.
    name=enableDhcpV4, type=boolean, value=true, defaultValue=true, description=Enable flows for DHCP v4 if dhcp is required in sadis config.
    
karaf@root > cfg get org.opencord.olt.impl.OltMeterService
org.opencord.olt.impl.OltMeterService
    name=deleteMeters, type=boolean, value=true, defaultValue=true, description=Delete meters when reference count drops to zero.

CLI commands

volt-add-subscriber-access                                                           (Adds a subscriber to an access device)
volt-bpmeter-mappings         (Shows information about programmed meters, including the relation with the Bandwidth Profile)
volt-failed-subscribers                                                         (Shows subscribers that failed provisioning)
volt-olts                                                                                    (Shows vOLTs connected to ONOS)
volt-port-status                                    (Shows information about the OLT ports (default EAPOL, subscriber flows)
volt-programmed-meters        (Shows information about programmed meters, including the relation with the Bandwidth Profile)
volt-programmed-subscribers                                                  (Shows subscribers programmed in the dataplane)
volt-remove-subscriber-access                                                        (Adds a subscriber to an access device)
volt-requested-subscribers (Shows subscribers programmed by the operator. Their data-plane status depends on the ONU status)

App Design

The org.opencord.olt application internal structure reflects the following diagram:

OLT App Diagram

Install the app on a running ONOS

Prerequisites
A running ONOS cluster (can be a single node cluster)
ONOS REST APIs exposed out of the kubernetes cluster and reachable from your machine (we used port 30120 in the following example)

If you want to try out the app on a running ONOS cluster you can follow this procedure:

Build the app (requires Java 11 to be installed)
```
mvn clean install
```

Uninstall the current version of the app:

curl --fail -sSL --user karaf:karaf --noproxy 127.0.0.1  -X DELETE http://127.0.0.1:30120/onos/v1/applications/org.opencord.olt

You should see the following confirmation message in the logs:

17:15:39.279 INFO  [ApplicationManager] Application org.opencord.olt has been uninstalled

Install the new version of the app

curl --fail -sSL --user karaf:karaf --noproxy 127.0.0.1  -X POST -HContent-Type:application/octet-stream http://127.0.0.1:30120/onos/v1/applications?activate=true --data-binary @app/target/olt-app-5.0.0.oar

you should see:

17:55:37.197 INFO  [ApplicationManager] Application org.opencord.olt has been activated