docs(aim-catalog): describe shipped catalog behaviour, not pending work - #833
Merged
Conversation
The AIM catalog docs described behaviour that only exists in unmerged work, so operators reading them would configure the wrong thing. - Drop AIM_HARDWARE_FAMILY auto-detection claims from the lifecycle doc and chart README; auto-detection is not in cluster-bloom main, where the setting has no default and is injected only when set. Document that an install leaving it unset lands on the unfiltered catalog. - Replace the "published into the chart" source-of-truth framing with the actual manual copy at release time, and drop the dead public aim-build link. Point operators at cluster-managed additions when they need an AIM version before the next release. - Note that aim-cluster-model-source-additional is not shipped and needs one-time operator setup. - Fix stale "legacy" naming in root/values.yaml after the legacy.yaml -> unfiltered.yaml rename. Co-authored-by: Cursor <[email protected]>
AIM Engine discovery is append-only, so dropping an image from a source filter leaves discovered models in place, while deleting the source CR garbage-collects them and can break running deployments. Empty filters are invalid (MinItems=1). Packaged source names are a stable API. Co-authored-by: Cursor <[email protected]>
…ities Operators see the packaged baseline as the Cluster Forge release they installed. Who authored the internal lists is not needed to operate a cluster. Co-authored-by: Cursor <[email protected]>
Q-Dub
force-pushed
the
EAI-7657_docs_reflect_current_catalog_state
branch
from
September 2, 2026 21:23
4041105 to
958d9af
Compare
Q-Dub
enabled auto-merge
September 3, 2026 04:39
lauri-amd
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #831. That PR aligned the AIM catalog docs with the in-tree chart
templates, but left in place several statements that describe behaviour from
work still in flight (EAI-8054,
EAI-8192) rather than what a
maininstall actually does today. This corrects them.1.
AIM_HARDWARE_FAMILYauto-detection is not shippeddocs/aim_model_management.mdand the chart README claimed the family is"auto-detected when omitted", and that "a typical new cluster-bloom install
injects a non-empty list, so it uses profiles".
On
cluster-bloommainthe setting hasdefault: ""(
pkg/config/bloom.yaml.schema.yaml) and is injected onlywhen: AIM_HARDWARE_FAMILY | default('') | length > 0(
bootstrap_gitea.yaml). So an install that leaves it unset injects nothing,the chart default
[]applies, and the cluster gets the unfilteredcatalog — the opposite of what the docs said.
Auto-detection is silogen/cluster-bloom#298, still open. Documented the
current behaviour instead.
2. Source of truth described a publish pipeline that does not exist
The doc said the AIM team's lists "are published into the
aim-cluster-model-sourceHelm chart for clusters to consume" and linkedgithub.com/amd-enterprise-ai/aim-buildas a public repo (it is notreachable; the real repo is private).
Today the chart templates are a hand-copied point-in-time snapshot.
Generating them from
.releasesisEAI-8192 (Backlog), and
silogen/aim-build#1487 states in its own description that "Catalog YAML is
still a hand-copied snapshot". Reworded to say so, and added the
helm templateone-liner operators can use to read the catalog a releasewill install.
3. Smaller corrections
aim-cluster-model-source-additionalis not shipped in Cluster Forge atall; noted that it needs one-time operator setup before the
cluster-managed path works.
sentence and replaced it with the actual per-family base split, including
the
unfilteredexception.root/values.yamlstill saidEmpty = legacyafter thelegacy.yaml→unfiltered.yamlrename in docs: align AIM catalog lifecycle with in-tree chart templates #831.Verification
Rendered both branches against the chart in this tree:
The second invocation confirms the corrected claim: no families set means
unfiltered, not profiles.
Also confirmed
apps.aim-cluster-model-sourceinroot/values.yamlis stillpath: aim-cluster-model-source(in-tree chart, not an OCI pointer), so thedocs correctly continue to describe in-tree packaging.
Test plan
(
#one-time-setup,#add-a-model,#replace-or-remove-a-source,#before-a-platform-upgrade,#cluster-managed-catalog-additions)time (no automated feed) as described
auto-detection description
Made with Cursor