Skip to content

Latest commit

 

History

History
156 lines (122 loc) · 8.98 KB

File metadata and controls

156 lines (122 loc) · 8.98 KB
kars logo

kars — Agent Reference Stack for Kubernetes

The secure, Kubernetes-native runtime for AI agents: one hardened sandbox per agent, zero credentials in the agent, every call governed.

npm License: MIT CI Azure

This is the documentation index. The top-level README is a faster on-ramp; come here when you need depth.

How it works

One hardened sandbox per agent. The agent has no network of its own — every external call (model, tool, MCP, peer) goes through an in-pod Rust inference router that enforces identity, content safety, budgets, governance, and a tamper-evident audit chain. The agent never holds a credential.

flowchart LR
  subgraph Pod["KarsSandbox pod"]
    Agent["agent runtime<br/>(UID 1000, no network)"]
    Router["inference router<br/>(UID 1001, Rust)"]
    Agent -->|localhost only| Router
  end
  Router --> Model["inference backend<br/>(Foundry / Copilot / …)"]
  Router --> Mesh["AgentMesh relay<br/>(opaque ciphertext)"]
  Router --> A2A["A2A peers"]
  classDef pod fill:#e6f0ff,stroke:#0078d4,color:#0b1220
  class Pod pod
Loading

Why kars

Running agents directly Running agents on kars
API keys in the agent's environment Zero credentials in the agent process; the router brokers every call
Governance bolted on per-app, in code Declarative CRDs — approval gates, rate limits, tool allowlists, content-safety floors, token budgets as Kubernetes resources
Network egress wide open Default-deny egress + L7 allowlist + blocklist; the agent has no socket of its own
Inter-agent traffic readable by the broker End-to-end encrypted mesh (Signal Protocol); the relay sees only ciphertext
One framework, lock-in Eight runtimes (OpenClaw, Hermes, MAF, LangGraph, …) on one wire format; switch with a one-field change
Trust boundary = the cluster Trust boundary = the pod — optional Kata + AMD SEV-SNP per workload via one CRD field

Choose your path

Read in order if you are new

  1. Quickstart — a running agent on your laptop in three commands.
  2. Getting started — the full local walkthrough, then AKS.
  3. Architecture — the design and why.
  4. Architecture diagrams — every component, dev and prod side by side.
  5. Use cases — the six scenarios kars was built for.

By audience

You are a… Start here
Executive / decision-maker ArchitectureBlueprintsUse cases
Platform engineer Getting startedOperationsCLI reference
Security engineer Security modelSTRIDERed-team playbookMCP top-10
Agent builder RuntimesCRD referenceCLI reference
Site reliability Operations / GitOpsConditionsEgress proxy

Reference

This section mirrors the chapter groups in SUMMARY.md, which is the canonical, complete table of contents. Every published page has a home below; the descriptions are the curated entry points.

Architecture & design

API & policy

Agent capabilities

  • kars OpenClaw plugin — the in-sandbox plugin (24 governance-aware tools, 10 skills) every kars-managed agent loads.
  • @kars/mesh plugin — the companion local plugin (built from source, not yet published on npm) for pairing a local OpenClaw with a remote kars cluster.
  • Channels & external plugins — Telegram / Slack / Discord / WhatsApp channels + 3rd-party search/scrape API integrations via CLI flags.
  • Operator TUIkars operator, the live cluster dashboard.
  • Permissions model — the Azure RBAC kars up needs, enumerated.
  • Per-sandbox identity — each sandbox runs under its own Entra Agent ID.
  • Examples catalogue — every examples/ blueprint, each a kubectl apply after kars up.

Blueprints

Security

Operations

CLI

Roadmap & ADRs

  • Roadmap — what is shipped, reconciler-only, and planned.
  • ADR index — architecture decision records.

What is not here

docs/internal/ holds historical phase audits, migration logs, and one-off proofs that exist for traceability but are not part of the public surface. They are excluded from the rendered site.

Reading the site offline

make docs-site-serve   # serves at http://localhost:3000
make docs-site         # builds to target/book/index.html

The site is built with mdBook. The chapter index is SUMMARY.md.