Skip to content

Latest commit

 

History

History

README.md

Recipe Data Directory

Recipe metadata and component configurations for the AICR bundler. Files in this directory are embedded into the CLI binary and API server at compile time.

Quick Reference

Task Documentation
Recipe architecture Data Architecture
Create/modify recipes Recipe Development Guide
Add or modify components Components
CLI commands CLI Reference

Directory Structure

recipes/
├── registry.yaml                  # Component registry (Helm & Kustomize configs)
├── overlays/                      # Recipe overlays (including base.yaml as root)
├── mixins/                        # Composable mixin fragments
│   ├── os-ubuntu.yaml             # Ubuntu OS constraints
│   ├── platform-inference.yaml    # Inference gateway components
│   └── platform-kubeflow.yaml     # Kubeflow trainer component
├── checks/                        # Component health checks
├── validators/                    # Validator catalog (catalog.yaml)
└── components/                    # Per-component Helm/Kustomize values

Recipe naming convention: {accelerator}-{service}-{os}-{intent}-{platform}.yaml (each segment optional except where required by the base inheritance chain).

Examples: h100-eks-training.yaml, h100-eks-ubuntu-training.yaml, h100-eks-ubuntu-training-kubeflow.yaml.

Architecture

The recipe system uses a base-plus-overlay architecture with mixin composition:

  • Base (overlays/base.yaml) provides default configurations
  • Overlays provide environment-specific optimizations and inherit from a parent via spec.base
  • Mixins (mixins/*.yaml) provide shared fragments composed via spec.mixins instead of duplication
  • Inline overrides allow per-recipe customization

Validation

All recipe metadata and component values are validated as part of make test:

  • Schema conformance, criteria enums, valuesFile path resolution
  • Constraint syntax, no duplicate criteria across overlays, merge consistency
make test
go test -v ./pkg/recipe/... -run TestNoDuplicateCriteriaAcrossOverlays

For details, see Automated Tests.

See Also