org.openrewrite.kubernetes.resource.FindExceedsResourceRatio
Find resource manifests that have requests to limits ratios beyond a specific maximum.
GitHub, Issue Tracker, Maven Central
- groupId: org.openrewrite.recipe
- artifactId: rewrite-kubernetes
- version: 2.0.1
Type | Name | Description |
---|---|---|
String |
resourceType | The type of resource limit to search for. |
String |
ratioLimit | The maximum ratio allowed between requests and limits. |
String |
fileMatcher | Optional. Matching files will be modified. This is a glob expression. |
Parameter | Value |
---|---|
resourceType | memory |
ratioLimit | 2 |
fileMatcher | null |
{% tabs %} {% tab title="yaml" %}
{% code %}
apiVersion: v1
kind: Pod
metadata:
labels:
app: application
spec:
containers:
- image: nginx:latest
resources:
limits:
cpu: "2Gi"
memory: "1Gi"
requests:
cpu: "100Mi"
memory: "64m"
- image: k8s.gcr.io/test-webserver
resources:
limits:
cpu: "2Gi"
memory: "1Gi"
requests:
cpu: "100Mi"
memory: "64m"
{% endcode %}
{% code %}
apiVersion: v1
kind: Pod
metadata:
labels:
app: application
spec:
containers:
- image: nginx:latest
~~(exceeds max memory limits/requests ratio of 2)~~>resources:
limits:
cpu: "2Gi"
memory: "1Gi"
requests:
cpu: "100Mi"
memory: "64m"
- image: k8s.gcr.io/test-webserver
~~(exceeds max memory limits/requests ratio of 2)~~>resources:
limits:
cpu: "2Gi"
memory: "1Gi"
requests:
cpu: "100Mi"
memory: "64m"
{% endcode %}
{% endtab %} {% tab title="Diff" %} {% code %}
@@ -9,1 +9,1 @@
containers:
- image: nginx:latest
- resources:
+ ~~(exceeds max memory limits/requests ratio of 2)~~>resources:
limits:
@@ -17,1 +17,1 @@
memory: "64m"
- image: k8s.gcr.io/test-webserver
- resources:
+ ~~(exceeds max memory limits/requests ratio of 2)~~>resources:
limits:
{% endcode %} {% endtab %} {% endtabs %}
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.FindExceedsResourceRatioExample
.
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.FindExceedsResourceRatioExample
displayName: Find exceeds resource ratio example
recipeList:
- org.openrewrite.kubernetes.resource.FindExceedsResourceRatio:
resourceType: memory
ratioLimit: 2
fileMatcher: '**/pod-*.yml'
{% endcode %}
Now that com.yourorg.FindExceedsResourceRatioExample
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.FindExceedsResourceRatioExample")
}
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.FindExceedsResourceRatioExample</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 %}
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.