Table of Contents
[link to gerrit patch]
Brief introduction of the feature.
Detailed description of the problem being solved by this feature
Details of the proposed change.
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).
This should capture how clustering will be supported. This can include but not limited to use of CDTCL, EOS, Cluster Singleton etc.
This should capture impact from/to different infra components like MDSAL Datastore, karaf, AAA etc.
What are the potential scale and performance impacts of this change? Does it help improve scale and performance or make it worse?
How will end user use this feature? Primary focus here is how this feature will be used in an actual deployment.
For most Genius features users will be other projects but this should still capture any user visible CLI/API etc. e.g. ITM configuration.
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.
Sample JSONS/URIs. These will be an offshoot of yang changes. Capture these for User Guide, CSIT, etc.
Who is implementing this feature? In case of multiple authors, designate a primary assignee and other contributors.
- Primary assignee:
- Other contributors:
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 Genius. Following projects currently depend on Genius: * Netvirt * SFC
Capture details of testing that will need to be added.
What is impact on documentation for this change? If documentation change is needed call out one of the <contributors> who will work with Project Documentation Lead to get the changes done.
Don’t repeat details already discussed but do reference and call them out.
Add any useful references. Some examples:
Links to Summit presentation, discussion etc.
Links to mail list discussions
Links to patches in other projects
Links to external documentation
This template was derived from , 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