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

TypeNameDescriptionExample

String

repoToFind

Optional. The repository part of the image name to search for in containers and initContainers.

gcr.io

String

imageToFind

The image name to search for in containers and initContainers.

nginx

String

tagToFind

Optional. The tag part of the image name to search for in containers and initContainers.

v1.2.3

String

digestToFind

Optional. The digest part of the image name to search for in containers and initContainers.

sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229

String

repoToUpdate

Optional. The repository part of the image name to update to in containers and initContainers.

gcr.io/account/bucket

String

imageToUpdate

Optional. The image name to update to in containers and initContainers.

nginx

String

tagToUpdate

Optional. The tag part of the image name to update to in containers and initContainers.

v1.2.3

String

digestToUpdate

Optional. The digest part of the image name to update to in containers and initContainers.

sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229

boolean

includeInitContainers

Optional. Boolean to indicate whether or not to treat initContainers/image identically to containers/image.

false

String

fileMatcher

Optional. Matching files will be modified. This is a glob expression.

**/pod-*.yml

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
      digestToFind: sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229
      repoToUpdate: gcr.io/account/bucket
      imageToUpdate: nginx
      tagToUpdate: v1.2.3
      digestToUpdate: sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229
      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.2.3 in your build file:

  1. Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.10.0")
}

rewrite {
    activeRecipe("com.yourorg.UpdateContainerImageNameExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-kubernetes:2.2.3")
}
  1. 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