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.2.3
Options
Type | Name | Description | Example |
---|---|---|---|
| repoToFind | Optional. The repository part of the image name to search for in containers and initContainers. |
|
| imageToFind | The image name to search for in containers and initContainers. |
|
| tagToFind | Optional. The tag part of the image name to search for in containers and initContainers. |
|
| digestToFind | Optional. The digest part of the image name to search for in containers and initContainers. |
|
| repoToUpdate | Optional. The repository part of the image name to update to in containers and initContainers. |
|
| imageToUpdate | Optional. The image name to update to in containers and initContainers. |
|
| tagToUpdate | Optional. The tag part of the image name to update to in containers and initContainers. |
|
| digestToUpdate | Optional. The digest part of the image name to update to in containers and initContainers. |
|
| includeInitContainers | Optional. Boolean to indicate whether or not to treat initContainers/image identically to containers/image. |
|
| 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:
Now that com.yourorg.UpdateContainerImageNameExample
has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-kubernetes:2.2.3 in your build file:
Add the following to your
build.gradle
file:
Run
gradle rewriteRun
to run the recipe.
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, DavidTamLloyds, Knut Wannheden, Jonathan Schnéider, Tim te Beek, Aaron Gershman
Last updated