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 the Cluster API core group to v1beta2

Recipe IDorg.openrewrite.kubernetes.clusterapi.MigrateClusterApiCoreResourceToV1beta2
Artifactorg.openrewrite.recipe:rewrite-kubernetes

Rewrite cluster.x-k8s.io/v1beta1 resources into their v1beta2 form, fields and apiVersion together. v1beta1 has been deprecated since Cluster API v1.11 and stops being served in v1.16. A resource moves as a whole or not at all: where v1beta2 dropped a field outright, or a duration cannot be read exactly, it stays on v1beta1 and the reason is reported.

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**/cluster-*.ymlStringOptional
Matching files will be modified. This is a glob expression.
kindMachineDeploymentStringOptional
Only migrate this kind. Omit to migrate every kind the core group owns, though org.openrewrite.kubernetes.clusterapi.MigrateClusterApiCoreToV1beta2 names them one by one and is the better entry point.

Examples​

yaml
ParameterValue
kindnull
fileMatchernull
Before
apiVersion: cluster.x-k8s.io/v1beta1
kind: Cluster
metadata:
  name: demo
spec:
  controlPlaneRef:
    apiVersion: controlplane.cluster.x-k8s.io/v1beta1
    kind: K0sControlPlane
    name: demo-cp
  infrastructureRef:
    apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
    kind: AWSCluster
    name: demo
---
apiVersion: cluster.x-k8s.io/v1beta1
kind: MachineDeployment
metadata:
  name: demo-md
spec:
  clusterName: demo
  replicas: 3
  template:
    spec:
      clusterName: demo
      version: v1.34.0
      bootstrap:
        configRef:
          apiVersion: bootstrap.cluster.x-k8s.io/v1beta1
          kind: K0sWorkerConfigTemplate
          name: demo-worker
      infrastructureRef:
        apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
        kind: AWSMachineTemplate
        name: demo-worker
      nodeDrainTimeout: 10m
After
apiVersion: cluster.x-k8s.io/v1beta2
kind: Cluster
metadata:
  name: demo
spec:
  controlPlaneRef:
    apiGroup: controlplane.cluster.x-k8s.io
    kind: K0sControlPlane
    name: demo-cp
  infrastructureRef:
    apiGroup: infrastructure.cluster.x-k8s.io
    kind: AWSCluster
    name: demo
---
apiVersion: cluster.x-k8s.io/v1beta2
kind: MachineDeployment
metadata:
  name: demo-md
spec:
  clusterName: demo
  replicas: 3
  template:
    spec:
      clusterName: demo
      version: v1.34.0
      bootstrap:
        configRef:
          apiGroup: bootstrap.cluster.x-k8s.io
          kind: K0sWorkerConfigTemplate
          name: demo-worker
      infrastructureRef:
        apiGroup: infrastructure.cluster.x-k8s.io
        kind: AWSMachineTemplate
        name: demo-worker
      deletion:
        nodeDrainTimeoutSeconds: 600

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 MigrateClusterApiCoreResourceToV1beta2

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​

Cluster API v1beta2 migrations
org.openrewrite.kubernetes.clusterapi.table.ClusterApiV1beta2Migrations

Every cluster.x-k8s.io/v1beta1 resource considered, what moving it to v1beta2 rewrote, and why the ones left behind could not move.

ColumnDescription
Source pathThe path to the manifest.
KindThe kind of the resource.
NameThe metadata.name of the resource.
Migrationautomatic when the resource was rewritten, manual when it was left alone.
ChangesThe fields that moved or were renamed, empty when the resource only needed its apiVersion changed.
Follow-upValues v1beta2 has no field for, durations that lost sub-second precision on the way to whole seconds, and template references still naming a version this recipe cannot re-point. Empty when the rewrite carried everything over.
BlockerWhy the resource was left on v1beta1, empty when it was migrated.
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.