tag	3b4624d1b19d98937dba19e31db502f7ca56a1ab
tagger	Jenkins <do-not-reply@opencord.org>	Tue Nov 27 07:08:00 2018 +0000
object	0b4ad93a99c7efcb2f0e926ebbaf45c2799054e2

commit	0b4ad93a99c7efcb2f0e926ebbaf45c2799054e2	[log] [tgz]
author	Scott Baker <smbaker@gmail.com>	Mon Nov 26 15:02:13 2018 -0800
committer	Scott Baker <smbaker@gmail.com>	Mon Nov 26 15:36:09 2018 -0800
tree	a544d154198d4fbe25b2edd3cc84b36a0152ce4e
parent	0ee55d0aace3caf963d5844384bf4ef9cb5cf180 [diff]

tree: a544d154198d4fbe25b2edd3cc84b36a0152ce4e

README.md

AT&T Workflow Driver

This service implements the ONU and Subscriber management logic required by AT&T. It's also a good start if you need to implement a different logic to suit your use-case.

NOTE: This service depends on RCORDSubscriber and ONUDevice so make sure that the rcord-synchronizer and volt-synchronzier are running

How to install this service

Make sure you have xos-core, rcord-lite and kafka running.

To install from master:

helm install -n att-workflow xos-services/att-workflow-driver/

To install from the local docker daemon in minikube:

helm install -n att-workflow xos-services/att-workflow-driver/ -f examples/image-tag-candidate.yaml -f examples/imagePullPolicy-IfNotPresent.yaml

Service Instances State Machine

Topic	Event	Actions	ONU State	Subscriber State	Message
`onu.events`	`status: activated`	Validate against whitelist (successful)	enabled	awaiting-auth	ONU has been validated
`onu.events`	`status: activated`	Validate against whitelist (failed, missing)	disabled	awaiting-auth	ONU not found in whitelist
`onu.events`	`status: activated`	Validate against whitelist (failed, location)	disabled	awaiting-auth	ONU activated in wrong location
`onu.events`	`status: disabled`	Mark ONU as disabled and revoke subscriber authentication	disabled	awaiting-auth	ONU has been disabled, revoked subscriber authentication
`authentication.events`	`authenticationState: STARTED`	Update subscriber status	enabled	awaiting-auth	Authentication started
`authentication.events`	`authenticationState: REQUESTED`	Update subscriber status	enabled	awaiting-auth	Authentication requested
`authentication.events`	`authenticationState: APPROVED`	Update subscriber status	enabled	enabled	Authentication succeded
`authentication.events`	`authenticationState: DENIED`	Update subscriber status	enabled	auth-failed	Authentication denied
`dhcp.events`	--	Update subscriber ip and mac address	enabled	enabled	DHCP information added

Events format

This events are generated by various applications running on top of ONOS and published on a Kafka bus. Here is the structure of the events and their topics.

onu.events

{
  "timestamp": "2018-09-11T01:00:49.506Z",
  "status": "activated", // or disabled
  "serial_number": "ALPHe3d1cfde", // ONU serial number
  "uni_port_id": 16, // uni port 
  "of_dpid": "of:000000000a5a0072" // OLT OpenFlow Id
}

authentication.events

{
  "timestamp": "2018-09-11T00:41:47.483Z",
  "deviceId": "of:000000000a5a0072", // OLT OpenFlow Id
  "portNumber": "16", // uni port
  "authenticationState": "STARTED" // REQUESTED, APPROVED, DENIED
}

dhcp.events

{
  "deviceId" : "of:000000000a5a0072",
  "portNumber" : "16",
  "macAddress" : "90:e2:ba:82:fa:81",
  "ipAddress" : "10.11.1.1"
}