Title of the feature 

[link to gerrit patch]

Brief introduction of the feature.

Problem description 

Detailed description of the problem being solved by this feature

Proposed change 

Details of the proposed change.

Yang changes 

This should detail any changes to yang models.

Configuration impact 

Any configuration parameters being added/deprecated for this feature? What will be defaults for these? How will it impact existing deployments?

Note that outright deletion/modification of existing configuration is not allowed due to backward compatibility. They can only be deprecated and deleted in later release(s).

Clustering considerations 

This should capture how clustering will be supported. This can include but not limited to use of CDTCL, EOS, Cluster Singleton etc.

Other Infra considerations 

This should capture impact from/to different infra components like MDSAL Datastore, karaf, AAA etc.

Security considerations 

Document any security related issues impacted by this feature.

Scale and Performance Impact 

What are the potential scale and performance impacts of this change? Does it help improve scale and performance or make it worse?

Targeted Release 

What release is this feature targeted for?

Alternatives 

Alternatives considered and why they were not selected.

Usage 

How will end user use this feature? Primary focus here is how this feature will be used in an actual deployment.

For most InfraUtils features users will be other projects but this should still capture any user visible CLI/API etc. e.g. Counters

This section will be primary input for Test and Documentation teams. Along with above this should also capture REST API and CLI.

Identify existing karaf feature to which this change applies and/or new karaf features being introduced. These can be user facing features which are added to integration/distribution or internal features to be used by other projects.

REST API 

Sample JSONS/URIs. These will be an offshoot of yang changes. Capture these for User Guide, unit tests etc.

CLI 

Any CLI if being added.

Implementation 

Assignee(s)

Who is implementing this feature? In case of multiple authors, designate a primary assigne and other contributors.

Primary assignee:: <developer-a>
Other contributors:: <developer-b> <developer-c>

Work Items 

Break up work into individual items. This should be a checklist on Trello card for this feature. Give link to trello card or duplicate it.

Dependencies 

Any dependencies being added/removed? Dependencies here refers to internal [other ODL projects] as well as external [OVS, karaf, JDK etc.] This should also capture specific versions if any of these dependencies. e.g. OVS version, Linux kernel version, JDK etc.

This should also capture impacts on existing project that depend on InfraUtils. Following projects currently depend on Infrautils: * Netvirt * GENIUS

Links to Summit presentation, discussion etc.
Links to mail list discussions
Links to patches in other projects
Links to external documentation

[1] OpenDaylight Documentation Guide

[2] https://specs.openstack.org/openstack/nova-specs/specs/kilo/template.html

Note

This template was derived from [2], and has been modified to support our project.

This work is licensed under a Creative Commons Attribution 3.0 Unported License. http://creativecommons.org/licenses/by/3.0/legalcode