Moderne licensed

Update image name

Recipe IDorg.openrewrite.kubernetes.UpdateContainerImageNameArtifactorg.openrewrite.recipe:rewrite-kubernetes

Search for image names that match patterns and replace the components of the name with new values.

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.UpdateContainerImageName")
}

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.UpdateContainerImageName --recipe-option "imageToFind=nginx"

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

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

Options

Name	Type	Description
`repoToFind`	`String`	The repository part of the image name to search for in containers and initContainers. e.g. `gcr.io`
`imageToFind`required	`String`	The image name to search for in containers and initContainers. e.g. `nginx`
`tagToFind`	`String`	The tag part of the image name to search for in containers and initContainers. e.g. `v1.2.3`
`digestToFind`	`String`	The digest part of the image name to search for in containers and initContainers. e.g. `sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229`
`repoToUpdate`	`String`	The repository part of the image name to update to in containers and initContainers. e.g. `gcr.io/account/bucket`
`imageToUpdate`	`String`	The image name to update to in containers and initContainers. e.g. `nginx`
`tagToUpdate`	`String`	The tag part of the image name to update to in containers and initContainers. e.g. `v1.2.3`
`digestToUpdate`	`String`	The digest part of the image name to update to in containers and initContainers. e.g. `sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229`
`includeInitContainers`	`boolean`	Boolean to indicate whether or not to treat initContainers/image identically to containers/image. e.g. `false`
`fileMatcher`	`String`	Matching 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