Skip to content

Latest commit

 

History

History
116 lines (94 loc) · 5.73 KB

README.md

File metadata and controls

116 lines (94 loc) · 5.73 KB

Documentation Index

This directory contains the long-form documentation for llm-observability-stack. The top-level README.md is the fast entry point; these documents cover architecture, deployment profiles, local operations, troubleshooting, validation, and publishing.

The documentation is organized around private LLM deployment and observability on k3s/Kubernetes with CPU-only and NVIDIA GPU paths. The verified local reference environment is Xubuntu 24 with k3s and an NVIDIA GPU.

Start Here

  1. DEPENDENCY-AUDIT-2026-07-19.md
  2. QWEN-1.8B-LIVE-VALIDATION-2026-07-18.md
  3. LIVE-VALIDATION-GO-NATIVE-2026-07-18.md
  4. LIVE-VALIDATION-2026-07-17.md
  5. QUICKSTART.md
  6. cli.md
  7. K3S-NVIDIA-EDGE-DEPENDENCY.md
  8. CONFIG-PROFILES.md
  9. XUBUNTU-K3S-NVIDIA-RUNBOOK.md
  10. ARCHITECTURE.md
  11. OPERATIONS-RUNBOOK.md
  12. PROJECT-DOCUMENTATION.md
  13. LANGUAGE-BOUNDARIES.md
  14. GO-NATIVE-MIGRATION-2026-07-18.md

External companion:

  • gguf-observability provides read-only, model-selectable runtime contract checks and sanitized evidence. It does not replace this repository's Helm, Modelfile, or benchmark assets.

Dashboard presentation is now owned by the Helm-provisioned Grafana JSON in ../dashboards/; there is no separate browser application or browser-side Kubernetes access path.

Core Guides

  • MULTI-MODEL-LOW-VRAM.md

    • Sequential Qwen, Gemma, and Llama deployment with a 900 MiB observed VRAM ceiling.
  • QUICKSTART.md

    • Fast local setup for k3s, values files, image build/import, install, and first validation.
  • cli.md

    • Go CLI build instructions, commands, profile mapping, install/validate/benchmark/uninstall examples, and two-layer architecture notes.
  • K3S-NVIDIA-EDGE-DEPENDENCY.md

    • Required install order and ownership boundary between k3s-nvidia-edge and this LLM stack.
  • CONFIG-PROFILES.md

    • Canonical comparison of git-tracked defaults, local example values, GPU profiles, CPU profiles, and private overrides.
  • XUBUNTU-K3S-NVIDIA-RUNBOOK.md

    • Current local runbook for Xubuntu 24 + k3s + NVIDIA GPU, based on the active local deployment.
  • LOCAL-K3S-NVIDIA-RUNBOOK.md

    • Existing local k3s/NVIDIA command reference.
  • ARCHITECTURE.md

    • Component ownership, request paths, service exposure, and configuration boundaries.
  • LANGUAGE-BOUNDARIES.md

    • Go-first runtime, optional notebook Python, Bash, and Helm/YAML ownership rules.
  • OPERATIONS-RUNBOOK.md

    • Day-0 and day-1 tasks: deploy, verify, port-forward, rebuild images, debug, and clean up.
  • NOTEBOOKS-GUIDE.md

    • Walkthrough of notebooks 01 through 10, their prerequisites, and common execution pitfalls.
  • PROJECT-DOCUMENTATION.md

    • Full repository documentation, component walkthroughs, and deployment model.
  • PROJECT-ANALYSIS.md

    • Current-state summary and hardening priorities.

Kubernetes and Automation Guides

Local Validation

Git and Publishing

Suggested Reading Paths

Supporting Script Docs

Related Component Docs