capresourcevaluetomaximum.md

Cap exceeds resource value

org.openrewrite.kubernetes.resource.CapResourceValueToMaximum

Cap resource values that exceed a specific maximum.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-kubernetes
• version: 2.0.1

Options

Type	Name	Description
String	resourceValueType	The type of resource to search for.
String	resourceType	The type of resource value to search for.
String	resourceLimit	The resource maximum to search for to find resources that request more than the maximum.
String	fileMatcher	Optional. Matching files will be modified. This is a glob expression.

Example

Parameters

Parameter	Value
resourceValueType	limits
resourceType	memory
resourceLimit	64Mi
fileMatcher	null

{% tabs %} {% tab title="yaml" %}

Before

{% code %}

apiVersion: v1
kind: Pod
metadata:
  labels:
    app: application
spec:
  containers:
  - image: nginx:latest
    resources:
        limits:
            cpu: "500Mi"
            memory: "256M"

{% endcode %}

After

{% code %}

apiVersion: v1
kind: Pod
metadata:
  labels:
    app: application
spec:
  containers:
  - image: nginx:latest
    resources:
        limits:
            cpu: "500Mi"
            memory: "67M"

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

@@ -12,1 +12,1 @@
        limits:
            cpu: "500Mi"
-           memory: "256M"
+           memory: "67M"

{% endcode %} {% endtab %} {% endtabs %}

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.CapResourceValueToMaximumExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="rewrite.yml" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.CapResourceValueToMaximumExample
displayName: Cap exceeds resource value example
recipeList:
  - org.openrewrite.kubernetes.resource.CapResourceValueToMaximum:
      resourceValueType: limits
      resourceType: memory
      resourceLimit: 2Gi
      fileMatcher: '**/pod-*.yml'

{% endcode %}

Now that com.yourorg.CapResourceValueToMaximumExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-kubernetes:2.0.1 in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

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

repositories {
    mavenCentral()
}

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

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

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

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jon Brisbin
• Jonathan Schneider
• Knut Wannheden

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.