Find Kubernetes manifest flavors
org.openrewrite.kubernetes.search.FindManifestFlavorsorg.openrewrite.recipe:rewrite-kubernetesOptions
Examples
yaml
| Parameter | Value |
|---|---|
| fileMatcher | null |
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: widgets.example.com
- yaml
- Diff
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ .Release.Name }}
~~(HelmTemplate)~~>apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ .Release.Name }}
--- charts/app/templates/deployment.yaml
+++ charts/app/templates/deployment.yaml
@@ -1,1 +1,1 @@
-apiVersion: apps/v1
+~~(HelmTemplate)~~>apiVersion: apps/v1
kind: Deployment
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.
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.
- RELEASE
- LATEST
- Pinned version
mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:RELEASE
mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:LATEST
mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:3.18.0
Data tables
Manifest flavors
org.openrewrite.kubernetes.table.ManifestFlavorsEvery 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.
| Column | Description |
|---|---|
| Source path | The path of the YAML file relative to the root of the repository. |
| Flavor | What 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 edit | Whether 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 count | How many YAML documents the file holds, counting each one separated by ---. |
| Kubernetes document count | How many of those documents declare both apiVersion and kind. |
| Helm expression count | How many {{ }} template expressions the file holds. A GitHub Actions ${{ }} is not one of them. |
| Substitution count | How 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 path | The 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. |
| Reason | Why 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.SourcesFileResultsSource 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.SearchResultsSearch 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.SourcesFileErrorsThe 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.RecipeRunStatsStatistics 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. |