replicatedhq / replicatedhq/replicated-docs
Airgap image handling with HasLocalRegistry needs a full worked example in docs
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 12
- Forks
- 35
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 113
Description
Problem
Vendors building airgap-compatible Helm charts need to use the HasLocalRegistry template function to conditionally rewrite image references to point at the customer's local registry when airgap mode is active. The docs mention this function but don't include a full worked example showing:
The chart values structure
The template function in a _helpers.tpl
How the rewritten image reference flows through to deployments/statefulsets
What the airgap bundle contains vs what the install expects
Mikhail's path:
Tried overriding images with upstream URLs (as docs suggested) → works for proxy pulls, breaks for airgap installs because private images fail
Reverted to pulling from the proxy → airgap builder appeared to work, but cluster still couldn't pull images when VM was airgapped
Eventually solved it with HasLocalRegistry template conditionally overwriting image references → worked, but painful
Mikhail's quote: "This felt painful. Maybe a full example in the docs would help here."
Source
Mikhail (Hollr bootcamp friction log)
Proposed fix
Add a complete worked example to the airgap / Helm docs showing:
A chart with private images routed through the proxy
The HasLocalRegistry template pattern in _helpers.tpl
Expected behavior in online vs airgap mode
How to verify the airgap bundle contains the images
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing airgap and Helm documentation and the current HasLocalRegistry references. Build the example around chart values, _helpers.tpl, and the deployment/statefulset image references, then document online versus airgap behavior and bundle verification. Done means a reader can follow the example and understand which images the airgap bundle contains and which references the install uses.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm, kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100