Skip to main content
Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Migrate Ingress to networking.k8s.io/v1

Recipe IDorg.openrewrite.kubernetes.migrate.MigrateIngressToNetworkingV1
Artifactorg.openrewrite.recipe:rewrite-kubernetes

Move Ingress from extensions/v1beta1 and networking.k8s.io/v1beta1, both removed in Kubernetes v1.22, to networking.k8s.io/v1, restructuring the body the new version requires. spec.backend becomes spec.defaultBackend, every backend.serviceName and backend.servicePort pair becomes backend.service.name and backend.service.port, and every path gains the explicit pathType: ImplementationSpecific that v1beta1 used to default to. servicePort is an int-or-string, so how it is written decides where it lands: an unquoted 8080 is the port number and becomes port.number, while a quoted "8080" or a bare http is the port's name and becomes port.name. An Ingress the restructuring cannot carry over in full is left on its old API version and marked with the reason, rather than being handed to the apiserver in a shape it rejects.

Single recipeOpenRewriteModerne Proprietary License
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options​

2 parameters
2 optional
ParameterExampleTypeRequired
fileMatcher**/ingress-*.ymlStringOptional
Matching files will be modified. This is a glob expression.
migrateIngressClassAnnotation—BooleanOptional
Also move the deprecated kubernetes.io/ingress.class annotation to spec.ingressClassName. Off by default, and off in kubectl convert, because the two are not the same thing: the annotation is a free-form string each controller interprets for itself, while ingressClassName names an IngressClass resource that has to exist in the cluster. Turning this on for a cluster whose controller reads only the annotation, or that has no matching IngressClass, leaves the Ingress unclaimed.

Examples​

yaml
ParameterValue
migrateIngressClassAnnotationnull
fileMatchernull
Before
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: store
spec:
  backend:
    serviceName: default-backend
    servicePort: 80
  rules:
    - host: store.example.com
      http:
        paths:
          - path: /cart
            backend:
              serviceName: cart
              servicePort: 8080
          - path: /images
            backend:
              serviceName: images
              servicePort: http
---
apiVersion: v1
kind: Service
metadata:
  name: cart
spec:
  ports:
    - port: 8080
After
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: store
spec:
  defaultBackend:
    service:
      name: default-backend
      port:
        number: 80
  rules:
    - host: store.example.com
      http:
        paths:
          - path: /cart
            pathType: ImplementationSpecific
            backend:
              service:
                name: cart
                port:
                  number: 8080
          - path: /images
            pathType: ImplementationSpecific
            backend:
              service:
                name: images
                port:
                  name: http
---
apiVersion: v1
kind: Service
metadata:
  name: cart
spec:
  ports:
    - port: 8080

Usage​

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

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

shell
mod run . --recipe MigrateIngressToNetworkingV1

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

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

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

Data tables​

Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

ColumnDescription
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.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run 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.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe specific recipe that added the Search marker.
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)The total time spent across the scanning phase of this recipe.
Max scanning time (ns)The max time scanning any one source file.
Cumulative edit time (ns)The total time spent across the editing phase of this recipe.
Max edit time (ns)The max time editing any one source file.