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 Kubernetes resources

Recipe IDorg.openrewrite.kubernetes.search.FindKubernetesResources

Artifactorg.openrewrite.recipe:rewrite-kubernetes

An inventory of every Kubernetes resource in a repository, one row per YAML document. The pod spec path column reports where each kind keeps its containers, so the workloads this module cannot reach are counted rather than quietly skipped.

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
apiVersion	apps/v1	String	Optional
Only inventory resources on this API version. This is a glob expression, so apps/* takes a whole group. When omitted, every resource is inventoried.
fileMatcher	**/*.yml	String	Optional
Matching files will be searched. This is a glob expression.
kind	Deployment	String	Optional
Only inventory resources of this kind. This is a glob expression. When omitted, every resource is inventoried.

Examples

yaml

Parameter	Value
apiVersion	null
kind	null
fileMatcher	null

yaml

Before

apiVersion: apps/v1
kind: Deployment
metadata:
  name: application
  namespace: default
spec:
  template:
    spec:
      containers:
      - name: app
        image: nginx
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: settings
data:
  key: value

After

~~(Deployment default/application)~~>apiVersion: apps/v1
kind: Deployment
metadata:
  name: application
  namespace: default
spec:
  template:
    spec:
      containers:
      - name: app
        image: nginx
~~(ConfigMap settings)~~>---
apiVersion: v1
kind: ConfigMap
metadata:
  name: settings
data:
  key: value

Diff

--- k8s/app.yaml
+++ k8s/app.yaml
@@ -1,1 +1,1 @@
-apiVersion: apps/v1
+~~(Deployment default/application)~~>apiVersion: apps/v1
kind: Deployment
@@ -12,1 +12,1 @@
      - name: app
        image: nginx
----
+~~(ConfigMap settings)~~>---
apiVersion: v1

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 FindKubernetesResources

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

Kubernetes resources

org.openrewrite.kubernetes.table.KubernetesResources

Every Kubernetes resource declared in the repository, one row per YAML document.

Column	Description
Source path	The path of the YAML file relative to the root of the repository.
Document index	The zero-based position of this document within its file. One file declares many resources when its documents are separated by ---.
API version	The apiVersion of the resource, exactly as it is written.
Kind	The kind of the resource.
Namespace	The metadata.namespace of the resource, or null when the resource is cluster scoped or takes the namespace it is applied into.
Name	The metadata.name of the resource.
Templated	Whether the document holds a Go template expression, and so declares something other than what it says until it has been rendered.
Group	The group half of apiVersion. Empty for the core group, whose apiVersion is a bare version such as v1 with no slash in it at all.
Version	The version half of apiVersion.
Pod spec path	A JsonPath to where this kind keeps its pod spec, or null when that is not known here. A workload that lands in this table with no pod spec path is a workload every container recipe silently passes over.

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.