# sonic-net/sonic architecture

> Architecture diagram of the GitHub repository sonic-net/sonic, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-07-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sonic-net/sonic
- Repository: https://github.com/sonic-net/sonic

## Overview

#### Purpose and Scope
This is SONiC’s coordination, documentation, and static-project-website repository—not the network OS implementation. It publishes architecture/design records, governance, release/project material, platform information, and source-repository links. The main site entry point is `index.html`; repository orientation and outbound source links are in `README.md` and `sourcecode.md`.

#### Static Website Surface
The root HTML pages form a static SONiC project site, sharing a navigation shell and bundled frontend assets. `index.html` is the landing page; `menu.html` provides site navigation; content pages include `Supported-Devices-and-Platforms.html` and `sonic_latest_images.html`. Styling and browser behavior are local static dependencies under `assets/css/style.css`, `assets/js/custom.js`, and `assets/js/bootstrap.js`.

#### Documentation Knowledge Base
`doc/` is the architectural core: feature-oriented HLDs, design specifications, operational guides, and supporting diagrams. Each subdirectory is independently organized around a SONiC capability rather than executable modules. Representative system boundaries are configuration/database (`doc/configuration/SONiC_NOS_Configuration_Methods.md`, `doc/database/multi_database_instances.md`), management APIs (`doc/mgmt/Management Framework.md`, `doc/mgmt/gnmi/SONiC_GNMI_Server_Interface_Design.md`), and forwarding/platform design (`doc/voq/architecture.md`, `doc/platform_api/new_platform_api.md`).

#### SONiC Runtime Architecture References
The repository documents, but does not host, SONiC’s Linux-based and containerized runtime. Design documents describe control-plane services, database-mediated configuration/state, routing integration, and ASIC abstraction boundaries. Key references include `doc/sonic-fpm-module/frr_sonic_communication_channel.md` for FRR interaction, `doc/multi_asic/DB_Design_for_multi_asic.md` for multi-ASIC database topology, and `doc/warm-reboot/SONiC_Warmboot.md` for lifecycle continuity. External/runtime technologies materially referenced include Docker containers, Linux networking, Redis-style SONiC databases, FRR, gNMI/gNOI, and hardware ASIC/SAI ecosystems.

#### Content Navigation and Published Artifacts
The documentation table of contents is centralized in `sonic_docs_toc.md`; feature documents and linked assets are distributed under `doc/` and `images/`. Historical/community-facing material is retained as root HTML, PDFs, and `pdf/newsletters/`. This creates a documentation publishing boundary: source Markdown/design assets are repository content, while rendering is primarily via GitHub/wiki and static pages rather than an application server.

#### Image and Platform Metadata Pipeline
Supported-platform and image-link pages are generated/maintained from repository metadata. `sonic_image_links.json` is the image-link data source, with `generate_sonic_image_links.sh` producing associated output. `supported_devices_platforms_md.sh` supports the platform-list publication flow. GitHub Actions automate these updates through `.github/workflows/sonic_image_links_create_workflow.yml` and `.github/workflows/supported_devices_platforms_md.yml`.

#### Governance and Contribution Control Plane
Project decision-making and contribution procedures live alongside technical material: `governance.md`, `CONTRIBUTING.md`, and `tsc/`. Maintainer and conformance processes are captured in `tsc/repo-maintainer/SONiC_Repo_Maintainer.md` and `tsc/conformance/sonic_conformance_guideline.md`. GitHub issue/PR templates and workflows provide the repository’s operational integration boundary under `.github/`.

