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 deprecated k0rdent serviceSpec fields

Recipe IDorg.openrewrite.kubernetes.k0rdent.MigrateDeprecatedServiceSpecFields

Artifactorg.openrewrite.recipe:rewrite-kubernetes

Move the fields k0rdent deprecated on spec.serviceSpec into the spec.serviceSpec.provider.config blob that supersedes them, on ClusterDeployment and MultiClusterService. The nine that move are syncMode, templateResourceRefs, policyRefs, driftIgnore, driftExclusions, priority, stopOnConflict, reload and continueOnError, plus createNamespace and replace on each service's helmOptions, which move into helmOptions.installOptions. reload is renamed to reloader on the way, because that is the key the state management provider unmarshals; a hand migration that keeps the old spelling produces a manifest the apiserver accepts and the controller ignores. Fields are left where they are, and reported in a data table, when the move would change what the resource does: the document renders through Helm, so what is written is not what is applied; provider.name or provider.config is already set, in which case the controller is already ignoring the deprecated fields and moving them would switch settings on; installOptions already declares a different value; or the resource is declared against k0rdent.mirantis.com/v1alpha1, whose schema has no provider field at all, so the apiserver would prune whatever was written there. The provider.name case is the subtle one. StateManagementProviderConfigFromServiceSpec folds the deprecated fields into a config blob only when neither provider.name nor provider.config is set; name it, and every deprecated field is discarded. Moving them into provider.config would hand a named provider a syncMode, priority or reloader it is not acting on today.

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

1 parameters

1 optional

Parameter	Example	Type	Required
fileMatcher	**/*-multiclusterservice.yaml	String	Optional
Matching files will be modified. This is a glob expression.

Examples

yaml

Parameter	Value
fileMatcher	null

yaml

Before

apiVersion: k0rdent.mirantis.com/v1beta1
kind: MultiClusterService
metadata:
  name: global-kyverno
spec:
  clusterSelector:
    matchLabels:
      k0rdent: demo
  serviceSpec:
    syncMode: ContinuousWithDriftDetection
    priority: 1000
    reload: true
    templateResourceRefs:
      - identifier: ConfigMap
        resource:
          apiVersion: v1
          kind: ConfigMap
          name: kof-namespace-template
    services:
      - template: kyverno-3-2-6
        name: kyverno
        namespace: kyverno
---
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterDeployment
metadata:
  name: untouched
spec:
  template: aws-standalone-cp-1-0-42
  serviceSpec:
    services:
      - template: ingress-nginx-4-11-0
        name: ingress-nginx
        namespace: ingress-nginx

After

apiVersion: k0rdent.mirantis.com/v1beta1
kind: MultiClusterService
metadata:
  name: global-kyverno
spec:
  clusterSelector:
    matchLabels:
      k0rdent: demo
  serviceSpec:
    services:
      - template: kyverno-3-2-6
        name: kyverno
        namespace: kyverno
    provider:
      config:
        syncMode: ContinuousWithDriftDetection
        priority: 1000
        reloader: true
        templateResourceRefs:
          - identifier: ConfigMap
            resource:
              apiVersion: v1
              kind: ConfigMap
              name: kof-namespace-template
---
apiVersion: k0rdent.mirantis.com/v1beta1
kind: ClusterDeployment
metadata:
  name: untouched
spec:
  template: aws-standalone-cp-1-0-42
  serviceSpec:
    services:
      - template: ingress-nginx-4-11-0
        name: ingress-nginx
        namespace: ingress-nginx

Diff

--- MultiClusterServices/kyverno.yaml
+++ MultiClusterServices/kyverno.yaml
@@ -10,9 +10,0 @@
      k0rdent: demo
  serviceSpec:
-   syncMode: ContinuousWithDriftDetection
-   priority: 1000
-   reload: true
-   templateResourceRefs:
-     - identifier: ConfigMap
-       resource:
-         apiVersion: v1
-         kind: ConfigMap
-         name: kof-namespace-template
    services:
@@ -23,0 +14,11 @@
        name: kyverno
        namespace: kyverno
+   provider:
+     config:
+       syncMode: ContinuousWithDriftDetection
+       priority: 1000
+       reloader: true
+       templateResourceRefs:
+         - identifier: ConfigMap
+           resource:
+             apiVersion: v1
+             kind: ConfigMap
+             name: kof-namespace-template
---

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 MigrateDeprecatedServiceSpecFields

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.

RELEASE

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

LATEST

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

Pinned version

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

Data tables

Deprecated k0rdent `serviceSpec` fields

org.openrewrite.kubernetes.table.DeprecatedServiceSpecFields

Every deprecated serviceSpec field found, where it was moved to, and for the ones that were left in place, why.

Column	Description
Source path	The path of the manifest the field was found in.
Kind	The kind of the resource carrying the field.
Name	The metadata.name of the resource carrying the field.
Field	The deprecated field, relative to the document root.
Moved to	Where the field was written, empty when it was left in place.
Outcome	Moved when the field was relocated, Renamed when it was relocated under a different name, Templated when the document renders through Helm and so does not mean on disk what it means in the cluster, Provider config already set when provider.config is present and the controller is therefore already ignoring this field, Provider already named when provider.name is set, which discards the deprecated fields just as surely, Conflicting value when the destination already declares something else, Unsupported API version when the resource is declared against a version whose schema has no destination for it, or Unsupported layout when the field or its destination is written as a flow mapping, which entries can be neither lifted out of nor appended to, or holds a block scalar, whose continuation lines cannot be re-indented with it.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A 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 changes	In 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 changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The 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.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The 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.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The 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.