リファレンス¶
docs/reference/ は SONiC NOS (community master) を運用 / 検証する際に 辞書として直接引く 情報を集める章である。Topics 章 (docs/topics/) が「読み物」として導線を提供するのに対し、本章は コマンド名 / テーブル名 / モジュール名 / 症状 から逆引きする使い方を想定している。
各 reference ページは原則 verification: code-verified で、.cache/sonic-sources/ に shallow clone した master の固定 commit を一次情報として持つ。HLD 由来の推測は本文に明示する。
サブセクションの入口¶
| カテゴリ | 入口 | 役割 |
|---|---|---|
| CLI | cli/index.md | config-* / show-* / clear / debug-* / sonic-installer / sonic-cfggen 等の sonic-utilities ベースのコマンドツリー |
| CONFIG_DB | config-db/index.md | Redis DB 4 (CONFIG_DB) のテーブル定義。orchagent / *mgrd 各 daemon が subscribe するスキーマ |
| YANG | yang/index.md | sonic-yang-models の native SONiC YANG モジュール。CONFIG_DB の正本 |
| Runbooks | runbooks/index.md | 症状逆引きの運用ハンドブック (BGP down, PFC bandwidth, warm-reboot 失敗 等) |
| Verification | verification/index.md | 裏取り運用方針と discrepancy-index (HLD と実装の乖離一覧) |
将来追加予定 (未着手)¶
| カテゴリ | 状態 |
|---|---|
glossary/ (用語集) |
未着手。現状は本文中で都度説明 |
sai-attributes/ (SAI 属性表) |
未着手。今後 meta/index/sai.json から生成予定 |
config-db-orch-map/ (テーブル ↔ Orch マッピング) |
未着手。現状は CONFIG_DB ページ本文に分散 |
これらの placeholder は backlog (meta/backlog/reference/) で追跡する。
カバー率 (機械集計, 2026-05-11)¶
docs/reference/<sub>/*.md を直接数えた件数。verification 内訳は frontmatter の verification: キーから抽出した。
| カテゴリ | 総ページ | code-verified | hld-only | discrepancy-found | meta |
|---|---|---|---|---|---|
| CLI | 72 | 72 | 0 | 0 | 1 (index) |
| CONFIG_DB | 121 | 121 | 0 | 0 | 1 (index) |
| YANG | 84 | 84 | 0 | 0 | 1 (index) |
| Runbooks | 45 | 45 | 0 | 0 | 1 (index) |
| Verification | 1 | 0 | 0 | 0 | 2 (index + discrepancy-index) |
| 合計 | 323 | 322 | 0 | 0 | 6 |
discrepancy-found 自体は reference 内ではなく docs/topics/ 配下に分布する。全 46 ページ。discrepancy-index から area 別 / monitor 別に逆引きできる。
元リポジトリのカバー率参考値¶
meta/index/*.json で棚卸ししたカウントに対する本プロジェクトの reference ページ数 (網羅率はおおよその目安)。
| カテゴリ | 元リポの総数 | 本プロジェクト | 備考 |
|---|---|---|---|
sonic-utilities click グループ |
~85 | 72 | 主要グループは網羅、低使用頻度の dropcounters / vrouter 等が残 |
sonic-yang-models の CONFIG_DB テーブル |
~160 | 121 | 派生・廃止テーブルを除いた主要分は網羅 |
sonic-* native YANG モジュール |
~110 | 84 | smartswitch / DASH 系の一部、ベンダー特化モジュールが残 |
未カバー分は meta/backlog/reference/ で追跡しており、Reference 拡張バッチで段階的に消化する。
よく引かれる項目 (早見リンク集)¶
主要機能ごとの CLI / CONFIG_DB / YANG / Runbook を 1 行に並べる。HLD への入口は Topics 章を参照する。
BGP / Routing¶
- CLI: config bgp / show bgp / show ip / show route-map
- CONFIG_DB: BGP_GLOBALS / BGP_NEIGHBOR / BGP_PEER_GROUP / ROUTE_MAP / PREFIX_SET
- YANG: sonic-bgp-global / sonic-bgp-neighbor / sonic-route-map
- Runbook: bgp-session-down / bgp-route-not-advertised
- Topic: 02 BGP と FRR 制御プレーン
VLAN / L2 / LAG / MC-LAG¶
- CLI: config vlan / show vlan / config portchannel / config mclag / show mclag
- CONFIG_DB: VLAN / VLAN_MEMBER / VLAN_INTERFACE / PORTCHANNEL / PORTCHANNEL_MEMBER / PEER_SWITCH
- YANG: sonic-vlan / sonic-portchannel / sonic-mclag
- Runbook: vlan-tagging / portchannel-lacp-not-established / mclag-sync-failure
- Topic: 06 L2 / VLAN / LAG / MC-LAG
VXLAN / EVPN / VNET¶
- CLI: config vxlan / config vnet
- CONFIG_DB: VXLAN_TUNNEL / VXLAN_TUNNEL_MAP / TUNNEL / TUNNEL_DECAP_TABLE
- YANG: sonic-vxlan
- Runbook: evpn-type2-not-advertised
- Topic: 03 VXLAN / EVPN / VNET
VRF / ECMP / RIB-FIB¶
- CLI: config vrf / config route / show ip
- CONFIG_DB: VRF / FG_NHG / INTERFACE / LOOPBACK_INTERFACE
- YANG: sonic-vrf / sonic-route-common
- Runbook: routing-loop-detected
- Topic: 04 VRF / ECMP / RIB-FIB
ACL / CoPP / Mirror¶
- CLI: config acl / show acl / config mirror-session
- CONFIG_DB: ACL_TABLE / ACL_RULE / COPP_TRAP / COPP_GROUP / MIRROR_SESSION / POLICER
- YANG: sonic-copp / sonic-mirror-session
- Runbook: acl-rule-no-hit / rif-acl-counter-zero
- Topic: 07 ACL / CoPP / Mirror
QoS / Buffer / PFC¶
- CLI: config qos / config buffer / show buffer / config pfcwd / show pfc / show priority-group / show queue
- CONFIG_DB: BUFFER_POOL / BUFFER_PROFILE / BUFFER_PG / BUFFER_QUEUE / QUEUE / SCHEDULER / WRED_PROFILE / DSCP_TO_TC_MAP / TC_TO_QUEUE_MAP / PFC_WD
- YANG: sonic-buffer-pool / sonic-buffer-profile / sonic-buffer-pg / sonic-buffer-queue / sonic-queue / sonic-scheduler / sonic-pfcwd / sonic-dscp-tc-map / sonic-tc-queue-map
- Runbook: pfc-bandwidth
Dual-ToR / Mux¶
- CLI: config muxcable / show muxcable
- CONFIG_DB: MUX_CABLE / PEER_SWITCH / TUNNEL_DECAP_TABLE
- Runbook: dualtor-mux / ycable-firmware-update-failure
- Topic: 05 Dual-ToR / Mux
Platform / Port / Optics¶
- CLI: show platform / config platform firmware / show interfaces / show environment / show flowcnt
- CONFIG_DB: PORT / DEVICE_METADATA / DEVICE_NEIGHBOR
- YANG: sonic-port / sonic-device_metadata / sonic-interface
- Runbook: asic-link-autoneg-mismatch / fec-errors / link-flapping / interface-mtu-mismatch / platform-fan-psu-anomaly
Reboot / Warm-restart / Lifecycle¶
- CLI: reboot / fast / warm / config warm_restart / config kdump / sonic-installer / sonic-package-manager
- CONFIG_DB: KDUMP / FEATURE
- Runbook: warm-reboot-failure / container-not-starting / container-memory-limit-exceeded / minigraph-reload-stuck
- Topic: 11 Reboot / Warm-restart
SAI / SWSS / ASIC_DB¶
- CONFIG_DB: FLEX_COUNTER_TABLE / DEBUG_COUNTER / CRM
- Runbook: appdb-asicdb-sync-lag / sai-failure / sai-table-full / crm-threshold-exceeded / flex-counter-stuck / interface-counters-reset
- Topic: 20 SWSS / SAI / Redis
Management / gNMI / SNMP / Telemetry¶
- CLI: config snmp / show snmpagentaddress / show snmptrap / config sflow / config syslog / show techsupport
- CONFIG_DB: TELEMETRY / SFLOW / SYSLOG_SERVER / AUTO_TECHSUPPORT / KUBERNETES_MASTER
- YANG: sonic-syslog / sonic-system-aaa / sonic-feature
- Runbook: gnmi-subscribe-disconnect / telemetry-dialout-not-sending / snmp-polling-timeout / snmpv3-auth-failure / techsupport-size-bloat / techsupport-timeout
- Topic: 10 gNMI / OpenConfig / YANG
NAT / DHCP / Time / DNS¶
- CLI: config nat / show nat / config dhcp-relay / config ntp / show clock
- CONFIG_DB: DHCPV4_RELAY / DHCP_SERVER_IPV4 / NTP (global) / NTP_SERVER
- YANG: sonic-ntp
- Runbook: dhcp-relay / nat-translation-miss
Security / AAA¶
- CLI: config aaa / tacacs / radius / show aaa / config ssh
- CONFIG_DB: TACPLUS_SERVER / LDAP_SERVER / MGMT_INTERFACE / MGMT_VRF_CONFIG
- YANG: sonic-system-aaa
- Runbook: snmpv3-auth-failure
SmartSwitch / DASH¶
- Runbook: dash-eni-down / smartswitch-dpu-unresponsive / smartswitch-dpu-image-install-failure / smartswitch-dpu-graceful-shutdown-failure
reference vs topics の役割分担¶
| 軸 | docs/reference/ |
docs/topics/ |
|---|---|---|
| 読み方 | 辞書 (名前から逆引き) | 読み物 (機能から導線) |
| 粒度 | 1 コマンド / 1 テーブル / 1 モジュール = 1 ページ | 1 機能 = setup / operations / deep-dive の章 |
| frontmatter | verification: code-verified 中心 |
code-verified / discrepancy-found / hld-only 混在 |
| 主な参照元 | Topics 章末「関連 reference」と Runbook 内コマンド/テーブル名 | Runbook の「関連ページ」、HLD 由来の設計議論 |
詳細な相互ナビゲーションは Topics: リファレンス横断索引 を参照。本ページ「よく引かれる項目」が 早見表 (canonical) 、Topics 22 章の cli-index / config-db-index / yang-index は **章構造ごとの詳細表 (canonical) ** として役割を分担する。