# google/gnxi architecture

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

- Interactive diagram: https://gitdiagram.com/google/gnxi
- Repository: https://github.com/google/gnxi

## Overview

##### Project type and purpose
- This is a monorepo of command-line tools, servers (targets), and testing/orchestration infrastructure implementing and exercising the gNMI and gNOI gRPC-based network management protocols.
- It includes:
- Go-based gNMI clients (Capabilities, Get, Set, Subscribe)
- A Go-based gNMI Target server
- Go-based gNOI clients (Cert, OS, Reset) and a gNOI Target server
- A Python gNMI CLI
- A Python-based configuration validator (oc_config_validate)
- A test harness (“gnxi_tester”) with Go orchestrator, Docker integration, and Angular web UI
- Utility packages (credentials, mockOS, XPath, cert generation)

##### File structure
- Top-level folders each correspond to a self-contained binary or library:
- /gnmi        – Go library for gNMI protocol (models, server, utilities)
- /gnmi_*      – individual Go clients and the Go gNMI target server
- /gnoi        – core Go library for gNOI sub-services (cert, os, reset)
- /gnoi_*      – Go clients and Go gNOI target server
- /gnmi_cli_py – Python client implementation
- /oc_config_validate – Python package implementing config validation, testcases, and models
- /gnxi_tester – Go CLI, orchestrator (Docker), web server, config, plus /web_ui Angular application
- /utils       – shared helper libraries (credentials, entity, mockos, xpath)
- /certs       – certificate generation scripts
- Configuration files: Dockerfiles, docker-compose.yml, Go modules (go.mod/sum), Python requirements, Angular CLI files.

##### README for additional insights
- Confirms this is a reference/test implementation of gNMI/gNOI.
- Lists all clients and servers.
- Mentions code generation (proto → Go/Python stubs) and certificate generation.

a. Main components
- gNMI Library (Go): model.go, server.go, utility code
- gNOI Library (Go): cert, os, reset sub-packages
- CLI Clients:
- Go binaries: gnmi_capabilities, gnmi_get, gnmi_set, gnmi_subscribe, gnoi_cert, gnoi_os, gnoi_reset
- Python binary: gnmi_cli_py
- Target Servers:
- Go gNMI Target (gnmi_target)
- Go gNOI Target (gnoi_target)
- Mock servers: utils/mockos, gnoi_mockos
- Validation Tool: oc_config_validate (Python)
- Test Harness: gnxi_tester
- Orchestrator (Go) → spins up Docker containers running target servers
- Web Server (Go) → REST/WS endpoints for UI
- Angular Web UI (gnxi_tester/web_ui)
- Shared Utilities: utils/credentials, utils/entity, utils/xpath
- Certificate Generation: certs/generate.sh
b. Relationships and interactions
- CLI Clients ←[gRPC over TLS]→ Target Servers
- Python Validator ←[gRPC over TLS]→ Target Servers
- gnxi_tester Orchestrator ←[Docker API]→ Containers (running servers)
- Web UI ←[HTTP/REST or WebSocket]→ Go web server
- Go web server ←[exec or API]→ CLI binaries to perform tests
- All use shared codegen outputs (proto → Go/Python stubs in gnmi/, gnoi/)
- Certificate generator produces certs for TLS between clients and servers
c. Architectural patterns / design principles
- Microservice style: each client and server is a separate process/binary
- Shared libraries for protocol handling (proto stubs) and utilities
- Clear separation of concerns: protocol libs vs. CLIs vs. servers vs. test harness
- Test harness orchestrates and aggregates components using containers
d. Key technologies
- Go modules, gRPC, Protocol Buffers, glog
- Python 3, grpcio, pytest
- Docker, docker-compose
- Angular CLI, TypeScript, Karma/Protractor
- Shell scripts for certs and fixtures

