Skip to content

Commit 625fe4c

Browse files
committed
docs: add profile installation instructions
Signed-off-by: Kevin Stellmacher <dev@stellmacher.xyz>
1 parent 288ce7f commit 625fe4c

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

how-to-guides/install-air-gapped.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,42 @@ Install as usual. For each image, the operator creates a `Resource` object, look
224224
address in the transferred manifest, and writes it into the Helm values before the chart
225225
is applied.
226226

227+
### Declare images in the profile, not in values
228+
229+
This is the part people get wrong. An image is localized only if the profile declares it
230+
under `imageResources`:
231+
232+
```yaml
233+
services:
234+
openfga:
235+
imageResources:
236+
- name: openfga-image
237+
annotations:
238+
repo: oci
239+
artifact: image
240+
for: openfga
241+
image-ref: combined
242+
```
243+
244+
Setting the image under `values` instead localizes nothing:
245+
246+
```yaml
247+
services:
248+
openfga:
249+
values:
250+
image:
251+
repository: openfga/openfga # stays exactly this, gap or no gap
252+
tag: v1.14.0
253+
```
254+
255+
Neither case reports an error. Without an `imageResources` entry no `Resource` object is
256+
created, so there is nothing to resolve and the chart uses whatever the values say.
257+
258+
If you set both, the injection wins and your value is quietly ignored. Our own test profile
259+
pinned `kcp.image.tag: v0.32.0` under values while also declaring the image resource, and
260+
the pods came up with `v0.32.2` from the component. Worth knowing before you spend an hour
261+
wondering why a pinned version has no effect.
262+
227263
## What you have to mirror yourself
228264

229265
Two groups of images are outside the operator's reach.

0 commit comments

Comments
 (0)