OCP Plugin: Boron: Release Plan

OCP Plugin: Boron: Release Plan

Contents

Introduction

Release Deliverables

Name

Description

Name

Description

Clean Up Existing Code

Clean up existing code and make available to project team members

OCP Elementary Functions

Handling 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 Indication

Handling of OCP indication messages (terminated at Southbound without further propagation)

RE Resource Model

Hosted in the MD-SAL Data Store (accessible via RESTCONF)

MD-SAL Notifications

Publishes the device-connected, device-disconnected and alignment-completed notifications

Supported Version

Support for OCP v4.1.1

Unit Tests

Unit test to achieve 80% line coverage and 60% branch coverage

Karaf Features

OCP Plugin and OCP Protocol Library installable as karaf features

Documentation

All required documentation

Release Milestones

Milestone

Offset 1 Date

Deliverables

Milestone

Offset 1 Date

Deliverables

M1

3/17/2016





M2

4/21/2016





M3

5/19/2016





M4

6/16/2016





M5

7/21/2016





RC0

N/A





RC1

N/A





RC2

N/A





RC3

N/A





Formal Release

N/A





Externally Consumable APIs

API

API Status

Short description

API

API Status

Short description

health-check

Stable

The Health Check procedure allows the application to verify that the OCP layer is functioning correctly at the RE.

set-time

Stable

The Set Time procedure allows the application to set/update the absolute time reference that shall be used by the RE.

re-reset

Stable

The RE Reset procedure allows the application to reset a specific RE.

get-param

Stable

The 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-param

Stable

The Object Parameter Modification procedure allows the application to configure the values of the parameters of the objects identified by the Resource Model.

create-obj

Stable

The Object Creation procedure allows the application to create and initialize a new instance of the given object type on the RE.

delete-obj

Stable

The Object Deletion procedure allows the application to delete a given object instance and recursively its entire child objects on the RE.

get-state

Stable

The 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-state

Stable

The Object State Modification procedure allows the application to trigger a change in the state of an object of the RE Resource Model.

get-fault

Stable

The 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