From 43c0e2bf522bd85c79fd166d052f36db7c2d9157 Mon Sep 17 00:00:00 2001 From: Brad House Date: Sun, 15 Dec 2024 20:06:25 -0500 Subject: [PATCH] YANG Configuration.md fix table of contents links (#21072) Why I did it Due to excess whitespace, the table of contents does not render as links in github, leading to navigation issues. This might cause some minor "pain" for other merge requests due to the formatting differences in the ToC, but it should really only take a second to correct. Better to fix it once and make everyone's life easier than just living with it. Work item tracking How I did it Updated whitespace and a couple other very minor correctness changes for MarkDown. There are still other changes I'd like to do but much lower priority and possibly not worth the disturbance. How to verify it View the corrected table of contents here: https://github.com/bradh352/sonic-buildimage/blob/configuration.md/src/sonic-yang-models/doc/Configuration.md Compared to original unrendered ToC here: https://github.com/sonic-net/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md Which release branch to backport (provide reason below if selected) Not needed Tested branch (Please provide the tested image version) master as of 20241206 Description for the changelog YANG Configuration.md fix table of contents links --- src/sonic-yang-models/doc/Configuration.md | 201 ++++++++++----------- 1 file changed, 96 insertions(+), 105 deletions(-) diff --git a/src/sonic-yang-models/doc/Configuration.md b/src/sonic-yang-models/doc/Configuration.md index 60a4222721f0..d9d761a5546e 100644 --- a/src/sonic-yang-models/doc/Configuration.md +++ b/src/sonic-yang-models/doc/Configuration.md @@ -1,103 +1,98 @@ -======= # SONiC Configuration Database Manual -Table of Contents -================= - - * [Introduction](#introduction) - * [Configuration](#configuration) - * [Config Load and Save](#config-load-and-save) - - * [Incremental Configuration](#incremental-configuration) - * [Redis and Json Schema](#redis-and-json-schema) - - * [ACL and Mirroring](#acl-and-mirroring) - * [BGP BBR](#bgp-bbr) - * [ASIC SDK health event](#asic-sdk-health-event) - * [BGP Device Global](#bgp-device-global) - * [BGP Sessions](#bgp-sessions) - * [BUFFER_PG](#buffer_pg) - * [Buffer pool](#buffer-pool) - * [Buffer profile](#buffer-profile) - * [Buffer queue](#buffer-queue) - * [Buffer port ingress profile list](#buffer-port-ingress-profile-list) - * [Buffer port egress profile list](#buffer-port-egress-profile-list) - * [Cable length](#cable-length) - * [Chassis module](#chassis-module) - * [COPP_TABLE](#copp_table) - * [Console](#console) - * [CRM](#crm) - * [CRM DASH](#crm-dash) - * [Data Plane L3 Interfaces](#data-plane-l3-interfaces) - * [DEFAULT_LOSSLESS_BUFFER_PARAMETER](#DEFAULT_LOSSLESS_BUFFER_PARAMETER) - * [Device Metadata](#device-metadata) - * [Device neighbor metada](#device-neighbor-metada) - * [DHCP_RELAY](#dhcp_relay) - * [DHCP Server IPV4](#dhcp_server_ipv4) - * [BMP](#bmp) - * [DSCP_TO_TC_MAP](#dscp_to_tc_map) - * [FG_NHG](#fg_nhg) - * [FG_NHG_MEMBER](#fg_nhg_member) - * [FG_NHG_PREFIX](#fg_nhg_prefix) - * [FABRIC_MONITOR](#fabric-monitor) - * [FABRIC_PORT](#fabric-port) - * [FLEX_COUNTER_TABLE](#flex_counter_table) - * [GRPCCLIENT](#grpcclient) - * [Hash](#hash) - * [IPv6 Link-local] (#ipv6-link-local) - * [KDUMP](#kdump) - * [Kubernetes Master](#kubernetes-master) - * [L2 Neighbors](#l2-neighbors) - * [Loopback Interface](#loopback-interface) - * [LOSSLESS_TRAFFIC_PATTERN](#LOSSLESS_TRAFFIC_PATTERN) - * [Memory Statistics](#memory-statistics) - * [Management Interface](#management-interface) - * [Management port](#management-port) - * [Management VRF](#management-vrf) - * [MAP_PFC_PRIORITY_TO_QUEUE](#map_pfc_priority_to_queue) - * [MUX_CABLE](#mux_cable) - * [MUX_LINKMGR](#mux_linkmgr) - * [NEIGH](#neigh) - * [NTP Global Configuration](#ntp-global-configuration) - * [NTP Servers](#ntp-servers) - * [Peer Switch](#peer-switch) - * [Policer](#policer) - * [Port](#port) - * [Port Channel](#port-channel) - * [Portchannel member](#portchannel-member) - * [Scheduler](#scheduler) - * [Port QoS Map](#port-qos-map) - * [Queue](#queue) - * [Syslog Global Configuration](#syslog-global-configuration) - * [Syslog Servers](#syslog-servers) - * [Sflow](#sflow) - * [Restapi](#restapi) - * [System Port](#system-port) - * [Tacplus Server](#tacplus-server) - * [TC to Priority group map](#tc-to-priority-group-map) - * [TC to Queue map](#tc-to-queue-map) - * [Telemetry](#telemetry) - * [Telemetry client](#telemetry-client) - * [Tunnel](#tunnel) - * [Versions](#versions) - * [VLAN](#vlan) - * [VLAN_MEMBER](#vlan_member) - * [VNET](#vnet) - * [VOQ Inband Interface](#voq-inband-interface) - * [VXLAN](#vxlan) - * [Virtual router](#virtual-router) - * [LOGGER](#logger) - * [WRED_PROFILE](#wred_profile) - * [XCVRD_LOG](#xcvrd_log) - * [PASSWORD_HARDENING](#password_hardening) - * [SSH_SERVER](#ssh_server) - * [SYSTEM_DEFAULTS table](#systemdefaults-table) - * [RADIUS](#radius) - * [Static DNS](#static-dns) - * [For Developers](#for-developers) - * [Generating Application Config by Jinja2 Template](#generating-application-config-by-jinja2-template) - * [Incremental Configuration by Subscribing to ConfigDB](#incremental-configuration-by-subscribing-to-configdb) - +**Table of Contents** + +* [Introduction](#introduction) +* [Configuration](#configuration) +* [Config Load and Save](#config-load-and-save) + * [Incremental Configuration](#incremental-configuration) +* [Redis and Json Schema](#redis-and-json-schema) + * [ACL and Mirroring](#acl-and-mirroring) + * [BGP BBR](#bgp-bbr) + * [ASIC SDK health event](#asic-sdk-health-event) + * [BGP Device Global](#bgp-device-global) + * [BGP Sessions](#bgp-sessions) + * [BUFFER_PG](#buffer_pg) + * [Buffer pool](#buffer-pool) + * [Buffer profile](#buffer-profile) + * [Buffer queue](#buffer-queue) + * [Buffer port ingress profile list](#buffer-port-ingress-profile-list) + * [Buffer port egress profile list](#buffer-port-egress-profile-list) + * [Cable length](#cable-length) + * [Chassis module](#chassis-module) + * [COPP_TABLE](#copp_table) + * [Console](#console) + * [CRM](#crm) + * [CRM DASH](#crm-dash) + * [Data Plane L3 Interfaces](#data-plane-l3-interfaces) + * [DEFAULT_LOSSLESS_BUFFER_PARAMETER](#DEFAULT_LOSSLESS_BUFFER_PARAMETER) + * [Device Metadata](#device-metadata) + * [Device neighbor metada](#device-neighbor-metada) + * [DHCP_RELAY](#dhcp_relay) + * [DHCP Server IPV4](#dhcp_server_ipv4) + * [BMP](#bmp) + * [DSCP_TO_TC_MAP](#dscp_to_tc_map) + * [FG_NHG](#fg_nhg) + * [FG_NHG_MEMBER](#fg_nhg_member) + * [FG_NHG_PREFIX](#fg_nhg_prefix) + * [FABRIC_MONITOR](#fabric-monitor) + * [FABRIC_PORT](#fabric-port) + * [FLEX_COUNTER_TABLE](#flex_counter_table) + * [GRPCCLIENT](#grpcclient) + * [Hash](#hash) + * [IPv6 Link-local] (#ipv6-link-local) + * [KDUMP](#kdump) + * [Kubernetes Master](#kubernetes-master) + * [L2 Neighbors](#l2-neighbors) + * [Loopback Interface](#loopback-interface) + * [LOSSLESS_TRAFFIC_PATTERN](#LOSSLESS_TRAFFIC_PATTERN) + * [Memory Statistics](#memory-statistics) + * [Management Interface](#management-interface) + * [Management port](#management-port) + * [Management VRF](#management-vrf) + * [MAP_PFC_PRIORITY_TO_QUEUE](#map_pfc_priority_to_queue) + * [MUX_CABLE](#mux_cable) + * [MUX_LINKMGR](#mux_linkmgr) + * [NEIGH](#neigh) + * [NTP Global Configuration](#ntp-global-configuration) + * [NTP Servers](#ntp-servers) + * [Peer Switch](#peer-switch) + * [Policer](#policer) + * [Port](#port) + * [Port Channel](#port-channel) + * [Portchannel member](#portchannel-member) + * [Scheduler](#scheduler) + * [Port QoS Map](#port-qos-map) + * [Queue](#queue) + * [Syslog Global Configuration](#syslog-global-configuration) + * [Syslog Servers](#syslog-servers) + * [Sflow](#sflow) + * [Restapi](#restapi) + * [System Port](#system-port) + * [Tacplus Server](#tacplus-server) + * [TC to Priority group map](#tc-to-priority-group-map) + * [TC to Queue map](#tc-to-queue-map) + * [Telemetry](#telemetry) + * [Telemetry client](#telemetry-client) + * [Tunnel](#tunnel) + * [Versions](#versions) + * [VLAN](#vlan) + * [VLAN_MEMBER](#vlan_member) + * [VNET](#vnet) + * [VOQ Inband Interface](#voq-inband-interface) + * [VXLAN](#vxlan) + * [Virtual router](#virtual-router) + * [LOGGER](#logger) + * [WRED_PROFILE](#wred_profile) + * [XCVRD_LOG](#xcvrd_log) + * [PASSWORD_HARDENING](#password_hardening) + * [SSH_SERVER](#ssh_server) + * [SYSTEM_DEFAULTS table](#systemdefaults-table) + * [RADIUS](#radius) + * [Static DNS](#static-dns) +* [For Developers](#for-developers) + * [Generating Application Config by Jinja2 Template](#generating-application-config-by-jinja2-template) + * [Incremental Configuration by Subscribing to ConfigDB](#incremental-configuration-by-subscribing-to-configdb) # Introduction @@ -2919,18 +2914,14 @@ The DPUS table introduces the information on the DPUs (Data Processing Unit) ava } ``` -#### 5.2.3 Update value directly in db memory -For Developers -============== +# For Developers -Generating Application Config by Jinja2 Template ------------------------------------------------- +## Generating Application Config by Jinja2 Template To be added. -Incremental Configuration by Subscribing to ConfigDB ----------------------------------------------------- +## Incremental Configuration by Subscribing to ConfigDB Detail instruction to be added. A sample could be found in this [PR](https://github.com/Azure/sonic-buildimage/pull/861) that