Find exceeds resource limit

org.openrewrite.kubernetes.resource.FindExceedsResourceValue

Find resource manifests that have limits set beyond a specific maximum.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-kubernetes

• version: 2.3.0

Options

Type	Name	Description	Example
String	resourceValueType	The type of resource value to search for. Valid options: limits, requests	limits
String	resourceType	The type of resource limit to search for. Valid options: cpu, memory	memory
String	resourceLimit	The resource limit maximum to search for to find resources that request more than the maximum.	2Gi
String	fileMatcher	Optional. Matching files will be modified. This is a glob expression.	**/pod-*.yml

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.FindExceedsResourceValueExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindExceedsResourceValueExample
displayName: Find exceeds resource limit example
recipeList:
  - org.openrewrite.kubernetes.resource.FindExceedsResourceValue:
      resourceValueType: limits
      resourceType: memory
      resourceLimit: 2Gi
      fileMatcher: '**/pod-*.yml'

Now that com.yourorg.FindExceedsResourceValueExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-kubernetes:2.3.0 in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

plugins {
    id("org.openrewrite.rewrite") version("6.12.0")
}

rewrite {
    activeRecipe("com.yourorg.FindExceedsResourceValueExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-kubernetes:2.3.0")
}

2. Run gradle rewriteRun to run the recipe.

Maven

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.FindExceedsResourceValueExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-kubernetes</artifactId>
            <version>2.3.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

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 FindExceedsResourceValueExample

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Contributors

Jon Brisbin, Jonathan Schneider, Knut Wannheden, Tim te Beek, Aaron Gershman