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

Update kustomize image

Recipe IDorg.openrewrite.kubernetes.kustomize.UpdateImageTag

Artifactorg.openrewrite.recipe:rewrite-kubernetes

Update the newName, newTag or digest of an entry in a kustomization's images block, which is where kustomize edit set image and the sed, yq and Python scripts that stand in for it write an image pin. Only an entry that is already there is updated; an image the kustomization does not already override is left alone rather than added. A commented out entry stays a comment.

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

5 parameters

1 required4 optional

Parameter	Example	Type	Required
imageName	controller	String	Required
The name of the images entry to update, which is the image as it is written in the resources being overlaid rather than the image it is replaced with.
digest	sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229	String	Optional
The digest to override with, including its sha256: prefix. Mutually exclusive with newTag, so setting it removes a newTag the entry already has.
fileMatcher	**/overlays/**/kustomization.yaml	String	Optional
Matching files will be modified. This is a glob expression. When omitted, the file names kustomize itself recognizes are matched: kustomization.yaml, kustomization.yml and Kustomization.
newName	ghcr.io/telekom/das-schiff-network-operator	String	Optional
The image name to override with. Leave unset to change only the tag or digest.
newTag	v1.2.3	String	Optional
The tag to override with. Mutually exclusive with digest, so setting it removes a digest the entry already has.

Examples

yaml

Parameter	Value
imageName	controller
newName	null
newTag	v1.2.3
digest	null
fileMatcher	null

yaml

Before

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- deployment.yaml
images:
- name: controller
  newName: ghcr.io/telekom/das-schiff-network-operator
  newTag: latest
- name: kube-rbac-proxy
  newTag: v0.15.0

After

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- deployment.yaml
images:
- name: controller
  newName: ghcr.io/telekom/das-schiff-network-operator
  newTag: v1.2.3
- name: kube-rbac-proxy
  newTag: v0.15.0

Diff

--- config/operator/kustomization.yaml
+++ config/operator/kustomization.yaml
@@ -8,1 +8,1 @@
- name: controller
  newName: ghcr.io/telekom/das-schiff-network-operator
- newTag: latest
+ newTag: v1.2.3
- name: kube-rbac-proxy

Usage

Run this recipe

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

shell

mod run . --recipe UpdateImageTag --recipe-option "imageName=controller" --recipe-option "newName=ghcr.io/telekom/das-schiff-network-operator" --recipe-option "newTag=v1.2.3" --recipe-option "digest=sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229" --recipe-option "fileMatcher='**/overlays/**/kustomization.yaml'"

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

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.