HLD template created #670
HLD template created #670
Conversation
doc/hld_template.md
Outdated
|
|
||
| ## Table of Content | ||
|
|
||
| ### 1. Revision |
There was a problem hiding this comment.
Remove the numbers - you have 2 sections 1, 2, and 3.
There was a problem hiding this comment.
I see you removed all the numbers. Note that I'm not averse to numbers - I just want them to be correct/consistent.
doc/hld_template.md
Outdated
|
|
||
| ### 2. Requirements | ||
|
|
||
| This section list out the basic requirements for the HLD coverage and exemptions (not supported) if any for this design. |
There was a problem hiding this comment.
Suggest you remove the word "basic" - we want all the requirements.
doc/hld_template.md
Outdated
|
|
||
| ### 3. Architecture Design | ||
|
|
||
| This section covers the changes that are required in the SONiC architecture and explains how the module/sub-module fits in the architecture. |
There was a problem hiding this comment.
I would hope that this section is empty for most features - we want to avoid architectural changes, right? Most features will use the existing architecture.
There was a problem hiding this comment.
Addressed. It is better if user explains how the new feature/enhancement fits in the current architecture. Added 2 lines to explain this.
doc/hld_template.md
Outdated
|
|
||
| This section covers the high level design of the feature/enhancement. This section covers the following points in detail. | ||
|
|
||
| - What are the modules and sub-modules that are modfiied for this design? |
doc/hld_template.md
Outdated
|
|
||
| This section covers the high level design of the feature/enhancement. This section covers the following points in detail. | ||
|
|
||
| - What are the modules and sub-modules that are modfiied for this design? |
There was a problem hiding this comment.
Fix the typo - "modfiied" - generally I would suggest a spell check
There was a problem hiding this comment.
Ack for this one - I still see one more spelling error below ("distruption")
doc/hld_template.md
Outdated
| - Is this change specific to any platform? Are there dependencies for platforms to implement anything to make this feature work? If yes, explain in detail and inform community in advance. | ||
| - SAI API requirements, CLI requirements, ConfigDB requirements. Design is covered in following sections. | ||
|
|
||
| ### 5. SAI API |
There was a problem hiding this comment.
Should we ask the designer to list the SAI APIs/objects used by the design? This will allow silicon vendors to ensure that they have the required support in their SAI.
There was a problem hiding this comment.
Added a line to explain the same.
| ### 6. CLI Enhancements | ||
|
|
||
| This section covers the addition/deletion/modification of CLI changes needed for the feature in detail. If there is no change in CLI for HLD feature, it should be explicitly mentioned in this section. Note that the CLI changes should ensure downward compatibility with the previous/existing CLI. i.e. Users should be able to save and restore the CLI from previous release even after the new CLI is implemented. | ||
|
|
There was a problem hiding this comment.
Should also cover whether the CLI is Click or Klish (or both)
Generally this section should be up-leveled to "Configuration and Management", and CLI should be a sub-section of this. Other sub-sections would cover Data models (YANG, REST and gNMI
There was a problem hiding this comment.
Added few lines and changed heading levels.
doc/hld_template.md
Outdated
| - Management interfaces - SNMP, CLI, RestAPI, etc., | ||
| - Is this change specific to any platform? Are there dependencies for platforms to implement anything to make this feature work? If yes, explain in detail and inform community in advance. | ||
| - SAI API requirements, CLI requirements, ConfigDB requirements. Design is covered in following sections. | ||
|
|
There was a problem hiding this comment.
Suggest we add something for: -
- Serviceability and Debug (logging, counters, trace etc)
|
OK with me |
| #### Config DB Enhancements | ||
|
|
||
| This sub-section covers the addition/deletion/modification of config DB changes needed for the feature. If there is no change in configuration for HLD feature, it should be explicitly mentioned in this section. This section should also ensure the downward compatibility for the change. | ||
|
|
There was a problem hiding this comment.
Hi @kannankvs
I'm sorry to comment so late but I feel it's better to move the Config DB enhancements to a place ahead of or in the section High-Level Design. Because it's can help the readers of the HLD understand it better if there is a database description ahead of the flows which are described in the HLD.
How do you think?
Thanks,
Stephen
HLD Template for review.