Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
...
Provides the following API to applications
void CreateGroup(Device, GroupType, Collection<GroupBuckets>, GroupKey, appid)
Group GetGroup(Device, GroupKey)
void AddBucketsToGroup(Device, OldGroupKey, Collection<GroupBuckets>, NewGroupKey, appid)
void RemoveBucketsFromGroup(Device, OldGroupKey, Collection<GroupBuckets>, NewGroupKey, appid)
- void RemoveGroup(Device, GroupKey, appid)
- GetAllGroups(Device, appid)
GetAllGroupStatistics(Device, appid)
DataModel
Group Types to be supported
Select
Indirect
All
Failover
Key
An application specific cookie that supports Hash and Equals method
Id
Integer
Bucket
One or more collection of Traffic Instructions
Group Manager
...
This component implements the Group Service
...
interface by defining Group create/modify/remove/query operations
...
on devices.
If the Master for the device is local instance, then the operations are performed locally. If the device is not under the current controller instance,
...
this component send GROUP_ADD_REQUEST to the master controller instance of that device.
GroupId generation
...
Group ID space is per device.
...
Maintains monotonically increasing Group ID
...
number space for each device that will be incremented every time a new group is created.
...
Group Store replicates any changes to per device Group ID to all instances in the cluster, so that any instance in the cluster can generate a Group ID for a device even if it is not master.
Creates the groups only if the device doesn’t have those groups populated. If group already exists, the
...
create APIs doesn't perform any operation.
Group AUDIT
As shown in the below figure, Group Manager perform a AUDIT whenever a device connects to current controller instance as Master. During the Group AUDIT, no group operations can be supported.
Group Store
Group Store handles the distribution functionality of Group subsystem. Based on the design decision, the
...
Maintains monotonically increasing Group ID number space for each device
...
ONOS Group construct/object:
...
Group Store replicates the Groups to
...
either all instances or to a subset of instances.
Group Store will have authoritative role. i.e.
...
When a Device is connected to the controller as a Master,
...
Group Store will wipe off all extraneous groups in the device and inserts if any groups are missing.
High level flow of events in the Group subsystem is depicted below when an operation like CreateGroup is submitted by the application.
Group AUDIT
...
Multi-instance Support
TODO
...