OCP Plugin: Boron: Release Plan

Owned by Manish Kumar Barnwal
Aug 23, 2021

Contents

Introduction

Release Deliverables

NameDescription
Clean Up Existing CodeClean up existing code and make available to project team members
OCP Elementary FunctionsHandling of OCP request/response messages for the following OCP elementary functions:
  1. Device Management: Health Check, Set Time, RE Reset
  2. Config Management: Object Parameter Reporting, Object Parameter Modification
  3. Object Lifecycle: Object Creation, Object Deletion
  4. Object State Management: Object State Reporting, Object State Modification
  5. Fault Management: Fault Reporting
Spontaneous IndicationHandling of OCP indication messages (terminated at Southbound without further propagation)
RE Resource ModelHosted in the MD-SAL Data Store (accessible via RESTCONF)
MD-SAL NotificationsPublishes the device-connected, device-disconnected and alignment-completed notifications
Supported VersionSupport for OCP v4.1.1
Unit TestsUnit test to achieve 80% line coverage and 60% branch coverage
Karaf FeaturesOCP Plugin and OCP Protocol Library installable as karaf features
DocumentationAll required documentation

Release Milestones

MilestoneOffset 1 DateDeliverables
M13/17/2016
NameStatusDescription
Candidate Release PlanDoneCandidate Release Plan
M24/21/2016
NameStatusDescription
Release PlanDoneFinal Release Plan
Project setupDoneProject setup in Git and Jenkins
Code Clean upDoneClean up existing code and put into Git
Define Resource ModelDoneDefine the Resource Model objects to be supported
M35/19/2016
NameStatusDescription
Functionality FreezeDoneAll project functionality declared
M46/16/2016
NameStatusDescription
API FreezeDoneAll external APIs are defined and reviewed
Resource Model definedDoneAll Resource Model objects to be supported are defined and reviewed
OCP Elementary Function, Indication and Notification completeDoneOCP Elementary Function, Indication and Notification functionality coded and some testing performed
Code availableDoneMake services available to interested developers, if any
Karaf integrationDoneOCP Plugin and OCP Protocol Library as Karaf features
Documentation Plan completeDoneDefine documentation set and who will write first drafts
Define Test planDoneDefine test plans for unit, system and integration tests
M57/21/2016
NameStatusDescription
Code FreezeDoneCode complete, only bug fixes going forward
First Draft of DocumentationDoneFirst draft of documentation set complete and reviewed by all committers
Unit tests completeDoneAll unit test complete and code coverage goals met
Integration and System Tests completeDoneAll integration and System tests complete and participating in continuous integration tests
RC0N/A
NameStatusDescription
Documentation completeDoneDocumentation complete and reviewed
All critical defects resolvedDoneAll "show-stopper" defects resolved, all other defects agreed to as not critical
RC1N/A
NameDescription
Bug fixingFixing only critical defects since RC0
RC2N/A
NameDescription
Bug fixingFixing only critical defects since RC1
RC3N/A
NameDescription
Release ReviewRelease Review
Formal ReleaseN/A
NameDescription
OCP Plugin ReleaseOCP Resource Model, Elementary Functions, Indications, Notifications supported

Externally Consumable APIs

APIAPI StatusShort description
health-checkStableThe Health Check procedure allows the application to verify that the OCP layer is functioning correctly at the RE.
set-timeStableThe Set Time procedure allows the application to set/update the absolute time reference that shall be used by the RE.
re-resetStableThe RE Reset procedure allows the application to reset a specific RE.
get-paramStableThe Object Parameter Reporting procedure allows the application to retrieve the following information:
  1. the defined object types and instances within the Resource Model of the RE
  2. the values of the parameters of the objects
modify-paramStableThe Object Parameter Modification procedure allows the application to configure the values of the parameters of the objects identified by the Resource Model.
create-objStableThe Object Creation procedure allows the application to create and initialize a new instance of the given object type on the RE.
delete-objStableThe Object Deletion procedure allows the application to delete a given object instance and recursively its entire child objects on the RE.
get-stateStableThe Object State Reporting procedure allows the application to acquire the current state (for the requested state type) of one or more objects of the RE resource model, and additionally configure event-triggered reporting of the detected state changes for all state types of the indicated objects.
modify-stateStableThe Object State Modification procedure allows the application to trigger a change in the state of an object of the RE Resource Model.
get-faultStableThe Fault Reporting procedure allows the application to acquire information about all current active faults associated with a primary object, as well as configure the RE to report when the fault status changes for any of faults associated with the indicated primary object.

Expected Dependencies on Other Projects

  • ODL Parent
  • MD-SAL
  • YANG Tools
  • Controller

Expected Incompatibilities with Other Projects

None

Compatibility with Previous Releases

N/A

Themes and Priorities

None

Requests from Other Projects

None

Test Tool Requirements

  • Testing is done in form of Java unit tests and integration tests, no requirements on infrastructure except Maven. Reporting is provided by Jenkins.

Other

None