Skip to content

Commit ddc7fc1

Browse files
jhadvigclaude
andcommitted
pkg/payload: Add Images map and tolerate unknown template fields during upgrades
Add an Images field to manifestRenderConfig, populated from the release payload's image-references ImageStream. This allows CVO manifests in /manifests/ to reference component images by short name using Go template syntax: {{index .Images "component-name"}}. Make template rendering errors non-fatal during LoadUpdate. When an older CVO binary loads a newer payload that uses template fields the older binary does not know about (e.g. .Images), the manifest is skipped with a warning instead of failing the entire payload load. The new CVO binary will re-load the full payload after it replaces the old one at run-level 0. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 810bfc1 commit ddc7fc1

8 files changed

Lines changed: 146 additions & 3 deletions

File tree

pkg/payload/payload.go

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ func LoadUpdate(dir, releaseImage, excludeIdentifier string, requiredFeatureSet
153153
return nil, err
154154
}
155155

156-
tasks := loadPayloadTasks(releaseDir, cvoDir, releaseImage, profile)
156+
tasks := loadPayloadTasks(releaseDir, cvoDir, releaseImage, profile, payload.ImageRef)
157157

158158
var onlyKnownCaps *configv1.ClusterVersionCapabilitiesStatus
159159

@@ -195,7 +195,13 @@ func LoadUpdate(dir, releaseImage, excludeIdentifier string, requiredFeatureSet
195195
if task.preprocess != nil {
196196
raw, err = task.preprocess(raw)
197197
if err != nil {
198-
errs = append(errs, fmt.Errorf("preprocess %s: %w", file.Name(), err))
198+
// Template rendering may fail when an older CVO binary
199+
// loads a newer payload that uses template fields the
200+
// older binary does not know about (e.g. .Images). Skip
201+
// the manifest with a warning — the new CVO binary will
202+
// re-load the full payload after it replaces the old one
203+
// at run-level 0.
204+
klog.Warningf("Skipping manifest %s: template rendering failed (may require newer CVO): %v", file.Name(), err)
199205
continue
200206
}
201207
}
@@ -317,13 +323,14 @@ type payloadTasks struct {
317323
skipFiles sets.Set[string]
318324
}
319325

320-
func loadPayloadTasks(releaseDir, cvoDir, releaseImage, clusterProfile string) []payloadTasks {
326+
func loadPayloadTasks(releaseDir, cvoDir, releaseImage, clusterProfile string, imageRef *imagev1.ImageStream) []payloadTasks {
321327
cjf := filepath.Join(releaseDir, cincinnatiJSONFile)
322328
irf := filepath.Join(releaseDir, imageReferencesFile)
323329

324330
mrc := manifestRenderConfig{
325331
ReleaseImage: releaseImage,
326332
ClusterProfile: clusterProfile,
333+
Images: imagesFromImageRef(imageRef),
327334
}
328335

329336
return []payloadTasks{{

pkg/payload/payload_test.go

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,28 @@ func TestLoadUpdate(t *testing.T) {
150150
}
151151
}
152152

153+
func TestLoadUpdateSkipsUnknownTemplateFields(t *testing.T) {
154+
update, err := LoadUpdate("testdata/payload-unknown-template", "image:test", "", "", DefaultClusterProfile, nil, sets.Set[string]{})
155+
if err != nil {
156+
t.Fatalf("LoadUpdate should not fail when a manifest uses unknown template fields, got: %v", err)
157+
}
158+
159+
// The valid manifest (using known .ReleaseImage) should be loaded
160+
var foundValid bool
161+
for _, m := range update.Manifests {
162+
if m.OriginalFilename == "0000_00_valid.yaml" {
163+
foundValid = true
164+
}
165+
// The manifest with unknown .FutureField should be skipped (not loaded)
166+
if m.OriginalFilename == "0000_50_unknown-field.yaml" {
167+
t.Error("manifest with unknown template field should have been skipped, but was loaded")
168+
}
169+
}
170+
if !foundValid {
171+
t.Error("expected valid manifest (0000_00_valid.yaml) to be loaded")
172+
}
173+
}
174+
153175
func TestLoadUpdateArchitecture(t *testing.T) {
154176
type args struct {
155177
dir string

pkg/payload/render.go

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import (
2020

2121
"github.com/openshift/api/config"
2222
configv1 "github.com/openshift/api/config/v1"
23+
imagev1 "github.com/openshift/api/image/v1"
2324
"github.com/openshift/library-go/pkg/manifest"
2425
)
2526

@@ -38,6 +39,12 @@ func Render(outputDir, releaseImage, clusterVersionManifestPath, featureGateMani
3839
}
3940
)
4041

42+
imageRef, err := loadImageReferences(releaseManifestsDir)
43+
if err != nil {
44+
return fmt.Errorf("error loading image references for manifest rendering: %w", err)
45+
}
46+
renderConfig.Images = imagesFromImageRef(imageRef)
47+
4148
overrides, err := parseClusterVersionManifest(clusterVersionManifestPath)
4249
if err != nil {
4350
return fmt.Errorf("error parsing cluster version manifest: %w", err)
@@ -181,6 +188,21 @@ func renderDir(renderConfig manifestRenderConfig, idir, odir string, overrides [
181188
type manifestRenderConfig struct {
182189
ReleaseImage string
183190
ClusterProfile string
191+
Images map[string]string
192+
}
193+
194+
// imagesFromImageRef builds a map from image short names to their resolved URIs.
195+
func imagesFromImageRef(imageRef *imagev1.ImageStream) map[string]string {
196+
images := make(map[string]string)
197+
if imageRef == nil {
198+
return images
199+
}
200+
for _, tag := range imageRef.Spec.Tags {
201+
if tag.From != nil && tag.From.Kind == "DockerImage" {
202+
images[tag.Name] = tag.From.Name
203+
}
204+
}
205+
return images
184206
}
185207

186208
// renderManifest Executes go text template from `manifestBytes` with `config`.

pkg/payload/render_test.go

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,76 @@ import (
1515
"k8s.io/apimachinery/pkg/util/sets"
1616
"k8s.io/utils/ptr"
1717

18+
corev1 "k8s.io/api/core/v1"
19+
1820
configv1 "github.com/openshift/api/config/v1"
21+
imagev1 "github.com/openshift/api/image/v1"
1922
"github.com/openshift/library-go/pkg/manifest"
2023
)
2124

25+
func TestImagesFromImageRef(t *testing.T) {
26+
t.Run("nil ImageStream returns empty map", func(t *testing.T) {
27+
images := imagesFromImageRef(nil)
28+
if len(images) != 0 {
29+
t.Errorf("expected empty map, got %v", images)
30+
}
31+
})
32+
33+
t.Run("maps DockerImage tags to their names", func(t *testing.T) {
34+
imageRef := &imagev1.ImageStream{
35+
Spec: imagev1.ImageStreamSpec{
36+
Tags: []imagev1.TagReference{
37+
{
38+
Name: "console",
39+
From: &corev1.ObjectReference{Kind: "DockerImage", Name: "quay.io/openshift/console:latest"},
40+
},
41+
{
42+
Name: "cluster-update-console-plugin",
43+
From: &corev1.ObjectReference{Kind: "DockerImage", Name: "quay.io/openshift/plugin:v1"},
44+
},
45+
},
46+
},
47+
}
48+
images := imagesFromImageRef(imageRef)
49+
if len(images) != 2 {
50+
t.Fatalf("expected 2 images, got %d", len(images))
51+
}
52+
if images["console"] != "quay.io/openshift/console:latest" {
53+
t.Errorf("expected console image, got %q", images["console"])
54+
}
55+
if images["cluster-update-console-plugin"] != "quay.io/openshift/plugin:v1" {
56+
t.Errorf("expected plugin image, got %q", images["cluster-update-console-plugin"])
57+
}
58+
})
59+
60+
t.Run("skips non-DockerImage tags", func(t *testing.T) {
61+
imageRef := &imagev1.ImageStream{
62+
Spec: imagev1.ImageStreamSpec{
63+
Tags: []imagev1.TagReference{
64+
{
65+
Name: "docker-tag",
66+
From: &corev1.ObjectReference{Kind: "DockerImage", Name: "example.com/img:v1"},
67+
},
68+
{
69+
Name: "image-stream-tag",
70+
From: &corev1.ObjectReference{Kind: "ImageStreamTag", Name: "other:latest"},
71+
},
72+
{
73+
Name: "no-from",
74+
},
75+
},
76+
},
77+
}
78+
images := imagesFromImageRef(imageRef)
79+
if len(images) != 1 {
80+
t.Fatalf("expected 1 image, got %d: %v", len(images), images)
81+
}
82+
if _, ok := images["docker-tag"]; !ok {
83+
t.Error("expected docker-tag to be present")
84+
}
85+
})
86+
}
87+
2288
func TestRenderManifest(t *testing.T) {
2389

2490
tests := []struct {
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
apiVersion: v1
2+
kind: ConfigMap
3+
metadata:
4+
name: valid-manifest
5+
namespace: test
6+
annotations:
7+
include.release.openshift.io/self-managed-high-availability: "true"
8+
data:
9+
release-image: '{{.ReleaseImage}}'
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
apiVersion: v1
2+
kind: ConfigMap
3+
metadata:
4+
name: future-manifest
5+
namespace: test
6+
annotations:
7+
include.release.openshift.io/self-managed-high-availability: "true"
8+
data:
9+
image: '{{index .FutureField "some-key"}}'
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"kind": "ImageStream",
3+
"apiVersion": "image.openshift.io/v1",
4+
"metadata": {
5+
"name": "1.0.0-test"
6+
}
7+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"kind":"cincinnati-metadata-v0","version":"1.0.0-test"}

0 commit comments

Comments
 (0)