Skip to content

User Documentation

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 aicr CLI tool
  • Deploy the AICR agent to capture cluster snapshots
  • Generate recipes and bundles for their environments
  • Use the API for programmatic configuration generation

Documents

DocumentDescription
InstallationInstall the aicr CLI (automated script, manual, or build from source)
CLI ReferenceComplete command reference with examples for all CLI operations
API ReferenceREST API quick start and endpoint documentation
Agent DeploymentDeploy the Kubernetes agent for automated cluster snapshots
Component CatalogEvery component that can appear in a recipe

Quick Start

shell
# Install aicr CLI (Homebrew)
brew tap NVIDIA/aicr
brew install aicr

# Or use the install script
curl -sfL https://raw.githubusercontent.com/NVIDIA/aicr/main/install | 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

Released under the Apache 2.0 License.