Augment components with version and images from OCM component descriptors by MartinWeindel · Pull Request #87 · gardener/gardener-landscape-kit

MartinWeindel · 2026-01-30T13:40:24Z

How to categorize this PR?

/area control-plane
/kind enhancement

What this PR does / why we need it:
The resolve-ocm-components command now writes a ocm-components.yaml containing component vectors with resources, image overwrites, and component image overwrites.
These additional information is then used during the generate landscape command to update the helm chart, images references and overwrites in the templates.
Additional processing of custom compoments with OCM component descriptors are supported, too. (See docs/usage/custom-ocm-components.md for details.)

Which issue(s) this PR fixes:
Fixes #67, #68, and #74

Special notes for your reviewer:

Release note:

Augment components with version and images from OCM component descriptors.

Support templating custom compoments with OCM component descriptors.

…ub.com/go-sprout/sprout`

…rking-calico` and `networking-cilium`

LucaBernstein

Thank you very much, also for structuring the commits so well. A few preliminary comments from my side.

docs/usage/custom-ocm-components.md

pkg/ocm/components/helpers/dash2camelCase_test.go

pkg/registry/types.go

timuthy · 2026-02-04T08:58:22Z

/assign

gardener-prow · 2026-02-10T10:37:11Z

PR needs rebase.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

timuthy

Thanks for integrating the OCM image processing into GLK 👏

timuthy · 2026-02-10T10:46:27Z

pkg/cmd/resolveocm/resolve_ocm_components.go

+	if err := os.MkdirAll(baseDir, 0700); err != nil {
+		return fmt.Errorf("failed to create output base directory %s: %w", baseDir, err)
+	}
+	if err := os.WriteFile(path.Join(baseDir, ".gitignore"), []byte("/*"), 0600); err != nil {


Is there a strong reason for not checking in the generated file? I'd say it's important to keep this state in the repository, so that glk generate can easily be invoked again w/o re-resolving the OCM image vector.

The debug files can still be written into a separate, ignored debug directory.

timuthy · 2026-02-10T11:04:38Z

pkg/ocm/components/components.go

 	// Name is the name of the resource.
 	Name string `json:"name"`
+	// Alias is an optional alias name of the resource.
+	Alias string `json:"alias,omitempty"`


Consider using a pointer if it's optional.

timuthy · 2026-02-10T11:05:44Z

pkg/utils/componentvector/types.go

+	// Resources is an optional list of values representing resources of the component.
+	Resources map[string]any `json:"resources,omitempty"`
+	// ImageVectorOverwrite is an optional image vector overwrite for the component.
+	ImageVectorOverwrite string `json:"imageVectorOverwrite,omitempty"`


Do we really have to use string here, can we be more precise?

timuthy · 2026-02-10T11:10:12Z

pkg/utils/componentvector/types.go

 	SourceRepository string `json:"sourceRepository"`
 	// Version is the version of the component.
 	Version string `json:"version"`
+	// Resources is an optional list of values representing resources of the component.


I think this needs further clarification, as the definition of a resource is not clear in this context. Please enhance the docstring by stating that a resource is usually an OCI image produced by a component.

timuthy · 2026-02-10T11:11:33Z

pkg/utils/componentvector/types.go

 	// Version is the version of the component.
 	Version string `json:"version"`
+	// Resources is an optional list of values representing resources of the component.
+	Resources map[string]any `json:"resources,omitempty"`


Do we really have to use any here, can we be more precise?

timuthy · 2026-02-10T12:17:33Z

test/utils/kustomize.go

Move to pkg/utils/test.

timuthy · 2026-02-10T12:18:13Z

test/utils/componentsvectorfile.go

Move to pkg/utils/test.

timuthy · 2026-02-10T12:19:03Z

test/utils/componentsvectorfile.go

+	"sigs.k8s.io/yaml"
+)
+
+type ComponentVectorFactory func() (componentvector.ComponentVector, error)


Suggested change

type ComponentVectorFactory func() (componentvector.ComponentVector, error)

type BuildComponentVectorFn func() (componentvector.ComponentVector, error)

timuthy · 2026-02-10T12:19:43Z

test/utils/componentsvectorfile.go

+type ComponentVectorFactory func() (componentvector.ComponentVector, error)
+
+// CreateComponentsVectorFile creates a components vector YAML file in the given filesystem.
+func CreateComponentsVectorFile(fs afero.Afero, cvf ComponentVectorFactory) (string, error) {


Suggested change

func CreateComponentsVectorFile(fs afero.Afero, cvf ComponentVectorFactory) (string, error) {

func CreateComponentsVectorFile(fs afero.Afero, build BuildComponentVectorFn) (string, error) {

timuthy · 2026-02-10T12:20:16Z

test/utils/componentsvectorfile.go

+}
+
+// ComponentVector creates a new ComponentVectorFactoryBuilder with the given name and version.
+func ComponentVector(name, version string) *ComponentVectorFactoryBuilder {


Suggested change

func ComponentVector(name, version string) *ComponentVectorFactoryBuilder {

func NewComponentVectorBuilder(name, version string) *ComponentVectorFactoryBuilder {

gardener-prow · 2026-02-10T12:24:07Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from timuthy. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

LucaBernstein

Apart from what has already been remarked, I have some additional concerns about the imageVectorOverride templating, mainly w.r.t. indentations.

LucaBernstein · 2026-02-11T09:33:05Z

pkg/components/gardener-extensions/networking-calico/templates/landscape/extension.yaml

+        {{- end }}
+        {{- if .imageVectorOverwrite }}
+        imageVectorOverwrite: |
+  {{ indent 10 .imageVectorOverwrite }}


Suggested change

{{ indent 10 .imageVectorOverwrite }}

{{ indent 10 .imageVectorOverwrite }}

Seems to make a difference. Tried it out:

apiVersion: operator.gardener.cloud/v1alpha1 kind: Extension metadata: name: networking-calico spec: deployment: extension: values: imageVectorOverwrite: | images: // <-- wrong indentation! - name: bird-exporter repository: ghcr.io/czerwonk/bird_exporter tag: v1.4.5

I'm not sure, though, why it doesn't show in the unit test with imageVectorOverwriteContent. 🤔
To me it seems that in the source ocm-components.yaml, there are <TAB> chars used instead of spaces.

→ Maybe we want to add some kind of strings.TrimSpace(...) to the image vector overwrite inserted?

LucaBernstein · 2026-02-11T09:33:42Z

pkg/components/gardener-extensions/networking-cilium/templates/landscape/extension.yaml

+        {{- end }}
+        {{- if .imageVectorOverwrite }}
+        imageVectorOverwrite: |
+  {{ indent 10 .imageVectorOverwrite }}


Suggested change

{{ indent 10 .imageVectorOverwrite }}

{{ indent 10 .imageVectorOverwrite }}

LucaBernstein · 2026-02-11T09:51:15Z

pkg/utils/componentvector/componentvector.go

+	if cv.ImageVectorOverwrite != "" {
+		m["imageVectorOverwrite"] = cv.ImageVectorOverwrite
+	}
+	if cv.ComponentImageVectorOverwrites != "" {
+		m["componentImageVectorOverwrites"] = cv.ComponentImageVectorOverwrites
+	}


W.r.t. my previous comment: Maybe some pruning is required here?
Reproducibility of the indentation issues pointed out earlier would be nice though.

MartinWeindel added 12 commits January 30, 2026 12:18

Replace github.com/Masterminds/sprig/v3 template functions by `gith…

5da7b5e

…ub.com/go-sprout/sprout`

Move OCM output dir to GLK system directory and ignore it for git

dca242c

Add component resources and imagevector to component vector

52c67e5

Provide ComponentImageVectorOverwrites

8511c4e

--workers and --debug option for resolve-ocm-components command

a1dc365

Support image overwrites from component vectors for components `netwo…

73c9763

…rking-calico` and `networking-cilium`

Support image overwrites for Gardener operator component

7f61078

Render templates using resources from custom OCM component

1ceae59

Add documentation for creating a custom OCM component

6b65928

Support image overwrites for provider-aws

ef7bc3d

Support image overwrites for os-gardenlinux and os-suse-chost

2b79eed

fix linter issues

f8bf096

gardener-prow bot added area/control-plane Control plane related kind/enhancement Enhancement, improvement, extension cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 30, 2026

MartinWeindel force-pushed the enh/ocm-component-vector-resources2 branch from f0204f2 to 5d7316f Compare January 30, 2026 16:41

fix sast issue

cbea833

MartinWeindel force-pushed the enh/ocm-component-vector-resources2 branch from 5d7316f to cbea833 Compare January 30, 2026 16:46

LucaBernstein reviewed Feb 3, 2026

View reviewed changes

docs/usage/custom-ocm-components.md Outdated Show resolved Hide resolved

pkg/ocm/components/helpers/dash2camelCase_test.go Outdated Show resolved Hide resolved

pkg/registry/types.go Show resolved Hide resolved

fix duplicate copyright headers and trailing newlines

d204c06

gardener-prow bot assigned timuthy Feb 4, 2026

gardener-prow bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 10, 2026

timuthy requested changes Feb 10, 2026

View reviewed changes

LucaBernstein requested changes Feb 11, 2026

View reviewed changes

	type ComponentVectorFactory func() (componentvector.ComponentVector, error)
	type BuildComponentVectorFn func() (componentvector.ComponentVector, error)

	func CreateComponentsVectorFile(fs afero.Afero, cvf ComponentVectorFactory) (string, error) {
	func CreateComponentsVectorFile(fs afero.Afero, build BuildComponentVectorFn) (string, error) {

	func ComponentVector(name, version string) *ComponentVectorFactoryBuilder {
	func NewComponentVectorBuilder(name, version string) *ComponentVectorFactoryBuilder {

	{{ indent 10 .imageVectorOverwrite }}
	{{ indent 10 .imageVectorOverwrite }}

Conversation

MartinWeindel commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LucaBernstein left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timuthy commented Feb 4, 2026

Uh oh!

gardener-prow bot commented Feb 10, 2026

Uh oh!

timuthy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gardener-prow bot commented Feb 10, 2026

Uh oh!

LucaBernstein left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MartinWeindel commented Jan 30, 2026 •

edited

Loading