You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user/api-reference.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -367,7 +367,7 @@ Generate deployment bundles from a recipe.
367
367
368
368
| Parameter | Type | Default | Description |
369
369
|-----------|------|---------|-------------|
370
-
|`bundlers`| string | (all) | Comma-delimited list of bundler types to execute. **Not currently honored — all bundlers run regardless ([#1531](https://github.com/NVIDIA/aicr/issues/1531)).**|
370
+
|`bundlers`| string | (all) | Comma-delimited list of recipe component names to bundle (e.g. `gpu-operator,network-operator`). Whitespace around names is trimmed. Components not listed are skipped as if disabled (their dependency edges are treated as satisfied externally). A name the recipe does not declare, or one that is disabled (by the recipe or a `set``enabled=false` override), is rejected with HTTP 400.|
371
371
|`set`| string[]|| Value overrides (format: `bundler:path.to.field=value`). Repeat for multiple. |
372
372
|`dynamic`| string[]|| Declare value paths as install-time parameters (format: `component:path.to.field`). Repeat for multiple. Supported with `deployer=helm`, `deployer=argocd-helm`, `deployer=flux`, and `deployer=helmfile`. |
373
373
|`system-node-selector`| string[]|| Node selectors for system components (format: `key=value`). Repeat for multiple. |
@@ -386,7 +386,7 @@ The request body is the recipe (RecipeResult) directly. No wrapper object needed
386
386
387
387
#### Components
388
388
389
-
These are the recipe **components** in [`recipes/registry.yaml`](https://github.com/NVIDIA/aicr/blob/main/recipes/registry.yaml). (The `bundlers` query parameter that would select a subset is currently ignored — all run regardless, #1531.) The registry is the authoritative source — see the [component catalog](component-catalog.md) for the full, current list with detailed descriptions. The table below is illustrative of commonly used components:
389
+
These are the recipe **components** in [`recipes/registry.yaml`](https://github.com/NVIDIA/aicr/blob/main/recipes/registry.yaml) — the names the `bundlers` query parameter accepts (a request may only name components the recipe declares). The registry is the authoritative source — see the [component catalog](component-catalog.md) for the full, current list with detailed descriptions. The table below is illustrative of commonly used components:
390
390
391
391
| Component | Description |
392
392
|-----------|-------------|
@@ -436,12 +436,13 @@ These are the recipe **components** in [`recipes/registry.yaml`](https://github.
436
436
> a few component fields shown) — use a generated `RecipeResult`, not these
437
437
> literals.
438
438
>
439
-
> The `bundlers` query parameter is **not currently honored** — all bundlers run
440
-
> regardless ([#1531](https://github.com/NVIDIA/aicr/issues/1531)). There is no
441
-
> supported way to bundle a subset via the API today: hand-trimming
442
-
> `componentRefs` is unsafe (it silently drops required dependencies and breaks
443
-
> deployers like Helmfile on dangling `dependencyRefs`). Bundle the full
444
-
> hydrated result.
439
+
> To bundle a subset of the recipe's components, use the `bundlers` query
440
+
> parameter (e.g. `?bundlers=gpu-operator,network-operator`) rather than
441
+
> hand-trimming `componentRefs` — trimming the body silently drops required
442
+
> dependencies and breaks deployers like Helmfile on dangling
443
+
> `dependencyRefs`. The filter prunes those edges safely (a filtered-out
444
+
> dependency is assumed satisfied externally) and rejects unknown or disabled
0 commit comments