Skip to content

Blueprint Format

Jump to bottom
Rudra Rugge edited this page Nov 16, 2016 · 8 revisions

#1. Introduction ####Purpose of the document

#2. Problem statement ####Describe the problem being solved for a new or existing features. ####Use cases

#3. Proposed solution ####Describe the proposed solution.

##3.1 Alternatives considered ####Describe pros and cons of alternatives considered.

##3.2 API schema changes ####Describe api schema changes and impact to the REST APIs.

##3.3 User workflow impact ####Describe how users will use the feature.

##3.4 UI changes ####Describe any UI changes

##3.5 Operations and Notification impact ####Describe how to operate the feature ####Describe operational impact ####Describe any log, UVE, alarm changes

#4. Implementation ##4.1 Assignee(s) ####List dev and test assignments

##4.2 Work items ####Describe changes needed for different components such as Controller, Analytics, Agent, UI. ####Add subsections as needed.

#5. Performance and scaling impact ##5.1 API and control plane ####Scaling and performance for API and control plane

##5.2 Forwarding performance ####Scaling and performance for API and forwarding

#6. Upgrade ####Describe upgrade impact of the feature ####Schema migration/transition

#7. Deprecations ####If this feature deprecates any older feature or API then list it here.

#8. Dependencies ####Describe dependent features or components.

#9. Testing ##9.1 Unit tests ##9.2 Dev tests ##9.3 System tests

#10. Documentation Impact

#11. References

Clone this wiki locally