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

Find Das Schiff network operator ConfigMaps

Recipe IDio.moderne.kubernetes.sylva.migrate.dasschiff.FindNetworkOperatorConfigMap

Artifactorg.openrewrite.recipe:rewrite-kubernetes

Inventory the ConfigMaps that configure Das Schiff's network operator, reporting for each data key how the value is written and how large it is. Each key is a whole embedded document the operator hands to its node agents as a file, not a setting. Nothing here reads those documents, so the report holds for any version of them.

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
configMapName	schiff-network	String	Optional
A glob matched against metadata.name. Replaces the default network-operator-*, the namePrefix that config/default gives every resource the operator ships, so a deployment that renames them is matched by this instead rather than as well. A ConfigMap still qualifies on either of the other two signals, so one carrying the operator label or a base-config.yaml key is reported whatever this is set to.

Examples

yaml

Parameter	Value
configMapName	null

yaml

Before

apiVersion: v1
data:
  base-config.yaml: |
    vtepLoopbackIP: ""
    exportCIDRs: []
    localASN: ""
    trunkInterfaceName: hbn
    underlayNeighbors: []
    clusterNeighbors: []
    clusterVRF:
      name: cluster
      vni: ""
      evpnRouteTarget: ""
  10-base.yaml: |
    network:
      version: 2
      ethernets:
        hbn:
          addresses:
          - fd00:7:caa5::/127
          mtu: 1500
kind: ConfigMap
metadata:
  labels:
    app.kubernetes.io/name: network-operator
  name: network-operator-base-config
  namespace: kube-system
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: calico-config
  namespace: kube-system
data:
  calico_backend: bird
  veth_mtu: "1500"

After

apiVersion: v1
data:
  base-config.yaml: |
    vtepLoopbackIP: ""
    exportCIDRs: []
    localASN: ""
    trunkInterfaceName: hbn
    underlayNeighbors: []
    clusterNeighbors: []
    clusterVRF:
      name: cluster
      vni: ""
      evpnRouteTarget: ""
  10-base.yaml: |
    network:
      version: 2
      ethernets:
        hbn:
          addresses:
          - fd00:7:caa5::/127
          mtu: 1500
~~(base-config.yaml (block), 10-base.yaml (block); matched by name, label, data key)~~>kind: ConfigMap
metadata:
  labels:
    app.kubernetes.io/name: network-operator
  name: network-operator-base-config
  namespace: kube-system
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: calico-config
  namespace: kube-system
data:
  calico_backend: bird
  veth_mtu: "1500"

Diff

@@ -22,1 +22,1 @@
          - fd00:7:caa5::/127
          mtu: 1500
-kind: ConfigMap
+~~(base-config.yaml (block), 10-base.yaml (block); matched by name, label, data key)~~>kind: ConfigMap
metadata:

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 FindNetworkOperatorConfigMap

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

Das Schiff network operator ConfigMaps

io.moderne.kubernetes.sylva.migrate.dasschiff.table.NetworkOperatorConfigMaps

One row per data key of every ConfigMap that configures Deutsche Telekom's das-schiff-network-operator, describing where it lives and what shape it is in. A ConfigMap that declares no keys still gets a row, so that the inventory is of ConfigMaps and not only of keys.

Column	Description
Source path	The path to the manifest.
Namespace	The metadata.namespace, empty when the manifest leaves it to the applying context, as a Kustomize overlay or a Helm release does.
Name	The metadata.name of the ConfigMap. A Kustomize namePrefix is not applied here, so the name in the cluster may carry a prefix this one does not.
Key	One key of data, or of binaryData. Empty when the ConfigMap declares neither.
Style	How the value is written: block for a literal block scalar (|), folded (>), plain, single quoted, double quoted, or binary for a binaryData key. A mapping or sequence is malformed, because every ConfigMap value is a string.
Size	Characters in the value, block scalars dedented, so that the number is the size of the embedded document rather than of its indentation. For binaryData, the length of the base64 text.
Matched by	Which signals identified this as a network operator ConfigMap: name, label for app.kubernetes.io/name: network-operator, data key for a base-config.yaml key. Listed so that a row can be judged rather than trusted.
Templated	yes when the document contains a Helm expression, in which case the keys and sizes here are those of the template and not of what the cluster receives.

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.