Skip to main content

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​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

TypeNameDescriptionExample
StringrepoToFindOptional. The repository part of the image name to search for in containers and initContainers.gcr.io
StringimageToFindThe image name to search for in containers and initContainers.nginx
StringtagToFindOptional. The tag part of the image name to search for in containers and initContainers.v1.2.3
StringdigestToFindOptional. The digest part of the image name to search for in containers and initContainers.sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229
StringrepoToUpdateOptional. The repository part of the image name to update to in containers and initContainers.gcr.io/account/bucket
StringimageToUpdateOptional. The image name to update to in containers and initContainers.nginx
StringtagToUpdateOptional. The tag part of the image name to update to in containers and initContainers.v1.2.3
StringdigestToUpdateOptional. The digest part of the image name to update to in containers and initContainers.sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229
booleanincludeInitContainersOptional. Boolean to indicate whether or not to treat initContainers/image identically to containers/image.false
StringfileMatcherOptional. Matching files will be modified. This is a glob expression.**/pod-*.yml

Example​

Parameters​
ParameterValue
repoToFindnull
imageToFindnginx
tagToFindnull
digestToFindnull
repoToUpdategcr.io/myaccount/myrepo
imageToUpdatenginx-custom
tagToUpdatelatest
digestToUpdatenull
includeInitContainersfalse
fileMatchernull
Before​
apiVersion: v1
kind: Pod
spec:
    containers:
    - image: nginx
---
apiVersion: v1
kind: Pod
spec:
    containers:
    - image: gcr.io/myaccount/myrepo/nginx
    initContainers:
    - image: gcr.io/myaccount/myrepo/myinit:latest
After​
apiVersion: v1
kind: Pod
spec:
    containers:
    - image: gcr.io/myaccount/myrepo/nginx-custom:latest
---
apiVersion: v1
kind: Pod
spec:
    containers:
    - image: gcr.io/myaccount/myrepo/nginx
    initContainers:
    - image: gcr.io/myaccount/myrepo/myinit:latest

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

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'

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe UpdateContainerImageName --recipe-option "repoToFind=gcr.io" --recipe-option "imageToFind=nginx" --recipe-option "tagToFind=v1.2.3" --recipe-option "digestToFind=sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229" --recipe-option "repoToUpdate=gcr.io/account/bucket" --recipe-option "imageToUpdate=nginx" --recipe-option "tagToUpdate=v1.2.3" --recipe-option "digestToUpdate=sha256:cb5c1bddd1b5665e1867a7fa1b5fa843a47ee433bbb75d4293888b71def53229" --recipe-option "includeInitContainers=false" --recipe-option "fileMatcher='**/pod-*.yml'"

If the recipe is not available locally, then you can install it using:

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

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Jon Brisbin, DavidTamLloyds, Jonathan Schnéider, Knut Wannheden, Tim te Beek, Aaron Gershman