Skip to main content
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 manifest flavors

Recipe IDorg.openrewrite.kubernetes.search.FindManifestFlavors
Artifactorg.openrewrite.recipe:rewrite-kubernetes

Classify every YAML file in a repository by what it actually is — a manifest, a Helm chart template, a kustomization, something else entirely — and by whether an edit to it would mean what it appears to mean. This is the denominator every other Kubernetes report is a fraction of.

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

1 parameters
1 optional
ParameterExampleTypeRequired
fileMatcher**/*.ymlStringOptional
Only report on matching files. This is a glob expression. The whole repository is classified either way, because deciding what charts/app/templates/deploy.yaml is requires finding charts/app/Chart.yaml.

Examples

yaml
ParameterValue
fileMatchernull
Unchanged
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: widgets.example.com
Before
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ .Release.Name }}
After
~~(HelmTemplate)~~>apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ .Release.Name }}

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 FindManifestFlavors

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.

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

Data tables

Manifest flavors
org.openrewrite.kubernetes.table.ManifestFlavors

Every YAML file in the repository, classified by what it actually is and by whether an edit to it would mean what it appears to mean. The denominator for the coverage of every other table here.

ColumnDescription
Source pathThe path of the YAML file relative to the root of the repository.
FlavorWhat the file is: a plain manifest, a chart's templates/, crds/, Chart.yaml or values.yaml, a kustomization, something else templated, YAML that declares no resource, or YAML that did not parse.
Safe to editWhether a write recipe may edit this file. False for anything whose text is not the resource, such as a chart template or a kustomization patch.
Document countHow many YAML documents the file holds, counting each one separated by ---.
Kubernetes document countHow many of those documents declare both apiVersion and kind.
Helm expression countHow many {{ }} template expressions the file holds. A GitHub Actions ${{ }} is not one of them.
Substitution countHow many ${VAR} substitutions the file holds, which envsubst, Flux's postBuild.substitute or kustomize resolves before the manifest reaches a cluster. Counted only for files that declare a Kubernetes resource, because elsewhere the same text is an ordinary shell variable.
Chart pathThe directory of the Chart.yaml this file belongs to, or null when it belongs to no chart. The deepest such directory, so a subchart claims its own files.
ReasonWhy the file was classified this way, 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.

ColumnDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe 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.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe 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.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe 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.