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 dangling Kubernetes resource references

Recipe IDorg.openrewrite.kubernetes.search.FindDanglingResourceReferences

Artifactorg.openrewrite.recipe:rewrite-kubernetes

Find resources that refer by name to a ConfigMap, Secret, ServiceAccount, Service, PersistentVolumeClaim, Role, ClusterRole, PriorityClass or scale target that this repository declares nowhere. There is no safe automated fix for a dangling reference — the name is either a typo, a leftover, or satisfied out of band — so this only reports. Namespace is ignored when resolving, a kustomization's namePrefix and nameSuffix are replayed so that the name a cluster sees resolves as well as the one on disk, and references whose value is templated, whose target kind appears nowhere in the repository, or whose target kind has a name some template computes are all left alone.

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

3 parameters

3 optional

Parameter	Example	Type	Required
fileMatcher	**/overlays/**/*.yaml	String	Optional
Only report references found in matching files. This is a glob expression. The whole repository is indexed either way.
indexFileMatcher	**/*.yaml	String	Optional
Files to index resources from. This is a glob expression, and every YAML file is indexed when it is omitted. Narrowing this manufactures findings: a reference is dangling only when nothing anywhere declares its target.
requireTargetKindPresent	—	Boolean	Optional
Only report a reference when the repository declares at least one resource of the kind being referred to. A repository with no PersistentVolumeClaim in it has its claims satisfied by an operator or an administrator, and reporting them is noise. Default true.

Examples

yaml

Parameter	Value
indexFileMatcher	null
fileMatcher	null
requireTargetKindPresent	null

yaml

Before

apiVersion: v1
kind: ConfigMap
metadata:
  name: app-config
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
spec:
  template:
    spec:
      containers:
      - name: app
        image: app:1
        envFrom:
        - configMapRef:
            name: app-config
        - configMapRef:
            name: missing-config

After

apiVersion: v1
kind: ConfigMap
metadata:
  name: app-config
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
spec:
  template:
    spec:
      containers:
      - name: app
        image: app:1
        envFrom:
        - configMapRef:
            name: app-config
        - configMapRef:
            name: ~~(no ConfigMap named missing-config)~~>missing-config

Diff

@@ -20,1 +20,1 @@
            name: app-config
        - configMapRef:
-           name: missing-config
+           name: ~~(no ConfigMap named missing-config)~~>missing-config

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 FindDanglingResourceReferences

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

Dangling resource references

org.openrewrite.kubernetes.table.DanglingResourceReferences

References by name to a Kubernetes resource that this repository declares nowhere.

Column	Description
Source path	The path of the file holding the reference.
Referrer kind	The kind of the resource making the reference.
Referrer name	The metadata.name of the resource making the reference.
Reference field	A slash-delimited path to the reference from the document root, with * standing in for a sequence entry.
Target kind	The kind of the resource being referred to.
Target name	The name being referred to.
Confidence	high when the referring file means in a cluster what it says on disk, medium when it is a chart template, a kustomization, or something a kustomization renames, and so renders to something else.
Reason	Why the reference is reported, in the terms a reader would use to argue with it.

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.