# xilinx/open-nic architecture

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

- Interactive diagram: https://gitdiagram.com/xilinx/open-nic
- Repository: https://github.com/xilinx/open-nic

## Overview

This repository is a release point for OpenNIC’s shell and drivers, not the implementation of those components. Its principal workflow is for a user to run the checkout script, which uses the version mapping to check out matching component versions. The README documents the component roles and this workflow; no component source is present in the supplied tree, so their internal interactions are not shown.

Main entry points: [`script/checkout.sh`](https://github.com/xilinx/open-nic/blob/main/script/checkout.sh) (Checkout script), [`script/version.yaml`](https://github.com/xilinx/open-nic/blob/main/script/version.yaml) (Version mapping)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_user(("User"))
node_checkout["Checkout script<br/>[checkout.sh]"]
node_versions["Version mapping<br/>[version.yaml]"]
node_shell["OpenNIC shell"]
node_linux["Linux driver"]
node_dpdk["DPDK driver"]

node_user -->|"runs"| node_checkout
node_checkout -->|"reads versions"| node_versions
node_checkout -->|"checks out"| node_shell
node_checkout -->|"checks out"| node_linux
node_checkout -->|"checks out"| node_dpdk

click node_checkout "https://github.com/xilinx/open-nic/blob/main/script/checkout.sh"
click node_versions "https://github.com/xilinx/open-nic/blob/main/script/version.yaml"

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_user toneBlue
class node_checkout,node_versions toneTeal
class node_shell,node_linux,node_dpdk toneIndigo
```

## Components

### Other components

- **User**
- [Checkout script](https://github.com/xilinx/open-nic/blob/main/script/checkout.sh): `script/checkout.sh`
- [Version mapping](https://github.com/xilinx/open-nic/blob/main/script/version.yaml): `script/version.yaml`
- **OpenNIC shell**
- **Linux driver**
- **DPDK driver**

## Connections

- User → Checkout script: runs (evidence: `README.md`)
- Checkout script → Version mapping: reads versions (evidence: `README.md`)
- Checkout script → OpenNIC shell: checks out (evidence: `README.md`)
- Checkout script → Linux driver: checks out (evidence: `README.md`)
- Checkout script → DPDK driver: checks out (evidence: `README.md`)
