aicr.run

module
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2026 License: Apache-2.0

README

NVIDIA AI Cluster Runtime

On Push CI On Tag Release License

AI Cluster Runtime (AICR) makes it easy to stand up GPU-accelerated Kubernetes clusters. It captures known-good combinations of drivers, operators, kernels, and system configurations and publishes them as version-locked recipes — reproducible artifacts for Helm, Argo CD, Flux, and Helmfile.

Full documentation: docs.nvidia.com/aicr

Why We Built This

Running GPU-accelerated Kubernetes clusters reliably is hard. Small differences in kernel versions, drivers, container runtimes, operators, and Kubernetes releases can cause failures that are difficult to diagnose and expensive to reproduce.

Historically, this knowledge has lived in internal validation pipelines and runbooks. AI Cluster Runtime makes it available to everyone.

Every AICR recipe is:

  • Optimized — Tuned for a specific combination of hardware, cloud, OS, and workload intent.
  • Validated — Passes automated constraint and compatibility checks before publishing.
  • Reproducible — Same inputs produce identical deployments every time.

Every AICR recipe also carries two kinds of cryptographic proof: where it came from (provenance — signed by NVIDIA CI, verifiable offline) and, for recipes with published evidence, what their validation recorded (validity — a signer-bound, tamper-evident attestation that binds an identity to a recorded aicr validate result, from contributors with cluster access NVIDIA doesn't have). See SECURITY.md and the bundle attestation, recipe evidence, and build provenance demos for the full chain.

Quick Start

# Install the 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 --os ubuntu \
  --intent training --platform kubeflow -o recipe.yaml

# Render it into deployment-ready bundles (helm, argocd, argocd-helm, flux, helmfile, terraform, or fleet)
aicr bundle --recipe recipe.yaml --deployer argocd --output ./bundles

# After deploying the bundle, validate the running cluster against the recipe
# the bundle deployed (every bundle records it at its root)
aicr validate --recipe ./bundles/recipe.yaml

# Select hydrated config value (e.g., the resolved GPU driver version)
aicr query --service eks --accelerator h100 --os ubuntu \
  --intent training --platform kubeflow \
  --selector components.gpu-operator.values.driver.version

The contents of the bundles/ directory depend on the chosen --deployer: Argo CD Application manifests for argocd, a Helm chart app-of-apps for argocd-helm, HelmRelease and Kustomization manifests for flux, helmfile.yaml release graph for helmfile, a Terraform module with one call per component for terraform, Fleet fleet.yaml bundles and a GitRepo (or HelmOps) for fleet, or simple Helm commands for helm.

To use a catalog you own entirely, add --data ./catalog --external-only to the catalog-consuming commands. See fully external catalogs for required files and configuration.

See the Installation Guide for manual installation, building from source, and container images.

Features

Feature Description
aicr CLI Single binary for the full workflow: snapshot, recipe, bundle, validate, verify, diff, and trust management.
API Server (aicrd) REST API exposing the same capabilities as the CLI. Run in-cluster for CI/CD integration or air-gapped environments.
Go Library (aicr.run/pkg/client/v1) Stable Go SDK facade for in-process consumers — same workflow (resolve, bundle, snapshot, validate) callable from any Go program without a subprocess or REST hop. Per-Client isolation supports multi-tenant use.
Snapshot Agent Kubernetes Job that captures live cluster state (GPU hardware, drivers, kernel, OS, operators, K8s config) into a ConfigMap for validation against recipes.
Multi-Deployer Bundles Render the same recipe into Helm, Argo CD (App of Apps or Helm chart variant), Flux, Helmfile, Terraform, or Rancher Fleet artifacts — pick whichever fits your GitOps pipeline.
Multi-Phase Validation Deployment, performance (training and inference), and conformance phases — run all or one at a time.
Drift Detection aicr diff compares two snapshots to surface configuration drift between clusters or over time.
Supply Chain Security SLSA Build Level 3 image provenance, signed image SBOMs, image attestations (Cosign / Sigstore), and aicr verify for offline bundle verification.

Supported Components

AICR recipes compose components from the following groups:

Group Examples
GPU stack GPU Operator, DRA GPU Driver, Network Operator, NFD, NVSentinel
Cloud integration AWS EFA, AWS EBS CSI, GKE NCCL TCPXO
Node tuning Nodewright Operator and customizations, cert-manager
Observability kube-prometheus-stack, Prometheus Operator CRDs, Prometheus Adapter, ephemeral-storage metrics
Training platforms Kubeflow Trainer, Slinky Slurm Operator, KAI Scheduler, Kueue
Inference platforms Dynamo, Grove, NIM Operator, Agent Gateway

See the full Component Catalog for every component, pinned version, and source. Don't see what you need? Open an issue — feedback helps inform future validation priorities.

Supported Environments
Dimension Values
Services AKS, BCM, CKS (Preview), EKS, generic, GKE, k0s, Kind, LKE, Metal3, MK8s, NVKE, OCP, OKE, RKE2
Accelerators A100, B200, B300, GB200, GB300, H100, H200, L40, L40S, RTX PRO 6000, VR200 (Preview)
Operating systems Amazon Linux, COS, Oracle Linux, RHEL, Rocky Linux, SLES, Talos, Ubuntu
Workload intents Inference, Training
Platforms Dynamo, Kubeflow, Kueue, NIM, Run:ai, Slurm (Slinky)

How It Works

A recipe is a version-locked configuration for a specific environment. You describe your target (cloud, GPU, OS, workload intent, optional platform), and the recipe engine matches it against a library of validated overlays — layered configurations that compose bottom-up from base defaults through cloud, accelerator, OS, and workload-specific tuning. Composable mixins carry shared fragments (OS constraints, platform components) so a leaf overlay only declares what is unique to it.

The bundler materializes a recipe into deployment-ready artifacts: one folder per component, each with Helm values, checksums, and a README. The validator compares a recipe against a live cluster snapshot — first checking declarative constraints, then optionally running deployment, performance, and conformance phases inside the cluster.

This separation means the same validated configuration works whether you deploy with Helm, Argo CD, Flux, Helmfile, Terraform, Rancher Fleet, or a custom pipeline.

What AI Cluster Runtime Is Not

  • Not a Kubernetes distribution
  • Not a cluster provisioner or lifecycle management system
  • Not a managed control plane or hosted service
  • Not a replacement for your cloud provider or OEM platform
  • Not a generic configuration management platform

At its core, AICR is a cluster configuration generator. You bring your GPU-accelerated Kubernetes cluster and your deployment tooling; AICR generates the runtime configuration artifacts your tools deploy to the cluster. AICR can also validate that the configuration was correctly materialized and that it delivers the expected performance characteristics.

Documentation

Full documentation lives at docs.nvidia.com/aicr. Key entry points:

For contributors:

Resources

  • Roadmap — Focus areas, outcomes, and tracking issues
  • Adopters — Organizations and projects using or building on AICR
  • Security — Supply chain security, vulnerability reporting, and verification
  • Releases — Binaries, SBOMs, and attestations
  • Support — Where to ask questions, report bugs, and report vulnerabilities
  • Issues — Bugs and scoped feature requests
  • Slack — #aicr on Kubernetes Slack for questions (visit slack.k8s.io for a workspace invitation)

Contributing

AI Cluster Runtime is under Apache 2.0 LICENSE. Contributions are welcome: new recipes for environments we haven't covered, additional bundler formats, validation checks, or bug reports. See CONTRIBUTING.md for development setup and the PR process.

Directories

Path Synopsis
api
operator/v1alpha1
Package v1alpha1 contains the operator.aicr.run/v1alpha1 API: ClusterRuntime and RuntimeRollout (docs/operator/api.md).
Package v1alpha1 contains the operator.aicr.run/v1alpha1 API: ClusterRuntime and RuntimeRollout (docs/operator/api.md).
cmd
aicr command
aicr-operator command
Command aicr-operator runs the AICR Operator manager.
Command aicr-operator runs the AICR Operator manager.
aicr-registry command
Command aicr-registry is the AICR Operator's in-cluster OCI registry: CNCF Distribution's registry with only filesystem storage and htpasswd authentication linked in, built with AICR's toolchain and dependencies so it ships with their security fixes.
Command aicr-registry is the AICR Operator's in-cluster OCI registry: CNCF Distribution's registry with only filesystem storage and htpasswd authentication linked in, built with AICR's toolchain and dependencies so it ships with their security fixes.
aicrd command
gate command
Command gate runs a Chainsaw test bundle in a polling loop against the cluster reachable from the current KUBECONFIG / in-cluster service account.
Command gate runs a Chainsaw test bundle in a polling loop against the cluster reachable from the current KUBECONFIG / in-cluster service account.
kubectl-aicr command
Command kubectl-aicr is the kubectl aicr plugin: describe, approve and revoke AICR Operator rollouts.
Command kubectl-aicr is the kubectl aicr plugin: describe, approve and revoke AICR Operator rollouts.
pkg
allocpolicy
Package allocpolicy is the canonical, dependency-neutral owner of the #1327 GPU allocation-policy descriptor and the shared advertiser vocabulary and tuple-coherence rules (ADR-015, "GKE amendment to the #1327 allocation-policy model").
Package allocpolicy is the canonical, dependency-neutral owner of the #1327 GPU allocation-policy descriptor and the shared advertiser vocabulary and tuple-coherence rules (ADR-015, "GKE amendment to the #1327 allocation-policy model").
artifact
Package artifact defines the neutral release inventory and catalog bindings.
Package artifact defines the neutral release inventory and catalog bindings.
bom
Package bom builds CycloneDX 1.6 software bills-of-materials describing the container images AICR can deploy.
Package bom builds CycloneDX 1.6 software bills-of-materials describing the container images AICR can deploy.
bundler
Package bundler provides orchestration for generating deployment bundles from recipes.
Package bundler provides orchestration for generating deployment bundles from recipes.
bundler/attestation
Package attestation provides bundle attestation using Sigstore signing.
Package attestation provides bundle attestation using Sigstore signing.
bundler/bundleinfo
Package bundleinfo defines bundle-info.yaml, the bundle-root build record written at the root of every generated deployment bundle.
Package bundleinfo defines bundle-info.yaml, the bundle-root build record written at the root of every generated deployment bundle.
bundler/checksum
Package checksum provides closed-world SHA256 bundle inventories.
Package checksum provides closed-world SHA256 bundle inventories.
bundler/config
Package config provides configuration options for bundler implementations.
Package config provides configuration options for bundler implementations.
bundler/deployer
Package deployer defines the shared interface and types for bundle deployers.
Package deployer defines the shared interface and types for bundle deployers.
bundler/deployer/argocd
Package argocd provides Argo CD Application generation for recipes.
Package argocd provides Argo CD Application generation for recipes.
bundler/deployer/argocd/argocdtest
Package argocdtest provides child Application name fixtures shared by the argocd and argocd-helm deployer tests.
Package argocdtest provides child Application name fixtures shared by the argocd and argocd-helm deployer tests.
bundler/deployer/argocdhelm
Package argocdhelm generates a Helm chart app-of-apps for Argo CD with dynamic install-time values.
Package argocdhelm generates a Helm chart app-of-apps for Argo CD with dynamic install-time values.
bundler/deployer/deployertest
Package deployertest provides recipe fixtures shared by the deployer tests.
Package deployertest provides recipe fixtures shared by the deployer tests.
bundler/deployer/fleet
Package fleet generates a Rancher Fleet bundle from AICR recipes, as a GitRepo (ModeGitRepo, the default) or as HelmOps (ModeHelmOp).
Package fleet generates a Rancher Fleet bundle from AICR recipes, as a GitRepo (ModeGitRepo, the default) or as HelmOps (ModeHelmOp).
bundler/deployer/flux
Package flux provides Flux manifest generation for AICR recipes.
Package flux provides Flux manifest generation for AICR recipes.
bundler/deployer/helm
Package helm generates per-component Helm bundles from recipe results.
Package helm generates per-component Helm bundles from recipe results.
bundler/deployer/helmfile
Package helmfile generates a helmfile.yaml release graph from a configured recipe.
Package helmfile generates a helmfile.yaml release graph from a configured recipe.
bundler/deployer/localformat
Package localformat writes the uniform numbered local-chart bundle layout.
Package localformat writes the uniform numbered local-chart bundle layout.
bundler/deployer/localformat/localformattest
Package localformattest provides a localformat.ChartPuller for tests.
Package localformattest provides a localformat.ChartPuller for tests.
bundler/deployer/terraform
Package terraform generates a Terraform module from an AICR recipe: a root module by default, or a child module to call from a configuration that owns the helm provider.
Package terraform generates a Terraform module from an AICR recipe: a root module by default, or a child module to call from a configuration that owns the helm provider.
bundler/drainscope
Package drainscope owns what NVSentinel's node-drainer may evict and how long it waits: the namespaces a drain never evicts from, and the default drain mode.
Package drainscope owns what NVSentinel's node-drainer may evict and how long it waits: the namespaces a drain never evicts from, and the default drain mode.
bundler/gatemanifest
Package gatemanifest synthesizes the Kubernetes manifests for a component readiness gate Job (ServiceAccount, RBAC, ConfigMap, Job).
Package gatemanifest synthesizes the Kubernetes manifests for a component readiness gate Job (ServiceAccount, RBAC, ConfigMap, Job).
bundler/registry
Package registry provides thread-safe registration and retrieval of bundler implementations.
Package registry provides thread-safe registration and retrieval of bundler implementations.
bundler/result
Package result provides types for tracking bundle generation results.
Package result provides types for tracking bundle generation results.
bundler/types
Package types defines the type system for bundler implementations.
Package types defines the type system for bundler implementations.
bundler/verifier
Package verifier implements offline bundle verification with a four-level trust model.
Package verifier implements offline bundle verification with a four-level trust model.
chainsaw
Package chainsaw executes Chainsaw-style assertions against a live Kubernetes cluster, in-process.
Package chainsaw executes Chainsaw-style assertions against a live Kubernetes cluster, in-process.
chainsaw/validation
Package validation checks Chainsaw YAML without executing assertions.
Package validation checks Chainsaw YAML without executing assertions.
chainsawgate/runner
Package runner contains the chainsaw-test evaluation machinery used by the standalone `gate` CLI.
Package runner contains the chainsaw-test evaluation machinery used by the standalone `gate` CLI.
cli
Package cli implements the command-line interface for the AICR aicr tool.
Package cli implements the command-line interface for the AICR aicr tool.
client/v1
Package aicr is the public, compatibility-reviewed Go library surface for external consumers of the AI Cluster Runtime.
Package aicr is the public, compatibility-reviewed Go library surface for external consumers of the AI Cluster Runtime.
collector
Package collector provides interfaces and implementations for collecting system configuration data.
Package collector provides interfaces and implementations for collecting system configuration data.
collector/file
Package file provides a configurable parser for line-oriented configuration files (e.g., /etc/default/grub, /etc/os-release, /proc/sys entries).
Package file provides a configurable parser for line-oriented configuration files (e.g., /etc/default/grub, /etc/os-release, /proc/sys entries).
collector/gpu
Package gpu collects GPU hardware data via driver-free NFD/PCI enumeration.
Package gpu collects GPU hardware data via driver-free NFD/PCI enumeration.
collector/k8s
Package k8s collects Kubernetes cluster configuration data.
Package k8s collects Kubernetes cluster configuration data.
collector/network
Package network collects per-hardware-group network topology by ingesting k8s-launch-kit (l8k) cluster-config data and translating it into the NetworkTopology Measurement shape documented in docs/integrator/measurement-api.md.
Package network collects per-hardware-group network topology by ingesting k8s-launch-kit (l8k) cluster-config data and translating it into the NetworkTopology Measurement shape documented in docs/integrator/measurement-api.md.
collector/os
Package os collects operating system configuration data.
Package os collects operating system configuration data.
collector/systemd
Package systemd collects systemd service configuration data.
Package systemd collects systemd service configuration data.
collector/talos
Package talos provides Talos-specific collector implementations used in place of the systemd D-Bus and /proc-based OS collectors when the recipe criteria declares os: talos.
Package talos provides Talos-specific collector implementations used in place of the systemd D-Bus and /proc-based OS collectors when the recipe criteria declares os: talos.
component
Package component provides shared bundler utilities used by pkg/bundler and its deployers.
Package component provides shared bundler utilities used by pkg/bundler and its deployers.
config
Package config defines the AICRConfig file schema accepted by the aicr CLI's --config flag on the snapshot, recipe, bundle, validate, and verify commands.
Package config defines the AICRConfig file schema accepted by the aicr CLI's --config flag on the snapshot, recipe, bundle, validate, and verify commands.
constraints
Package constraints parses and evaluates constraint expressions (e.g.
Package constraints parses and evaluates constraint expressions (e.g.
constraints/expr
Package expr parses constraint expressions ("<operator> <value>") and evaluates them against a single actual value.
Package expr parses constraint expressions ("<operator> <value>") and evaluates them against a single actual value.
corroborate
Package corroborate computes the recipe corroboration consensus model and emits the deterministic interim-evidence dashboard (GP4, #1404; user guide docs/user/evidence-dashboard.md).
Package corroborate computes the recipe corroboration consensus model and emits the deterministic interim-evidence dashboard (GP4, #1404; user guide docs/user/evidence-dashboard.md).
defaults
Package defaults provides centralized configuration constants for the AICR system.
Package defaults provides centralized configuration constants for the AICR system.
deprecation
Package deprecation implements the runtime half of the AICR deprecation channel.
Package deprecation implements the runtime half of the AICR deprecation channel.
diff
Package diff compares AICR snapshots to detect configuration drift.
Package diff compares AICR snapshots to detect configuration drift.
errors
Package errors provides structured error types for better observability and programmatic error handling across the application.
Package errors provides structured error types for better observability and programmatic error handling across the application.
errors/errorstest
Package errorstest provides test assertions on the error code a pkg/errors chain reports.
Package errorstest provides test assertions on the error code a pkg/errors chain reports.
evidence
Package evidence is an umbrella for AICR's evidence kinds.
Package evidence is an umbrella for AICR's evidence kinds.
evidence/allowlist
Package allowlist loads and validates the maintained signer allowlist at recipes/evidence/allowlist.yaml.
Package allowlist loads and validates the maintained signer allowlist at recipes/evidence/allowlist.yaml.
evidence/attestation
Package attestation implements the recipe-test-attestation evidence kind defined in ADR-007 (docs/design/007-recipe-evidence.md).
Package attestation implements the recipe-test-attestation evidence kind defined in ADR-007 (docs/design/007-recipe-evidence.md).
evidence/canonical
Package canonical holds the recipe YAML canonicalization and subject digest that recipe evidence is built and verified against.
Package canonical holds the recipe YAML canonicalization and subject digest that recipe evidence is built and verified against.
evidence/cncf
Package cncf renders CNCF AI Conformance evidence markdown from CTRF reports against a published upstream checklist version.
Package cncf renders CNCF AI Conformance evidence markdown from CTRF reports against a published upstream checklist version.
evidence/cncf/upstreamvalidator
Package upstreamvalidator runs the CNCF AI Conformance submission validator, cncf/k8s-ai-conformance scripts/validate.go, in process at a pinned revision.
Package upstreamvalidator runs the CNCF AI Conformance submission validator, cncf/k8s-ai-conformance scripts/validate.go, in process at a pinned revision.
evidence/index
Package index is the build-time inventory of committed recipe-evidence pointers.
Package index is the build-time inventory of committed recipe-evidence pointers.
evidence/internal/boundedio
Package boundedio puts blocking local-filesystem work behind a cancellation boundary so the evidence publish/sign/verify paths cannot hang indefinitely on a dead NFS/FUSE mount.
Package boundedio puts blocking local-filesystem work behind a cancellation boundary so the evidence publish/sign/verify paths cannot hang indefinitely on a dead NFS/FUSE mount.
evidence/project
Package project synthesizes the source-keyed evidence tree that the GP4 corroborate consensus generator consumes.
Package project synthesizes the source-keyed evidence tree that the GP4 corroborate consensus generator consumes.
evidence/redact
Package redact minimizes the sensitive operational detail an evidence bundle physically ships, while leaving the cryptographic verification story intact.
Package redact minimizes the sensitive operational detail an evidence bundle physically ships, while leaving the cryptographic verification story intact.
evidence/verifier
Package verifier implements `aicr evidence verify`: offline verification of a recipe-evidence bundle (v1 or v2) produced by `aicr validate --emit-attestation`.
Package verifier implements `aicr evidence verify`: offline verification of a recipe-evidence bundle (v1 or v2) produced by `aicr validate --emit-attestation`.
fingerprint
Package fingerprint extracts a structured cluster identity from a snapshot's collector measurements and compares it against a recipe's criteria.
Package fingerprint extracts a structured cluster identity from a snapshot's collector measurements and compares it against a recipe's criteria.
header
Package header provides common header types for AICR data structures.
Package header provides common header types for AICR data structures.
health
Package health computes per-recipe structural health across the whole criteria matrix, as specified by ADR-009 (Recipe Health Tracking).
Package health computes per-recipe structural health across the whole criteria matrix, as specified by ADR-009 (Recipe Health Tracking).
helm
Package helm runs the helm CLI and renders charts with helm template.
Package helm runs the helm CLI and renders charts with helm template.
helm/helmtest
Package helmtest provides test helpers for consumers of pkg/helm.
Package helmtest provides test helpers for consumers of pkg/helm.
inventory
Package inventory reads the installed component inventory from a live cluster and returns it as the component-to-version table an upgrade comparison consumes.
Package inventory reads the installed component inventory from a live cluster and returns it as the component-to-version table an upgrade comparison consumes.
k8s
Package k8s provides Kubernetes integration for AI Cluster Runtime.
Package k8s provides Kubernetes integration for AI Cluster Runtime.
k8s/agent
Package agent provides Kubernetes Job deployment for automated snapshot capture.
Package agent provides Kubernetes Job deployment for automated snapshot capture.
k8s/client
Package client provides a singleton Kubernetes client for efficient cluster interactions.
Package client provides a singleton Kubernetes client for efficient cluster interactions.
k8s/k8stest
Package k8stest provides test helpers that run against an envtest API server.
Package k8stest provides test helpers that run against an envtest API server.
k8s/labels
Package labels provides shared Kubernetes label constants used by both the validator (pkg/validator) and the snapshot agent (pkg/k8s/agent), so neither has to import the other to agree on label keys and values.
Package labels provides shared Kubernetes label constants used by both the validator (pkg/validator) and the snapshot agent (pkg/k8s/agent), so neither has to import the other to agree on label keys and values.
k8s/pod
Package pod provides shared utilities for Kubernetes Job and Pod operations.
Package pod provides shared utilities for Kubernetes Job and Pod operations.
logging
Package logging provides structured logging utilities for AICR components.
Package logging provides structured logging utilities for AICR components.
manifest
Package manifest provides Helm-compatible template rendering for manifest files.
Package manifest provides Helm-compatible template rendering for manifest files.
measurement
Package measurement provides types and utilities for collecting, comparing, and filtering system measurements from various sources (Kubernetes, GPU, OS, SystemD, NodeTopology, NetworkTopology).
Package measurement provides types and utilities for collecting, comparing, and filtering system measurements from various sources (Kubernetes, GPU, OS, SystemD, NodeTopology, NetworkTopology).
mirror
Package mirror discovers container images and Helm charts referenced by a recipe and emits the list in formats consumable by air-gap tools (Hauler, Zarf) and general-purpose formats (JSON, YAML).
Package mirror discovers container images and Helm charts referenced by a recipe and emits the list in formats consumable by air-gap tools (Hauler, Zarf) and general-purpose formats (JSON, YAML).
netutil
Package netutil holds small, dependency-free networking helpers shared across packages that have no other reason to depend on one another (e.g.
Package netutil holds small, dependency-free networking helpers shared across packages that have no other reason to depend on one another (e.g.
oci
Package oci provides functionality for packaging and pushing artifacts to OCI-compliant registries.
Package oci provides functionality for packaging and pushing artifacts to OCI-compliant registries.
operator/aicrjob
Package aicrjob runs AICR as pinned-image Jobs and parses its frozen artifacts: Job specs, run IDs, the version gate, exit-code mapping, and operator-owned types for Snapshot, RecipeResult, the Helm bundle layout and the upgrade-check report, validated against AICR's published schemas.
Package aicrjob runs AICR as pinned-image Jobs and parses its frozen artifacts: Job specs, run IDs, the version gate, exit-code mapping, and operator-owned types for Snapshot, RecipeResult, the Helm bundle layout and the upgrade-check report, validated against AICR's published schemas.
operator/config
Package config holds the operator's installation configuration: the infrastructure the chart sets as values and passes as flags (api.md installation values).
Package config holds the operator's installation configuration: the infrastructure the chart sets as values and passes as flags (api.md installation values).
operator/controller
Package controller hosts the resolver, rollout and credentials controllers as thin adapters over the functional packages.
Package controller hosts the resolver, rollout and credentials controllers as thin adapters over the functional packages.
operator/defaults
Package defaults holds the operator's named defaults and limits, so no timeout or bound is an unexplained literal at a call site.
Package defaults holds the operator's named defaults and limits, so no timeout or bound is an unexplained literal at a call site.
operator/discovery
Package discovery observes Nodes for group membership and homogeneity and orchestrates AICR snapshot and recipe Jobs.
Package discovery observes Nodes for group membership and homogeneity and orchestrates AICR snapshot and recipe Jobs.
operator/engine/argocd
Package argocd implements the engine adapter contract for Argo CD, including current-revision readiness without observedGeneration.
Package argocd implements the engine adapter contract for Argo CD, including current-revision readiness without observedGeneration.
operator/engine/flux
Package flux implements the engine adapter contract for Flux, a follow-on to the Argo CD adapter.
Package flux implements the engine adapter contract for Flux, a follow-on to the Argo CD adapter.
operator/errors
Package errors provides the operator's structured errors.
Package errors provides the operator's structured errors.
operator/evidence
Package evidence binds AICR's deployment validation evidence to what the operator rolled out.
Package evidence binds AICR's deployment validation evidence to what the operator rolled out.
operator/lifecycle
Package lifecycle implements transition assessment, approval and revocation, removal, orphaning and re-adoption.
Package lifecycle implements transition assessment, approval and revocation, removal, orphaning and re-adoption.
operator/manager
Package manager builds the controller-runtime manager that hosts the operator's controllers.
Package manager builds the controller-runtime manager that hosts the operator's controllers.
operator/plan
Package plan parses rendered AICR output into plan documents, computes desiredStateDigest and inputDigest, rebuilds plans from live engine objects, and constructs rollout steps.
Package plan parses rendered AICR output into plan documents, computes desiredStateDigest and inputDigest, rebuilds plans from live engine objects, and constructs rollout steps.
operator/plugin
Package plugin implements the kubectl aicr plugin: describe, approve, acknowledge and revoke rollouts (api.md#approval), and reproduce a plan's bundle with the AICR CLI.
Package plugin implements the kubectl aicr plugin: describe, approve, acknowledge and revoke rollouts (api.md#approval), and reproduce a plan's bundle with the AICR CLI.
operator/registry
Package registry mirrors pinned upstream charts, packages wrapper charts deterministically, and brokers registry credentials.
Package registry mirrors pinned upstream charts, packages wrapper charts deterministically, and brokers registry credentials.
operator/registry/registrytest
Package registrytest serves in-memory OCI registries, and fakes ECR's token API, for tests.
Package registrytest serves in-memory OCI registries, and fakes ECR's token API, for tests.
operator/resolver
Package resolver turns runtime intent into a plan: it maps ClusterRuntime fields onto AICR recipe and bundle arguments, computes the resolution inputDigest, and assembles the plan from a rendered bundle.
Package resolver turns runtime intent into a plan: it maps ClusterRuntime fields onto AICR recipe and bundle arguments, computes the resolution inputDigest, and assembles the plan from a rendered bundle.
operator/version
Package version reports the build identity stamped into the operator binaries at link time.
Package version reports the build identity stamped into the operator binaries at link time.
recipe
Package recipe provides recipe building and matching functionality.
Package recipe provides recipe building and matching functionality.
recipe/catalog
Package catalog provides signing and verification for the AICR recipe catalog (registry.yaml + validators/catalog.yaml).
Package catalog provides signing and verification for the AICR recipe catalog (registry.yaml + validators/catalog.yaml).
recipe/ocisource
Package ocisource provides an owned recipe.DataProvider backed by one immutable-digest-selected OCI recipe artifact.
Package ocisource provides an owned recipe.DataProvider backed by one immutable-digest-selected OCI recipe artifact.
recipe/oskind
Package oskind is the single source of truth for the string values of the OS recipe criterion.
Package oskind is the single source of truth for the string values of the OS recipe criterion.
recipe/providertest
Package providertest provides a recipe.DataProvider over an fs.FS and a writer for --data directories, for tests.
Package providertest provides a recipe.DataProvider over an fs.FS and a writer for --data directories, for tests.
recipe/recipetest
Package recipetest provides recipe-data fixtures for tests in other packages.
Package recipetest provides recipe-data fixtures for tests in other packages.
runid
Package runid generates unique run identifiers shared by the validator and the snapshot agent so both subsystems use one format and one generator.
Package runid generates unique run identifiers shared by the validator and the snapshot agent so both subsystems use one format and one generator.
schema
Package schema derives JSON Schema documents from the Go types that define AICR's published artifacts.
Package schema derives JSON Schema documents from the Go types that define AICR's published artifacts.
serializer
Package serializer provides encoding and decoding of measurement data in multiple formats.
Package serializer provides encoding and decoding of measurement data in multiple formats.
server
Package server implements the aicrd HTTP server: the AICR System Configuration Recommendation API defined in api/aicr/v1/server.yaml.
Package server implements the aicrd HTTP server: the AICR System Configuration Recommendation API defined in api/aicr/v1/server.yaml.
snapshotter
Package snapshotter captures comprehensive system configuration snapshots.
Package snapshotter captures comprehensive system configuration snapshots.
testgrid
Package testgrid maps a recipe's canonical coordinate to the AICR evidence dashboard (validation.aicr.run) and answers "does this coordinate have a dashboard presence?" — the two facts RQ1 (#1283) and RQ2 (#1284) share.
Package testgrid maps a recipe's canonical coordinate to the AICR evidence dashboard (validation.aicr.run) and answers "does this coordinate have a dashboard presence?" — the two facts RQ1 (#1283) and RQ2 (#1284) share.
trust
Package trust manages Sigstore trusted root material for offline attestation verification.
Package trust manages Sigstore trusted root material for offline attestation verification.
tuning
Package tuning computes the nodewright tuning-status matrix: for each (service, accelerator) the catalog resolves, which tuning profile is applied and the pinned versions of the nodewright nvidia-setup / nvidia-tuned / nvidia-tuning-gke packages.
Package tuning computes the nodewright tuning-status matrix: for each (service, accelerator) the catalog resolves, which tuning profile is applied and the pinned versions of the nodewright nvidia-setup / nvidia-tuned / nvidia-tuning-gke packages.
uatbroker
Package uatbroker resolves the UAT reservation registry (infra/uat/reservations.yaml) and expands the nightly version-matrix schedule for the day/night UAT broker (#1274).
Package uatbroker resolves the UAT reservation registry (infra/uat/reservations.yaml) and expands the nightly version-matrix schedule for the day/night UAT broker (#1274).
upgrade
Package upgrade implements ADR-021 component upgrade transition records.
Package upgrade implements ADR-021 component upgrade transition records.
validator
Package validator evaluates a recipe's constraints and validation checks against a cluster snapshot and the live cluster.
Package validator evaluates a recipe's constraints and validation checks against a cluster snapshot and the live cluster.
validator/catalog
Package catalog provides the declarative validator catalog.
Package catalog provides the declarative validator catalog.
validator/ctrf
Package ctrf provides Go types and utilities for the Common Test Report Format (CTRF).
Package ctrf provides Go types and utilities for the Common Test Report Format (CTRF).
validator/labels
Package labels provides shared label constants for validation resources.
Package labels provides shared label constants for validation resources.
validator/v1
Package v1 defines AICR's validator input format (v1alpha1).
Package v1 defines AICR's validator input format (v1alpha1).
version
Package version provides semantic version parsing and comparison with flexible precision support.
Package version provides semantic version parsing and comparison with flexible precision support.
tests
architecture
Package architecture holds the repository-wide architecture gate that keeps pkg/cli and pkg/server consuming business logic only through pkg/client/v1.
Package architecture holds the repository-wide architecture gate that keeps pkg/cli and pkg/server consuming business logic only through pkg/client/v1.
chainsaw/ai-conformance command
ai-conformance-check parses Chainsaw assertion YAML files and verifies that every declared resource exists in the target Kubernetes cluster.
ai-conformance-check parses Chainsaw assertion YAML files and verifies that every declared resource exists in the target Kubernetes cluster.
chainsaw/signing/bundle-attestation-private-sigstore/tlsproxy command
tlsproxy is a minimal HTTPS-termination reverse proxy used only by the private-Sigstore e2e suite.
tlsproxy is a minimal HTTPS-termination reverse proxy used only by the private-Sigstore e2e suite.
notices
Package notices tests the third-party notices generators.
Package notices tests the third-party notices generators.
operator/htpasswd command
Command htpasswd prints a bcrypt htpasswd line for the test registry that tools/operator-kind runs with authentication.
Command htpasswd prints a bcrypt htpasswd line for the test registry that tools/operator-kind runs with authentication.
releasepolicy
Package releasepolicy verifies the release workflow's artifact-promotion boundary, plus the build-input policies that decide what a published image actually contains (see image_cache_policy_test.go).
Package releasepolicy verifies the release workflow's artifact-promotion boundary, plus the build-input policies that decide what a published image actually contains (see image_cache_policy_test.go).
uat
Package uat contains repository contract tests for the cloud UAT pipelines.
Package uat contains repository contract tests for the cloud UAT pipelines.
tools
api-diff-closure command
api-diff-closure inspects repository-local types used by the public SDK.
api-diff-closure inspects repository-local types used by the public SDK.
bom command
Command bom renders every Helm chart in recipes/registry.yaml at its pinned version and emits a CycloneDX 1.6 JSON BOM plus a Markdown summary listing every container image AICR can deploy.
Command bom renders every Helm chart in recipes/registry.yaml at its pinned version and emits a CycloneDX 1.6 JSON BOM plus a Markdown summary listing every container image AICR can deploy.
check-docs-links command
Command check-docs-links verifies that every link on a page Fern publishes reaches something a reader can open.
Command check-docs-links verifies that every link on a page Fern publishes reaches something a reader can open.
check-dynamo-runtime-image command
Command check-dynamo-runtime-image verifies that defaults.DynamoRuntimeImageTag equals the dynamo-platform chart version in recipes/registry.yaml, because an older Dynamo runtime under a newer operator is a known source of frontend discovery panics.
Command check-dynamo-runtime-image verifies that defaults.DynamoRuntimeImageTag equals the dynamo-platform chart version in recipes/registry.yaml, because an older Dynamo runtime under a newer operator is a known source of frontend discovery panics.
cleanup command
Command cleanup removes AICR-installed resources from the cluster of the current kubeconfig context, in four phases:
Command cleanup removes AICR-installed resources from the cluster of the current kubeconfig context, in four phases:
corroborate command
Command corroborate reads the source-keyed corroboration evidence tree (the Contract 3 GCS layout synced to a local directory) and emits the deterministic interim-evidence dashboard: index.json + per-recipe series/<recipe>.json plus a self-contained static HTML/CSS/JS renderer that fetches them.
Command corroborate reads the source-keyed corroboration evidence tree (the Contract 3 GCS layout synced to a local directory) and emits the deterministic interim-evidence dashboard: index.json + per-recipe series/<recipe>.json plus a self-contained static HTML/CSS/JS renderer that fetches them.
coverage command
Command coverage generates docs/user/coverage-matrix.md — a structural matrix of which critical user journeys (CUJs) and CLI verbs are exercised by an in-repo test or demo, on what hardware class, and at what cadence.
Command coverage generates docs/user/coverage-matrix.md — a structural matrix of which critical user journeys (CUJs) and CLI verbs are exercised by an in-repo test or demo, on what hardware class, and at what cadence.
crd-inventory command
Crd-inventory writes recipes/components/<name>/crds.yaml, the CRDs each pinned Helm chart installs, for every component whose health check asserts a CRD.
Crd-inventory writes recipes/components/<name>/crds.yaml, the CRDs each pinned Helm chart installs, for every component whose health check asserts a CRD.
drift-report command
Command drift-report converts a Renovate dry-run report into the weekly component drift report consumed by .github/workflows/registry-drift.yaml and the aicr-reviewing-component-drift skill.
Command drift-report converts a Renovate dry-run report into the weekly component drift report consumed by .github/workflows/registry-drift.yaml and the aicr-reviewing-component-drift skill.
evidence-pointercheck command
Command evidence-pointercheck enforces the per-source evidence-pointer contract (#1347 / #1401) over the committed recipes/evidence/ tree.
Command evidence-pointercheck enforces the per-source evidence-pointer contract (#1347 / #1401) over the committed recipes/evidence/ tree.
evidence-project command
Command evidence-project is the GP2 ingest step.
Command evidence-project is the GP2 ingest step.
health command
Command health computes catalog-wide recipe structural health via pkg/health.Compute and renders a Markdown matrix.
Command health computes catalog-wide recipe structural health via pkg/health.Compute and renders a Markdown matrix.
internal/docgen
Package docgen holds shared plumbing for the hermetic Markdown doc generators (tools/health, tools/tuning): writing a rendered body to a file with the repo's writable-Close() error contract.
Package docgen holds shared plumbing for the hermetic Markdown doc generators (tools/health, tools/tuning): writing a rendered body to a file with the repo's writable-Close() error contract.
k8s-aibom-test/validate-bom command
Command validate-bom checks that a k8s-aibom-emitted document is a well-formed CycloneDX 1.6 ML-BOM.
Command validate-bom checks that a k8s-aibom-emitted document is a well-formed CycloneDX 1.6 ML-BOM.
module-rename command
module-rename rewrites a Go module path across the tracked files of a checkout.
module-rename rewrites a Go module path across the tracked files of a checkout.
nvcre-closure command
Command nvcre-closure derives the NVCRE workload runtime closure: the set of container images the certification workloads pull, which AICR's mirror discovery cannot see.
Command nvcre-closure derives the NVCRE workload runtime closure: the set of container images the certification workloads pull, which AICR's mirror discovery cannot see.
openvex-bind command
Command openvex-bind projects the committed OpenVEX document onto one platform manifest digest, producing the document the release publishes as a `--type openvex` Cosign attestation on that manifest (NVIDIA/aicr#2426).
Command openvex-bind projects the committed OpenVEX document onto one platform manifest digest, producing the document the release publishes as a `--type openvex` Cosign attestation on that manifest (NVIDIA/aicr#2426).
operator-release command
Command operator-release completes a qualification candidate that tools/operator-candidate built: it packages the chart deterministically and records the candidate's identity in candidate.json, with its deployment inputs in candidate-values.yaml.
Command operator-release completes a qualification candidate that tools/operator-candidate built: it packages the chart deterministically and records the candidate's identity in candidate.json, with its deployment inputs in candidate-values.yaml.
registry-inventory command
Command registry-inventory statically extracts every package/container registry AICR's builds, CI, and deploy paths reach out to, from the high-reliability *structured* sources (recipes/registry.yaml, .settings.yaml, .goreleaser.yaml/.ko.yaml, Dockerfiles, .github Actions `uses:` pins).
Command registry-inventory statically extracts every package/container registry AICR's builds, CI, and deploy paths reach out to, from the high-reliability *structured* sources (recipes/registry.yaml, .settings.yaml, .goreleaser.yaml/.ko.yaml, Dockerfiles, .github Actions `uses:` pins).
rekor-monitor command
Command rekor-monitor is AICR's transparency-log monitor for the release signer, running against Rekor v2.
Command rekor-monitor is AICR's transparency-log monitor for the release signer, running against Rekor v2.
schemagen command
Command schemagen writes JSON Schema documents for AICR's published artifacts.
Command schemagen writes JSON Schema documents for AICR's published artifacts.
testgrid-link-check command
Command testgrid-link-check is the warning-only, weekly bot (RQ2 / #1284) that verifies the Evidence deep-links the recipe-health matrix emits (RQ1 / #1283) still resolve against the live evidence dashboard.
Command testgrid-link-check is the warning-only, weekly bot (RQ2 / #1284) that verifies the Evidence deep-links the recipe-health matrix emits (RQ1 / #1283) still resolve against the live evidence dashboard.
testgrid-publish command
Command testgrid-publish converts an AICR evidence OCI bundle into a TestGrid-compatible GCS feed entry.
Command testgrid-publish converts an AICR evidence OCI bundle into a TestGrid-compatible GCS feed entry.
tuning command
Command tuning computes the nodewright tuning-status matrix via pkg/tuning.Compute and renders a Markdown table.
Command tuning computes the nodewright tuning-status matrix via pkg/tuning.Compute and renders a Markdown table.
uat-broker command
Command uat-broker is the day/night UAT broker helper (#1274, DC1).
Command uat-broker is the day/night UAT broker helper (#1274, DC1).
Package validators provides shared utilities for v2 validator containers.
Package validators provides shared utilities for v2 validator containers.
conformance command
conformance is a validator container for all conformance phase checks.
conformance is a validator container for all conformance phase checks.
deployment command
deployment is a validator container for all deployment phase checks.
deployment is a validator container for all deployment phase checks.
helper
Package helper provides shared utilities for v2 validator containers.
Package helper provides shared utilities for v2 validator containers.
internal/gkenet
Package gkenet discovers the GKE multi-NIC networking objects that GPUDirect TCPXO depends on.
Package gkenet discovers the GKE multi-NIC networking objects that GPUDirect TCPXO depends on.
performance command
performance is a validator container for all performance phase checks.
performance is a validator container for all performance phase checks.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL