Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Find kustomize images

Recipe IDorg.openrewrite.kubernetes.search.FindKustomizeImages

Artifactorg.openrewrite.recipe:rewrite-kubernetes

An inventory of every image a kustomization overrides. The images block is where a repository's image pins actually live once kustomize is in play, and it is rewritten by kustomize edit set image, sed, yq and hand edits alike, so it is worth knowing where they all are.

Single recipeOpenRewriteModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

2 parameters

2 optional

Parameter	Example	Type	Required
fileMatcher	**/overlays/**/kustomization.yaml	String	Optional
Matching files will be searched. This is a glob expression. When omitted, the file names kustomize itself recognizes are matched: kustomization.yaml, kustomization.yml and Kustomization.
imageName	ghcr.io/telekom/*	String	Optional
Only inventory entries whose name matches this glob expression. When omitted, every entry is inventoried.

Examples

yaml

Parameter	Value
imageName	null
fileMatcher	null

yaml

Before

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
images:
- name: controller
  newName: ghcr.io/telekom/das-schiff-network-operator
  newTag: v1.2.3
- name: gcr.io/k8s-staging-cluster-api/capd-manager
  newTag: v1.12.8

After

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
images:
- ~~(ghcr.io/telekom/das-schiff-network-operator:v1.2.3)~~>name: controller
  newName: ghcr.io/telekom/das-schiff-network-operator
  newTag: v1.2.3
- ~~(gcr.io/k8s-staging-cluster-api/capd-manager:v1.12.8)~~>name: gcr.io/k8s-staging-cluster-api/capd-manager
  newTag: v1.12.8

Diff

--- config/operator/kustomization.yaml
+++ config/operator/kustomization.yaml
@@ -4,1 +4,1 @@
kind: Kustomization
images:
-- name: controller
+- ~~(ghcr.io/telekom/das-schiff-network-operator:v1.2.3)~~>name: controller
  newName: ghcr.io/telekom/das-schiff-network-operator
@@ -7,1 +7,1 @@
  newName: ghcr.io/telekom/das-schiff-network-operator
  newTag: v1.2.3
-- name: gcr.io/k8s-staging-cluster-api/capd-manager
+- ~~(gcr.io/k8s-staging-cluster-api/capd-manager:v1.12.8)~~>name: gcr.io/k8s-staging-cluster-api/capd-manager
  newTag: v1.12.8

Usage

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe FindKustomizeImages

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:RELEASE

LATEST

mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:LATEST

Pinned version

mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:3.18.0

Data tables

Kustomize images

org.openrewrite.kubernetes.table.KustomizeImages

Every image a kustomization overrides, one row per entry in an images block.

Column	Description
Source path	The path of the kustomization relative to the root of the repository.
Name	The name the entry matches on, which is the image as it is written in the resources being overlaid.
New name	The newName the image is replaced with, or null when only the tag or digest is overridden.
New tag	The newTag the image is pinned to, or null.
Digest	The digest the image is pinned to, or null. Mutually exclusive with the tag.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.