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

Add Kubernetes pod spec configuration

Recipe IDorg.openrewrite.kubernetes.AddPodSpecConfiguration
Artifactorg.openrewrite.recipe:rewrite-kubernetes

Add default required configuration to a workload's pod spec when it is missing. The pod spec is located by kind, so a Deployment, StatefulSet, DaemonSet, ReplicaSet, ReplicationController, Job or CronJob is configured as well as a bare Pod.

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

4 parameters
1 required3 optional
ParameterExampleTypeRequired
valueprivileged: falseStringRequired
The configuration that is added when necessary, including the key.
configurationPathcontainersStringOptional
A dot-separated path relative to the pod spec. Omit to configure the pod spec itself; use containers to configure every container in it.
fileMatcher**/pod-*.ymlStringOptional
Matching files will be modified. This is a glob expression.
resourceKindDeploymentStringOptional
Only configure workloads of this kind. This is a glob expression. When omitted, every workload kind that has a pod spec is configured.

Examples

yaml
ParameterValue
configurationPathnull
valuehostPID: false
resourceKindnull
fileMatchernull
Before
apiVersion: apps/v1
kind: Deployment
metadata:
name: application
spec:
template:
spec:
containers:
- name: nginx
image: nginx
After
apiVersion: apps/v1
kind: Deployment
metadata:
name: application
spec:
template:
spec:
containers:
- name: nginx
image: nginx
hostPID: false
yaml
ParameterValue
configurationPathnull
valuehostPID: false
resourceKindnull
fileMatchernull
Before
apiVersion: cluster.x-k8s.io/v1beta1
kind: MachineDeployment
metadata:
name: workers
spec:
clusterName: capi-quickstart
template:
spec:
clusterName: capi-quickstart
version: v1.31.0
bootstrap:
configRef:
kind: KubeadmConfigTemplate
name: workers
infrastructureRef:
kind: DockerMachineTemplate
name: workers
---
apiVersion: controlplane.cluster.x-k8s.io/v1beta1
kind: KubeadmControlPlane
metadata:
name: control-plane
spec:
version: v1.31.0
machineTemplate:
infrastructureRef:
kind: DockerMachineTemplate
name: control-plane
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: application
spec:
template:
spec:
containers:
- name: app
image: nginx
After
apiVersion: cluster.x-k8s.io/v1beta1
kind: MachineDeployment
metadata:
name: workers
spec:
clusterName: capi-quickstart
template:
spec:
clusterName: capi-quickstart
version: v1.31.0
bootstrap:
configRef:
kind: KubeadmConfigTemplate
name: workers
infrastructureRef:
kind: DockerMachineTemplate
name: workers
---
apiVersion: controlplane.cluster.x-k8s.io/v1beta1
kind: KubeadmControlPlane
metadata:
name: control-plane
spec:
version: v1.31.0
machineTemplate:
infrastructureRef:
kind: DockerMachineTemplate
name: control-plane
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: application
spec:
template:
spec:
containers:
- name: app
image: nginx
hostPID: false

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe AddPodSpecConfiguration --recipe-option "configurationPath=containers" --recipe-option "value='privileged: false'" --recipe-option "resourceKind=Deployment" --recipe-option "fileMatcher='**/pod-*.yml'"

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

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.