Design Partners
Update image name
** org.openrewrite.kubernetes.UpdateContainerImageName** Search for image names that match patterns and replace the components of the name with new values.

Source

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

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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.UpdateContainerImageNameExample
4
displayName: Update image name example
5
recipeList:
6
- org.openrewrite.kubernetes.UpdateContainerImageName:
7
repoToFind: gcr.io
8
imageToFind: nginx
9
tagToFind: v1.2.3
10
repoToUpdate: gcr.io/account/bucket
11
imageToUpdate: nginx
12
tagToUpdate: v1.2.3
13
includeInitContainers: false
14
fileMatcher: '**/pod-*.yml'
Copied!
Now that com.yourorg.UpdateContainerImageNameExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-kubernetes:1.18.0 in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.22.2")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.UpdateContainerImageNameExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
12
13
dependencies {
14
rewrite("org.openrewrite.recipe:rewrite-kubernetes:1.18.0")
15
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.25.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.UpdateContainerImageNameExample</recipe>
11
</activeRecipes>
12
</configuration>
13
<dependencies>
14
<dependency>
15
<groupId>org.openrewrite.recipe</groupId>
16
<artifactId>rewrite-kubernetes</artifactId>
17
<version>1.18.0</version>
18
</dependency>
19
</dependencies>
20
</plugin>
21
</plugins>
22
</build>
23
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipescom.yourorg.UpdateContainerImageNameExample
Export as PDF
Copy link