Main entry points: [`menu.html`](https://github.com/sonic-net/sonic/blob/master/menu.html) (Site navigation), [`.github/workflows/sonic_image_links_create_workflow.yml`](https://github.com/sonic-net/sonic/blob/master/.github/workflows/sonic_image_links_create_workflow.yml) (GitHub Actions), [`Supported-Devices-and-Platforms.html`](https://github.com/sonic-net/sonic/blob/master/Supported-Devices-and-Platforms.html) (Supported platforms page), [`sonic_latest_images.html`](https://github.com/sonic-net/sonic/blob/master/sonic_latest_images.html) (Image links page)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_site["Static project site"]
  node_index["Landing page<br/>HTML<br/>[index.html]"]
  node_menu["Site navigation<br/>HTML<br/>[menu.html]"]
  node_platform_page["Supported platforms page<br/>HTML"]
  node_images_page["Image links page<br/>HTML"]
  node_frontend_assets["Frontend assets<br/>CSS and JavaScript<br/>[style.css]"]
end

subgraph group_docs["Documentation knowledge base"]
  node_toc["Documentation TOC<br/>Markdown index<br/>[sonic_docs_toc.md]"]
  node_design_docs["Feature design documents<br/>Markdown collection"]
  node_config_db_docs["Configuration and DB design<br/>Architecture docs"]
  node_management_docs["Management API design<br/>Architecture docs"]
  node_platform_docs["Forwarding and platform design<br/>Architecture docs<br/>[architecture.md]"]
  node_runtime_docs["Runtime integration references<br/>Architecture docs"]
end

subgraph group_automation["Publication automation"]
  node_image_metadata["Image link metadata<br/>JSON"]
  node_image_generator["Image link generator<br/>Shell script"]
  node_platform_generator["Platform list generator<br/>Shell script"]
  node_github_actions{{"GitHub Actions<br/>CI workflows"}}
end

subgraph group_governance["Governance and contribution"]
  node_governance["Project governance<br/>Markdown<br/>[governance.md]"]
  node_contributing["Contribution process<br/>Markdown<br/>[CONTRIBUTING.md]"]
  node_maintainer_guidance["Maintainer and conformance<br/>TSC guidance"]
end

subgraph group_runtime["Referenced SONiC runtime"]
  node_sonic_runtime{{"SONiC runtime ecosystem<br/>External runtime"}}
end

node_readme["Repository orientation<br/>Markdown<br/>[README.md]"]
node_sourcecode["Source repository links<br/>Markdown<br/>[sourcecode.md]"]

node_readme -->|"points to"| node_sourcecode
node_index -->|"uses navigation"| node_menu
node_index -->|"loads"| node_frontend_assets
node_menu -->|"navigates to"| node_platform_page
node_menu -->|"navigates to"| node_images_page
node_platform_page -->|"loads"| node_frontend_assets
node_images_page -->|"loads"| node_frontend_assets
node_toc -->|"indexes"| node_design_docs
node_design_docs -->|"includes"| node_config_db_docs
node_design_docs -->|"includes"| node_management_docs
node_design_docs -->|"includes"| node_platform_docs
node_design_docs -->|"includes"| node_runtime_docs
node_config_db_docs -.->|"documents configuration and databases"| node_sonic_runtime
node_management_docs -.->|"documents APIs"| node_sonic_runtime
node_platform_docs -.->|"documents forwarding and ASIC boundary"| node_sonic_runtime
node_runtime_docs -.->|"documents integration and lifecycle"| node_sonic_runtime
node_image_metadata -->|"input to"| node_image_generator
node_image_generator -->|"publishes links for"| node_images_page
node_platform_generator -->|"publishes list for"| node_platform_page
node_github_actions -->|"runs"| node_image_generator
node_github_actions -->|"runs"| node_platform_generator
node_governance -->|"governs"| node_contributing
node_governance -->|"defines processes through"| node_maintainer_guidance
node_contributing -.->|"integrates contributions via"| node_github_actions

click node_readme "https://github.com/sonic-net/sonic/blob/master/README.md"
click node_sourcecode "https://github.com/sonic-net/sonic/blob/master/sourcecode.md"
click node_index "https://github.com/sonic-net/sonic/blob/master/index.html"
click node_menu "https://github.com/sonic-net/sonic/blob/master/menu.html"
click node_platform_page "https://github.com/sonic-net/sonic/blob/master/Supported-Devices-and-Platforms.html"
click node_images_page "https://github.com/sonic-net/sonic/blob/master/sonic_latest_images.html"
click node_frontend_assets "https://github.com/sonic-net/sonic/blob/master/assets/css/style.css"
click node_toc "https://github.com/sonic-net/sonic/blob/master/sonic_docs_toc.md"
click node_config_db_docs "https://github.com/sonic-net/sonic/blob/master/doc/configuration/SONiC_NOS_Configuration_Methods.md"
click node_management_docs "https://github.com/sonic-net/sonic/blob/master/doc/mgmt/Management%20Framework.md"
click node_platform_docs "https://github.com/sonic-net/sonic/blob/master/doc/voq/architecture.md"
click node_runtime_docs "https://github.com/sonic-net/sonic/blob/master/doc/sonic-fpm-module/frr_sonic_communication_channel.md"
click node_image_metadata "https://github.com/sonic-net/sonic/blob/master/sonic_image_links.json"
click node_image_generator "https://github.com/sonic-net/sonic/blob/master/generate_sonic_image_links.sh"
click node_platform_generator "https://github.com/sonic-net/sonic/blob/master/supported_devices_platforms_md.sh"
click node_github_actions "https://github.com/sonic-net/sonic/blob/master/.github/workflows/sonic_image_links_create_workflow.yml"
click node_governance "https://github.com/sonic-net/sonic/blob/master/governance.md"
click node_contributing "https://github.com/sonic-net/sonic/blob/master/CONTRIBUTING.md"
click node_maintainer_guidance "https://github.com/sonic-net/sonic/blob/master/tsc/repo-maintainer/SONiC_Repo_Maintainer.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_index,node_menu,node_platform_page,node_images_page,node_frontend_assets toneBlue
class node_toc,node_design_docs,node_config_db_docs,node_management_docs,node_platform_docs,node_runtime_docs toneAmber
class node_image_metadata,node_image_generator,node_platform_generator,node_github_actions toneMint
class node_governance,node_contributing,node_maintainer_guidance toneRose
class node_sonic_runtime toneIndigo
class node_readme,node_sourcecode toneNeutral
```

## Components

### Static project site

- [Landing page](https://github.com/sonic-net/sonic/blob/master/index.html): HTML · `index.html`
- [Site navigation](https://github.com/sonic-net/sonic/blob/master/menu.html): HTML · `menu.html`
- [Supported platforms page](https://github.com/sonic-net/sonic/blob/master/Supported-Devices-and-Platforms.html): HTML · `Supported-Devices-and-Platforms.html`
- [Image links page](https://github.com/sonic-net/sonic/blob/master/sonic_latest_images.html): HTML · `sonic_latest_images.html`
- [Frontend assets](https://github.com/sonic-net/sonic/blob/master/assets/css/style.css): CSS and JavaScript · Shared styling and browser behavior. · `assets/css/style.css`

### Documentation knowledge base

- [Documentation TOC](https://github.com/sonic-net/sonic/blob/master/sonic_docs_toc.md): Markdown index · Central navigation for feature documentation. · `sonic_docs_toc.md`
- **Feature design documents**: Markdown collection · HLDs, specifications, operational guides, and diagrams organized by capability.
- [Configuration and DB design](https://github.com/sonic-net/sonic/blob/master/doc/configuration/SONiC_NOS_Configuration_Methods.md): Architecture docs · `doc/configuration/SONiC_NOS_Configuration_Methods.md`
- [Management API design](https://github.com/sonic-net/sonic/blob/master/doc/mgmt/Management%20Framework.md): Architecture docs · `doc/mgmt/Management Framework.md`
- [Forwarding and platform design](https://github.com/sonic-net/sonic/blob/master/doc/voq/architecture.md): Architecture docs · `doc/voq/architecture.md`
- [Runtime integration references](https://github.com/sonic-net/sonic/blob/master/doc/sonic-fpm-module/frr_sonic_communication_channel.md): Architecture docs · Covers FRR, multi-ASIC databases, and warm reboot. · `doc/sonic-fpm-module/frr_sonic_communication_channel.md`

### Publication automation

- [Image link metadata](https://github.com/sonic-net/sonic/blob/master/sonic_image_links.json): JSON · `sonic_image_links.json`
- [Image link generator](https://github.com/sonic-net/sonic/blob/master/generate_sonic_image_links.sh): Shell script · `generate_sonic_image_links.sh`
- [Platform list generator](https://github.com/sonic-net/sonic/blob/master/supported_devices_platforms_md.sh): Shell script · `supported_devices_platforms_md.sh`
- [GitHub Actions](https://github.com/sonic-net/sonic/blob/master/.github/workflows/sonic_image_links_create_workflow.yml): CI workflows · Automates image-link and platform-list publication updates. · `.github/workflows/sonic_image_links_create_workflow.yml`

### Governance and contribution

- [Project governance](https://github.com/sonic-net/sonic/blob/master/governance.md): Markdown · `governance.md`
- [Contribution process](https://github.com/sonic-net/sonic/blob/master/CONTRIBUTING.md): Markdown · `CONTRIBUTING.md`
- [Maintainer and conformance](https://github.com/sonic-net/sonic/blob/master/tsc/repo-maintainer/SONiC_Repo_Maintainer.md): TSC guidance · `tsc/repo-maintainer/SONiC_Repo_Maintainer.md`

### Referenced SONiC runtime

Documented external runtime; not implemented here.

- **SONiC runtime ecosystem**: External runtime · Linux, containers, Redis-style databases, FRR, gNMI/gNOI, and ASIC/SAI.

### Other components

- [Repository orientation](https://github.com/sonic-net/sonic/blob/master/README.md): Markdown · Links readers to project resources and source repositories. · `README.md`
- [Source repository links](https://github.com/sonic-net/sonic/blob/master/sourcecode.md): Markdown · `sourcecode.md`

## Connections

- Repository orientation → Source repository links: points to
- Landing page → Site navigation: uses navigation
- Landing page → Frontend assets: loads
- Site navigation → Supported platforms page: navigates to
- Site navigation → Image links page: navigates to
- Supported platforms page → Frontend assets: loads
- Image links page → Frontend assets: loads
- Documentation TOC → Feature design documents: indexes
- Feature design documents → Configuration and DB design: includes
- Feature design documents → Management API design: includes
- Feature design documents → Forwarding and platform design: includes
- Feature design documents → Runtime integration references: includes
- Configuration and DB design → SONiC runtime ecosystem: documents configuration and databases
- Management API design → SONiC runtime ecosystem: documents APIs
- Forwarding and platform design → SONiC runtime ecosystem: documents forwarding and ASIC boundary
- Runtime integration references → SONiC runtime ecosystem: documents integration and lifecycle
- Image link metadata → Image link generator: input to
- Image link generator → Image links page: publishes links for
- Platform list generator → Supported platforms page: publishes list for
- GitHub Actions → Image link generator: runs
- GitHub Actions → Platform list generator: runs
- Project governance → Contribution process: governs
- Project governance → Maintainer and conformance: defines processes through
- Contribution process → GitHub Actions: integrates contributions via
