Comment code generation stuff

pkgs/generators/crd.nix

@@ -5,6 +5,12 @@
   src,
   crds,
 }: let
+  # The nix code generator is slightly modified from kubenix's
+  # generator and as it kind of depends on the jsonschema to be
+  # flattened with `$ref`s we first pre-process the CRD with
+  # a crude python script to flatten it before running the
+  # generator.
+  # See: crd2jsonschema.py
   schema = let
     pythonWithYaml = pkgs.python3.withPackages (ps: [ps.pyyaml]);
   in

pkgs/generators/crd2jsonschema.py

@@ -93,6 +93,11 @@ def flatten_ref(definition, key, root=True):
             newProps = {}
 
             for prop, val in definition['properties'].items():
+                # CRDs never have the type information for metadata and
+                # as we already have this type information from kubenix's
+                # generated options we create a special `$ref` with
+                # '#/global' prefix that we handle specially in our code
+                # generator.
                 if root and prop == 'metadata':
                     newProps[prop] = {
                         'description': 'Standard object\'s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata',

pkgs/generators/jsonschema.nix

@@ -133,6 +133,9 @@ with lib; let
                     # but if other definition does not have properties, then just take it's type
                     if hasAttr "$ref" property
                     then
+                      # Handle our special "#/global" ref prefix, used exclusively to get typed
+                      # metadata from CRDs.
+                      # See: crd2jsonschema.py
                       if hasPrefix "#/global" property."$ref"
                       then {
                         type = requiredOrNot (globalSubmoduleOf definitions (refDefinition property));