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 custom resources using deprecated CRD fields

Recipe IDorg.openrewrite.kubernetes.crd.FindCustomResourcesUsingDeprecatedCrdFields
Artifactorg.openrewrite.recipe:rewrite-kubernetes

Find custom resources that set a field which a CustomResourceDefinition in this repository marks deprecated, or that are on a version the CustomResourceDefinition deprecates. controller-gen copies Go doc comments verbatim into a CRD's OpenAPI schema description, so a field deprecated in Go ships its own deprecation notice inside the CRD and no per-CRD configuration is needed.

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
ParameterExampleTypeRequired
additionalMarkerPattern@deprecatedStringOptional
A regular expression matched against a property's description in addition to the built-in markers, for house deprecation conventions.
sensitivitylooseStringOptional
strict, the default, recognizes only the Go convention of a description whose line begins with Deprecated and a separator. loose additionally accepts is deprecated, has been deprecated and will be removed in anywhere in a description, at the cost of reporting prose that merely mentions a deprecation.

Examples

yaml
ParameterValue
sensitivitynull
additionalMarkerPatternnull
Before
apiVersion: network.schiff.telekom.de/v1alpha1
kind: VRFRouteConfiguration
metadata:
name: legacy
spec:
community: "1234:5678"
---
apiVersion: network.schiff.telekom.de/v1alpha1
kind: VRFRouteConfiguration
metadata:
name: modern
spec:
communities:
add: ["1234:5678"]
After
apiVersion: network.schiff.telekom.de/v1alpha1
kind: VRFRouteConfiguration
metadata:
name: legacy
spec:
~~(Deprecated: use Communities instead.)~~>community: "1234:5678"
---
apiVersion: network.schiff.telekom.de/v1alpha1
kind: VRFRouteConfiguration
metadata:
name: modern
spec:
communities:
add: ["1234:5678"]

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 FindCustomResourcesUsingDeprecatedCrdFields

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

Deprecated CRD field usages
org.openrewrite.kubernetes.table.DeprecatedCrdFieldUsages

Custom resources that use something a CustomResourceDefinition in this repository marks deprecated.

ColumnDescription
Source pathThe path to the custom resource.
API versionThe apiVersion of the custom resource.
KindThe kind of the custom resource.
NameThe metadata.name of the custom resource.
FindingEither deprecated field or deprecated version.
Field pathA slash-delimited path to the deprecated field, with * standing in for a sequence entry. Empty for a deprecated version.
ReasonThe deprecation notice the CustomResourceDefinition carries, verbatim.
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.