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 container resource coverage

Recipe IDorg.openrewrite.kubernetes.search.FindContainerResourceCoverage

Artifactorg.openrewrite.recipe:rewrite-kubernetes

Profile the compute resources and probes every container of every workload declares. Quantities are reported both as written and normalized to millicores and bytes, and each row carries the quality of service class the kubelet would give the pod the container belongs to.

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

4 optional

Parameter	Example	Type	Required
containerTypes	containers	Set	Optional
Which container lists to profile. Defaults to all of containers, initContainers and ephemeralContainers.
fileMatcher	**/*.yml	String	Optional
Matching files will be searched. This is a glob expression.
markEveryContainer	—	Boolean	Optional
Mark every container rather than only those missing a request or a limit. The data table holds every container either way. Default false.
resourceKind	Deployment	String	Optional
Only profile containers belonging to this kind of workload. This is a glob expression. When omitted, every workload kind that has a pod spec is profiled.

Examples

yaml

Parameter	Value
resourceKind	null
containerTypes	null
markEveryContainer	null
fileMatcher	null

yaml

Before

apiVersion: apps/v1
kind: Deployment
metadata:
  name: application
spec:
  template:
    spec:
      containers:
      - name: app
        image: nginx:1.27
        resources:
          requests:
            cpu: 500m
            memory: 512Mi
          limits:
            cpu: 1500m
            memory: 1Gi
        livenessProbe:
          httpGet:
            path: /healthz
            port: 8080
      - name: sidecar
        image: envoy:latest

After

apiVersion: apps/v1
kind: Deployment
metadata:
  name: application
spec:
  template:
    spec:
      containers:
      - name: app
        image: nginx:1.27
        resources:
          requests:
            cpu: 500m
            memory: 512Mi
          limits:
            cpu: 1500m
            memory: 1Gi
        livenessProbe:
          httpGet:
            path: /healthz
            port: 8080
      - ~~(missing: resources.requests.cpu, resources.requests.memory, resources.limits.cpu, resources.limits.memory)~~>name: sidecar
        image: envoy:latest

Diff

--- k8s/app.yaml
+++ k8s/app.yaml
@@ -22,1 +22,1 @@
            path: /healthz
            port: 8080
-     - name: sidecar
+     - ~~(missing: resources.requests.cpu, resources.requests.memory, resources.limits.cpu, resources.limits.memory)~~>name: sidecar
        image: envoy:latest

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 FindContainerResourceCoverage

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

Container resource profiles

org.openrewrite.kubernetes.table.ContainerProfiles

Every container of every workload, with the compute resources and probes it declares. The raw columns answer what to change; the normalized columns answer what a cluster is being asked for.

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 workload, exactly as it is written.
Kind	The kind of the workload.
Namespace	The metadata.namespace of the workload, or null when the workload takes the namespace it is applied into.
Name	The metadata.name of the workload.
Templated	Whether the document holds a Go template expression, and so declares something other than what it says until it has been rendered.
Container type	Which of containers, initContainers and ephemeralContainers this container was declared in.
Container name	The name of the container.
Image	The image of the container, exactly as it is written.
CPU request	resources.requests.cpu exactly as it is written, or null when it is not declared.
CPU limit	resources.limits.cpu exactly as it is written, or null when it is not declared.
Memory request	resources.requests.memory exactly as it is written, or null when it is not declared.
Memory limit	resources.limits.memory exactly as it is written, or null when it is not declared.
CPU request in millicores	resources.requests.cpu in millicores, or null when it is not declared or is a template expression that only has a value once rendered.
CPU limit in millicores	resources.limits.cpu in millicores, or null when it is not declared or is a template expression that only has a value once rendered.
Memory request in bytes	resources.requests.memory in bytes, or null when it is not declared or is a template expression that only has a value once rendered.
Memory limit in bytes	resources.limits.memory in bytes, or null when it is not declared or is a template expression that only has a value once rendered.
Liveness probe	Whether the container declares a livenessProbe. A key with nothing under it configures nothing and counts as absent.
Readiness probe	Whether the container declares a readinessProbe. A key with nothing under it configures nothing and counts as absent.
Startup probe	Whether the container declares a startupProbe. A key with nothing under it configures nothing and counts as absent.
Declared QoS class	The quality of service class the kubelet would assign the pod this container belongs to. A property of the whole pod repeated on each of its containers, because any one container that omits a limit spoils it for the rest. Unknown when a quantity is a template expression.

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.