Topics で読み物として読む

この HLD は実装詳細を含みます。機能の概念・設定・運用を読み物として読みたい場合は Topics 10 章: gNMI / OpenConfig / 管理プレーンを参照。

裏取りステータス: code-verified

実装裏取り済み（下記コード位置）。docker-sonic-mgmt-framework: sonic-buildimage/dockers/docker-sonic-mgmt-framework / sonic-mgmt-common/translib/transformer/* (interfaces / portchannel / sflow openconfig + sonic test) で確認。

Transformer）¶

概要¶

sonic-mgmt-framework は外部 API（REST / gNMI / CLI）と内部 CONFIG_DB / 各種 daemon 間の モデル翻訳層 を担う¹。中核は次の 4 つ:

北側 API server: REST (OpenAPI)、gNMI（gRPC）、CLI（KLISH）からの要求を受ける
Translib: YANG モデル（openconfig / IETF / sonic-*）と内部表現の間の汎用変換ライブラリ
Transformer: モデル間（openconfig YANG ↔ sonic YANG / CONFIG_DB）の写像を per-module に実装
App-DB Layer: CONFIG_DB / APPL_DB / STATE_DB へ Redis 経由で読み書き

動作仕様¶

flowchart LR
    REST["REST client\n(OpenAPI)"] --> RS[REST server]
    GNMI[gNMI client] --> GS["gNMI server\n(telemetry)"]
    KLISH["CLI / KLISH"] --> CLI["clish/klish"]

    RS --> TL[Translib]
    GS --> TL
    CLI --> TL

    TL -->|model based| TF["Transformer<br>(per-module)"]
    TF --> CDB[(CONFIG_DB)]
    TF --> ADB[("APPL_DB / STATE_DB")]
    TF --> RPC["per-feature RPC<br>(openconfig actions)"]

主要ポイント¹:

YANG が真実源: openconfig / IETF / sonic-* YANG 全体を sonic-yang-mgmt がパースし、URL / xpath マッピングと validation を提供
Transformer は二種: app-specific（openconfig ↔ sonic）と sonic-yang only（schema-driven）
gNMI subscription: STATE_DB の更新を SAMPLE / ON_CHANGE で stream（別ページ「gNMI Subscription for YANG Data」を参照）
mgmt-framework container: REST / Translib / Transformer / KLISH を 1 コンテナに同居させる構成
認証/認可: TLS + client cert、TACACS+/RADIUS/LDAP は AAA 改善 HLD に従う

主要なフロー¶

sequenceDiagram
    participant C as REST client
    participant RS as REST server
    participant TL as Translib
    participant TF as Transformer
    participant DB as CONFIG_DB

    C->>RS: PATCH /restconf/data/openconfig-interfaces:interfaces/...
    RS->>TL: dispatch(xpath, payload)
    TL->>TL: YANG validate (whole-tree)
    TL->>TF: transform(payload) → CONFIG_DB ops
    TF->>DB: HSET / HDEL operations
    DB-->>TF: ack
    TF-->>TL: status
    TL-->>RS: 200/204
    RS-->>C: response

設定 / 関連¶

このページは横断機能のため CONFIG_DB の特定テーブルには紐づかない。openconfig 各モジュール（interfaces / acl / network-instance / system 等）と sonic-* YANG が網羅対象。

制限事項¶

YANG モデルが定義されていない機能は API 化できない: 機能側で sonic-* YANG を追加する必要がある
transformer は per-module 実装: openconfig 側の新モジュール対応は手作業のコストが高い
ロールバック / 部分失敗: GCU / JSON Patch ordering の HLD（同 architecture area）と組み合わせて初めて transactional になる
大規模 GET の性能: tree 全体取得はオブジェクト変換コストが高く、fields= 限定や paginate 推奨

干渉する機能¶

gNMI Subscription: telemetry stream は同じ Translib を介する。本 HLD と並読み推奨
Generic Config Update / Rollback (GCU): REST / gNMI Set のバックエンドとして動く可能性
AAA improvements: REST / gNMI の認証は AAA HLD に統合される
KLISH CLI auto-generation: KLISH コマンド定義の自動生成（同 area の別 HLD）と密に関係

トラブルシューティング¶

404 が返る → URL の YANG モジュール prefix（openconfig-interfaces:）と xpath を確認
400 / validation 失敗 → mgmt-framework ログで YANG エラー詳細を確認
gNMI subscription が来ない → STATE_DB へ更新が出ているか、subscription path が schema 上 valid か

確認コマンド例:

# CLI / 設定パイプライン状態確認
show runningconfiguration all | head
config save -y
diff /etc/sonic/config_db.json <(show runningconfiguration all)

引用元¶

運用入口¶

この HLD に対応する運用面の入口（CLI / CONFIG_DB / YANG / Runbook）を以下にまとめる。

SONiC Management Framework（REST / gNMI / Translib / Transformer）¶

概要¶

動作仕様¶

主要なフロー¶

設定 / 関連¶

関連 CLI¶

制限事項¶

干渉する機能¶

トラブルシューティング¶

引用元¶

関連 Topics¶

運用入口¶

関連 YANG¶