Skip to content

README.md

Latest commit

 

History

History
78 lines (65 loc) · 3.97 KB

README.md

File metadata and controls

78 lines (65 loc) · 3.97 KB
Raw

Grid Documentation

Architecture

  • Overview — operator responsibilities, data-plane boundaries, workspace crates, and terminology.
  • Custom Resource Definitions — GridNetwork, GridSite, InferenceProvider, and provider status shape.
  • Routing — versioned overlay contract, revision lifecycle, candidate ordering, intelligent_route, peer_identity_trust, and provider-side request forwarding.
  • Provider Selection and Load Balancing — eligibility, routing groups, scoring, selection modes, affinity, and overlay lifecycle.
  • Scoring — operator-side candidate scoring, metrics input, and request-time scoring boundaries.
  • Auth and Policy — provider authentication strategies, access policy, and trust model.
  • Consumer Config — operator-generated consumer Praxis ConfigMap and the GatewayRef.consumerConfig API.
  • External Client Ingress — GTM/GLB edge selection, Grid provider routing, trust boundaries, affinity, snapshot delivery, and provider-boundary ownership.

Operations

  • Adding an Inference Provider — step-by-step workflow for in-cluster, existing-service, and external HTTPS providers.
  • Operations — local environment setup, validation commands, and operator workflows.
  • CI Kind E2E — validation tiers, gate sequence, sequencing requirements, and environment dependencies.

Examples

  • Example Scenarios 2026 - progressive scenarios covering multi-cluster routing, provider fallback, load balancing, affinity, policy, discovery, federation, and partition handling.
  • Provider Traffic Selection — runnable three-cluster topology for Grid selection groups and request-time round-robin provider choice.
  • Grid QuickStarts — deployable examples with automated runtime proofs of routing, failover, security boundaries, and provider lifecycle.

Integration Qualifications

  • Provider Traffic Qualification - proves multi-cluster discovery, accepted-overlay delivery, request-time round-robin selection, provider attribution, and stable routing.
  • Distributed Token Quota Qualification - proves shared identity-scoped quota enforcement across gateway replicas, regional provider selection, expiry, restart persistence, fail-closed state storage, and storage-network isolation.
  • Single-cluster Multi-gateway Qualification - proves shared overlay delivery and independent consumer/provider gateway behavior within one Kind cluster and one GridSite.

These integration tests create their environments through Forge and execute through first-class Rust xtask commands. Their topology READMEs document image preparation, execution, evidence, and cleanup.

Installation

Development

  • Release Process - versioning, validation, artifact publication, and release workflow.
  • Development — build, test, format, lint, and coverage.
  • Conventions — coding style, testing requirements, documentation rules, and commit attribution.
  • Developing: Conventions — shared Praxis coding, tracing, testing, and review conventions.
  • Developing: Type Design — shared Praxis guidance for serde, enums, newtypes, and representable states.