Comment on page

Update image name

org.openrewrite.kubernetes.UpdateContainerImageName
Search for image names that match patterns and replace the components of the name with new values.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite.recipe
artifactId: rewrite-kubernetes
version: 2.0.6
Options
Type
Name
Description
String
repoToFind
Optional. The repository part of the image name to search for in containers and initContainers.
String
imageToFind
The image name to search for in containers and initContainers.
String
tagToFind
Optional. The tag part of the image name to search for in containers and initContainers.
String
repoToUpdate
Optional. The repository part of the image name to update to in containers and initContainers.
String
imageToUpdate
Optional. The image name to update to in containers and initContainers.
String
tagToUpdate
Optional. The tag part of the image name to update to in containers and initContainers.
boolean
includeInitContainers
Optional. Boolean to indicate whether or not to treat initContainers/image identically to containers/image.
String
fileMatcher
Optional. Matching files will be modified. This is a glob expression.
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.UpdateContainerImageNameExample. 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.UpdateContainerImageNameExample
displayName: Update image name example
recipeList:
  - org.openrewrite.kubernetes.UpdateContainerImageName:
      repoToFind: gcr.io
      imageToFind: nginx
      tagToFind: v1.2.3
      repoToUpdate: gcr.io/account/bucket
      imageToUpdate: nginx
      tagToUpdate: v1.2.3
      includeInitContainers: false
      fileMatcher: '**/pod-*.yml'
Now that com.yourorg.UpdateContainerImageNameExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-kubernetes:2.0.6 in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.UpdateContainerImageNameExample")
}
​
repositories {
    mavenCentral()
}
​
dependencies {
    rewrite("org.openrewrite.recipe:rewrite-kubernetes:2.0.6")
}
2.Run gradle rewriteRun to run the recipe.
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.UpdateContainerImageNameExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-kubernetes</artifactId>
            <version>2.0.6</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe UpdateContainerImageName
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, Knut Wannheden, Aaron Gershman​

Type	Name	Description
`String`	repoToFind	Optional. The repository part of the image name to search for in containers and initContainers.
`String`	imageToFind	The image name to search for in containers and initContainers.
`String`	tagToFind	Optional. The tag part of the image name to search for in containers and initContainers.
`String`	repoToUpdate	Optional. The repository part of the image name to update to in containers and initContainers.
`String`	imageToUpdate	Optional. The image name to update to in containers and initContainers.
`String`	tagToUpdate	Optional. The tag part of the image name to update to in containers and initContainers.
`boolean`	includeInitContainers	Optional. Boolean to indicate whether or not to treat initContainers/image identically to containers/image.
`String`	fileMatcher	Optional. Matching files will be modified. This is a glob expression.

Read-only root filesystem

RBAC

Last modified 9d ago