User Documentation
July 21, 2026 · View on GitHub
Documentation for platform operators deploying and operating GPU-accelerated Kubernetes clusters using AI Cluster Runtime (AICR).
Audience
This section is for users who:
- Install and use the
aicrCLI tool - Deploy the AICR agent to capture cluster snapshots
- Generate recipes and bundles for their environments
- Use the API for programmatic configuration generation
Documents
| Document | Description |
|---|---|
| Installation | Install the aicr CLI (automated script, manual, or build from source) |
| End-to-End Tutorial | Learning path: install → recipe → bundle → deploy → validate, start to finish |
| CLI Reference | Complete command reference with examples for all CLI operations |
| Generating Bundles | Task-oriented how-to: deployers, value overrides, node scheduling, offline/vendored charts, readiness gates |
| Artifact Verification | Verify bundles and recipe-evidence: trust levels, public-trust, KMS/PEM keys, offline, and CI gating |
| API Reference | REST API quick start and endpoint documentation |
| Agent Deployment | Deploy the Kubernetes agent for automated cluster snapshots |
| Validation | Task-oriented walkthrough: validate a cluster against a recipe, both training and inference performance phases |
| Component Catalog | Every component that can appear in a recipe |
| Slurm Accounting | Configure Slinky Slurm accounting with a customer-operated MariaDB database |
| Container Images | Container image inventory across all components (BOM) |
| Recipe Health | Per-recipe health and validation status tracking |
| Air-Gap Mirror | Mirror images and charts for air-gapped deployment |
Quick Start
# Install aicr CLI (Homebrew)
brew tap NVIDIA/aicr
brew install aicr
# Or use the install script
curl -sfL https://get.aicr.run | bash -s --
# Generate a recipe for your environment
aicr recipe --service eks --accelerator h100 --intent training -o recipe.yaml
# Create deployment bundles
aicr bundle --recipe recipe.yaml -o ./bundles
# Deploy to your cluster
cd bundles && chmod +x deploy.sh && ./deploy.sh
Validating a cluster instead of deploying? See Validation for a task-oriented walkthrough covering deployment, performance (training and inference), and conformance phases.
Related Documentation
- Integrators: See Integrator Documentation for CI/CD integration and API server deployment
- Contributors: See Contributor Documentation for architecture and development guides