← All recipes
Moderne licensed

Cap exceeds resource value

Recipe IDorg.openrewrite.kubernetes.resource.CapResourceValueToMaximumArtifactorg.openrewrite.recipe:rewrite-kubernetes

Cap resource values that exceed a specific maximum.

Single recipeProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.kubernetes.resource.CapResourceValueToMaximum")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

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

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.kubernetes.resource.CapResourceValueToMaximum --recipe-option "resourceValueType=limits" --recipe-option "resourceType=memory" --recipe-option "resourceLimit=2Gi"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:RELEASE

Options

NameTypeDescription
resourceValueTyperequiredStringThe type of resource to search for.
e.g. limits
resourceTyperequiredStringThe type of resource value to search for.
e.g. memory
resourceLimitrequiredStringThe resource maximum to search for to find resources that request more than the maximum.
e.g. 2Gi
fileMatcherStringMatching files will be modified. This is a glob expression.
e.g. **/pod-*.yml

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats