Skip to content

Commit 583a4b1

Browse files
committed
WIP: add Configuration requirement
1 parent 76cf405 commit 583a4b1

1 file changed

Lines changed: 32 additions & 7 deletions

File tree

doc/fpmsyncd/hld_fpmsyncd-NTT.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,15 @@
2727
- [Backward compatibility with current NHG creation logic (Fine-grain NHG, Ordered NHG/ECMP)](#backward-compatibility-with-current-nhg-creation-logic-fine-grain-nhg-ordered-nhgecmp)
2828
- [nexthop\_compat\_mode Kernel option](#nexthop_compat_mode-kernel-option)
2929
- [Warmboot/Fastboot support](#warmbootfastboot-support)
30+
- [No support for setting config enable/disable on runtime](#no-support-for-setting-config-enabledisable-on-runtime)
3031

3132
### Revision
3233

3334
| Rev | Date | Author | Change Description |
3435
| :---: | :----------: | :------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3536
| 0.1 | Jul 14, 2023 | Kanji Nakano, Kentaro Ebisawa, Hitoshi Irino (NTT) | Initial version |
3637
| 0.2 | Jul 30, 2023 | Kentaro Ebisawa (NTT) | Remove description about VRF which is not nessesary for NHG. Add High Level Architecture diagram. Add note related to libnl, Routing WG. Fix typo and improve explanations. |
37-
| 0.3 | Sep 18, 2023 | Kentaro Ebisawa (NTT) | Update based on discussion at Routing WG on Sep 14th (Scope, Warmboot/Fastboot) |
38+
| 0.3 | Sep 18, 2023 | Kentaro Ebisawa (NTT) | Update based on discussion at Routing WG on Sep 14th (Scope, Warmboot/Fastboot, CONFIG_DB) |
3839

3940
### Scope
4041

@@ -238,9 +239,6 @@ The end result of what gets programmed via SAI will be the same as current imple
238239

239240
### Configuration and management
240241

241-
The output of 'show ip route' and 'show ipv6 route' will remain unchanged - the CLI code will resolve the NextHop Group ID referenced in the `ROUTE_TABLE` to display the next hops for the routes.
242-
243-
244242
#### CLI/YANG model Enhancements
245243

246244
<!--
@@ -249,15 +247,37 @@ This should also explain the CLICK and/or KLISH related configuration/show in de
249247
https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md needs be updated with the corresponding CLI change.
250248
-->
251249

252-
TODO: update based on CONFIG_DB enhancement.
250+
The output of 'show ip route' and 'show ipv6 route' will remain unchanged - the CLI code will resolve the NextHop Group ID referenced in the `ROUTE_TABLE` to display the next hops for the routes.
251+
252+
TODO: update config/show CLI inline with CONFIG_DB enhancement. (including CLI/YANG model Enhancements)
253253

254254
#### Config DB Enhancements
255255

256256
<!--
257257
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.
258258
-->
259259

260-
TODO: make it able to disable(default)/enable based on CONFIG_DB
260+
This feature should be disabled/enabled using CONFIG_DB.
261+
262+
This configuration is backward compatible. Upgrade from a SONiC version that does not support this feature does not change the user's expected behavior as this flag is set to be disabled by default.
263+
264+
This setting can NOT be enabled or disabled at runtime.
265+
Reboot is required after enabling/disabling this feature to make sure route entry using and not using this NHG feature would not co-exisit in the `APPL_DB`.
266+
267+
TODO: add schema and example of CONFIG_DB entry to below.
268+
269+
Configuration schema in ABNF format:
270+
271+
```
272+
TODO
273+
```
274+
275+
Sample of CONFIG DB snippet given below:
276+
277+
```
278+
TODO
279+
```
280+
261281

262282
### Warmboot and Fastboot Design Impact
263283

@@ -341,4 +361,9 @@ One should carefully study the impact of this change before chainging this optio
341361
#### Warmboot/Fastboot support
342362

343363
Currently this feature does not work with Warmboot/Fastboot.
344-
We will continue discussion on how we could support Warmboot/Fastboot for future enhancements.
364+
We will continue discussion on how we could support Warmboot/Fastboot for future enhancements.
365+
366+
#### No support for setting config enable/disable on runtime
367+
368+
This feature can NOT be enabled or disabled at runtime.
369+
Reboot is required after enabling/disabling this feature to make sure route entry using and not using this NHG feature would not co-exisit in the `APPL_DB`.

0 commit comments

Comments
 (0)