##### Essential details to capture
- Proto code generation → shared stub libraries
- Certificate generation and usage for TLS
- How the test harness spins up real server instances in Docker and runs clients against them
- The Web UI’s relationship to the Go web server and underlying orchestrator

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Protocol Layer
    subgraph "Protocol Layer"
        direction TB
        PL_gnmi["gNMI Library (Go)"]:::go
        PL_gnoi["gNOI Library (Go)"]:::go
    end

    %% Shared Utilities
    subgraph "Shared Utilities"
        direction TB
        SU_credentials["credentials"]:::go
        SU_entity["entity"]:::go
        SU_xpath["xpath"]:::go
    end

    %% Certificate Generation
    CG["generate.sh"]:::shell

    %% Clients
    subgraph "Clients"
        direction TB
        C_gnmi_cap["gnmi_capabilities"]:::go
        C_gnmi_get["gnmi_get"]:::go
        C_gnmi_set["gnmi_set"]:::go
        C_gnmi_sub["gnmi_subscribe"]:::go
        C_gnoi_cert["gnoi_cert"]:::go
        C_gnoi_os["gnoi_os"]:::go
        C_gnoi_reset["gnoi_reset"]:::go
        C_py_cli["gnmi_cli_py"]:::python
    end

    %% Validator
    VAL["oc_config_validate"]:::python

    %% Servers
    subgraph "Servers"
        direction TB
        S_gnmi_target["gnmi_target"]:::go
        S_gnoi_target["gnoi_target"]:::go
        S_mockos["utils/mockos (Mock OS)"]:::go
        S_gnoi_mockos["gnoi_mockos"]:::go
    end

    %% Test Harness
    subgraph "Test Harness (gnxi_tester)"
        direction TB
        TH_orch["Orchestrator"]:::go
        TH_websrv["Web Server"]:::go
        subgraph "Web UI"
            direction TB
            TH_webui["Angular UI"]:::js
        end
    end

    %% Relationships
    PL_gnmi -->|provides stubs| C_gnmi_cap
    PL_gnmi -->|provides stubs| C_gnmi_get
    PL_gnmi -->|provides stubs| C_gnmi_set
    PL_gnmi -->|provides stubs| C_gnmi_sub
    PL_gnoi -->|provides stubs| C_gnoi_cert
    PL_gnoi -->|provides stubs| C_gnoi_os
    PL_gnoi -->|provides stubs| C_gnoi_reset
    PL_gnmi -->|provides stubs| C_py_cli
    PL_gnoi -->|provides stubs| C_py_cli

    C_gnmi_cap -->|gRPC/TLS| S_gnmi_target
    C_gnmi_get -->|gRPC/TLS| S_gnmi_target
    C_gnmi_set -->|gRPC/TLS| S_gnmi_target
    C_gnmi_sub -->|gRPC/TLS| S_gnmi_target
    C_gnoi_cert -->|gRPC/TLS| S_gnoi_target
    C_gnoi_os -->|gRPC/TLS| S_gnoi_target
    C_gnoi_reset -->|gRPC/TLS| S_gnoi_target
    C_py_cli -->|gRPC/TLS| S_gnmi_target
    C_py_cli -->|gRPC/TLS| S_gnoi_target

    VAL -->|gRPC/TLS| S_gnmi_target
    VAL -->|gRPC/TLS| S_gnoi_target

    SU_credentials --> C_gnmi_cap
    SU_entity --> C_gnmi_cap
    SU_xpath --> C_gnmi_cap

    CG -->|generates certs for| S_gnmi_target
    CG -->|generates certs for| S_gnoi_target
    CG -->|generates certs for| C_gnmi_cap
    CG -->|generates certs for| C_gnoi_cert

    TH_orch -->|Docker API| S_gnmi_target
    TH_orch -->|Docker API| S_gnoi_target
    TH_orch -->|Docker API| S_mockos
    TH_orch -->|Docker API| S_gnoi_mockos

    TH_webui -->|HTTP/REST| TH_websrv
    TH_websrv -->|exec CLI| C_gnmi_cap
    TH_websrv -->|exec CLI| C_gnmi_get
    TH_websrv -->|exec CLI| C_gnmi_set
    TH_websrv -->|exec CLI| C_gnmi_sub
    TH_websrv -->|exec CLI| C_gnoi_cert
    TH_websrv -->|exec CLI| C_gnoi_os
    TH_websrv -->|exec CLI| C_gnoi_reset

    %% Click Events
    click PL_gnmi "https://github.com/google/gnxi/tree/master/gnmi/"
    click PL_gnoi "https://github.com/google/gnxi/tree/master/gnoi/"
    click C_gnmi_cap "https://github.com/google/gnxi/blob/master/gnmi_capabilities/gnmi_capabilities.go"
    click C_gnmi_get "https://github.com/google/gnxi/blob/master/gnmi_get/gnmi_get.go"
    click C_gnmi_set "https://github.com/google/gnxi/blob/master/gnmi_set/gnmi_set.go"
    click C_gnmi_sub "https://github.com/google/gnxi/blob/master/gnmi_subscribe/gnmi_subscribe.go"
    click C_gnoi_cert "https://github.com/google/gnxi/blob/master/gnoi_cert/gnoi_cert.go"
    click C_gnoi_os "https://github.com/google/gnxi/blob/master/gnoi_os/gnoi_os.go"
    click C_gnoi_reset "https://github.com/google/gnxi/blob/master/gnoi_reset/gnoi_reset.go"
    click C_py_cli "https://github.com/google/gnxi/blob/master/gnmi_cli_py/py_gnmicli.py"
    click VAL "https://github.com/google/gnxi/tree/master/oc_config_validate/oc_config_validate/"
    click S_gnmi_target "https://github.com/google/gnxi/blob/master/gnmi_target/gnmi_target.go"
    click S_gnoi_target "https://github.com/google/gnxi/blob/master/gnoi_target/gnoi_target.go"
    click S_mockos "https://github.com/google/gnxi/blob/master/utils/mockos/mockos.go"
    click S_gnoi_mockos "https://github.com/google/gnxi/blob/master/gnoi_mockos/gnoi_mockos.go"
    click TH_orch "https://github.com/google/gnxi/tree/master/gnxi_tester/orchestrator/"
    click TH_websrv "https://github.com/google/gnxi/tree/master/gnxi_tester/web/"
    click TH_webui "https://github.com/google/gnxi/tree/master/gnxi_tester/web_ui/"
    click SU_credentials "https://github.com/google/gnxi/blob/master/utils/credentials/credentials.go"
    click SU_entity "https://github.com/google/gnxi/blob/master/utils/entity/entity.go"
    click SU_xpath "https://github.com/google/gnxi/tree/master/utils/xpath/"
    click CG "https://github.com/google/gnxi/blob/master/certs/generate.sh"

    %% Styles
    classDef go fill:#ADD8E6,stroke:#000;
    classDef python fill:#90EE90,stroke:#000;
    classDef js fill:#FFD580,stroke:#000;
    classDef shell fill:#DDA0DD,stroke:#000;
```
