Document builder key for EC extension charts and airgap bundle structure#4283
Merged
Conversation
…tructure docs Add the builder field to the EC Config extensions.helmCharts reference so vendors know they can use it for airgap image discovery on extension charts. Update the airgap install overview to describe the bundle's internal structure (which files contain app images vs extension images vs EC infra images). Add builder key guidance to the air gap support steps for extensions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-actions
Bot
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
sgalsaleh
reviewed
Jul 20, 2026
| ``` | ||
| </details> | ||
|
|
||
| **b. Rewrite image references** in each extension using either the [ReplicatedImageName](/embedded-cluster/v3/template-functions#replicatedimagename) template function (if the chart uses a single field for the full image reference) or the [ReplicatedImageRegistry](/embedded-cluster/v3/template-functions#replicatedimageregistry) template function (if the chart uses separate fields for registry and repository). |
Member
There was a problem hiding this comment.
should this clarify that the use of these template functions should only be done in the values field because i don't the builder field supports template functions iirc.
sgalsaleh
reviewed
Jul 20, 2026
| * `assets/APP_SLUG.airgap` containing application images and Helm extension images in a Docker registry format | ||
| * `assets/ec-VERSION.airgap` containing Embedded Cluster infrastructure images (k0s, Calico, CoreDNS, OpenEBS, and other built-in components) | ||
|
|
||
| Application images and Helm extension images are stored in separate registries within the bundle. Application images are in the `images/` directory of the app `.airgap` file. Extension images are in the `embedded-cluster/` directory. At install time, application images are loaded into a Docker registry deployed to the cluster, while infrastructure and extension images are preloaded directly into containerd on each node. |
Member
There was a problem hiding this comment.
i think this is inaccurate. the extensions images are also pushed into the deployed registry, they're not treated as the other infra/addons images.
Member
There was a problem hiding this comment.
in v2 there were treated like other infra images, but not in v3
…rity - Extension images are loaded into the deployed registry in v3 (not preloaded into containerd like infra images). Fix the bundle structure description to reflect this. - Add explicit note that the builder key does not support template functions. Separate the builder example from the values/template function examples so the distinction is clear. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
sgalsaleh
approved these changes
Jul 20, 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
2 participants
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.
Preview links
Summary
builderfield to the EC Configextensions.helmChartsreference so vendors know they can use it for airgap image discovery on extension chartsbuilderkey guidance and example to the air gap support steps for extensionsContext
Came out of a conversation with Salah and Evans about extension chart images in airgap bundles. The
builderkey works for extensions (sameChartSpecstruct in the airgap builder), but was not documented anywhere. The bundle structure documentation was also a single sentence that didn't explain where extension images vs app images live, which caused confusion when inspecting bundle contents.Test plan
builderfield description in embedded-config.mdx renders correctly