resourcebuilder/core: Improve user logs and comments

* Fix assumptions about NodeKind in comments
* Log the actual NodeKind during tls injection
* Other minor tweaks

Author: vincentdephily

lib/resourcebuilder/core.go

@@ -40,13 +40,15 @@ type tlsConfig struct {
 	cipherSuites  optional[[]string]
 }
 
+// modifyConfigMap sets/clears minTLSVersion and cipherSuites in the CM's data entries if
+// * ConfigMapInjectTLSAnnotation is "true"
+// * Data entry kind is GenericOperatorConfig or GenericControllerConfig
 func (b *builder) modifyConfigMap(ctx context.Context, cm *corev1.ConfigMap) error {
 	// Check for TLS injection annotation
 	if value, ok := cm.Annotations[ConfigMapInjectTLSAnnotation]; !ok || value != "true" {
 		return nil
 	}
-
-	klog.V(2).Infof("ConfigMap %s/%s has %s annotation set to true", cm.Namespace, cm.Name, ConfigMapInjectTLSAnnotation)
+	klog.V(2).Infof("ConfigMap %s/%s has annotation %s: true", cm.Namespace, cm.Name, ConfigMapInjectTLSAnnotation)
 
 	// Empty data, nothing to inject into
 	if cm.Data == nil {
@@ -71,7 +73,7 @@ func (b *builder) modifyConfigMap(ctx context.Context, cm *corev1.ConfigMap) err
 	klog.V(4).Infof("ConfigMap %s/%s: observed minTLSVersion=%v, cipherSuites=%v",
 		cm.Namespace, cm.Name, minTLSLog, cipherSuitesLog)
 
-	// Process each data entry that contains GenericOperatorConfig
+	// Process each data key
 	for key, value := range cm.Data {
 		klog.V(4).Infof("Processing %q key", key)
 		// Parse YAML into RNode to preserve formatting and field order
@@ -82,18 +84,19 @@ func (b *builder) modifyConfigMap(ctx context.Context, cm *corev1.ConfigMap) err
 			continue
 		}
 
-		// Check if this is a supported config kind
+		// Check if this is a supported data node kind
+		rnodeKind := rnode.GetKind()
 		switch {
-		case rnode.GetKind() == "GenericOperatorConfig" && rnode.GetApiVersion() == operatorv1alpha1.GroupVersion.String():
-		case rnode.GetKind() == "GenericControllerConfig" && rnode.GetApiVersion() == configv1.GroupVersion.String():
+		case rnodeKind == "GenericOperatorConfig" && rnode.GetApiVersion() == operatorv1alpha1.GroupVersion.String():
+		case rnodeKind == "GenericControllerConfig" && rnode.GetApiVersion() == configv1.GroupVersion.String():
 		default:
 			klog.V(4).Infof("ConfigMap's %q entry is not a supported config type. Only GenericOperatorConfig (%v) and GenericControllerConfig (%v) are. Skipping this entry", key, operatorv1alpha1.GroupVersion.String(), configv1.GroupVersion.String())
 			continue
 		}
 
-		klog.V(2).Infof("ConfigMap %s/%s processing GenericOperatorConfig in key %s", cm.Namespace, cm.Name, key)
+		klog.V(2).Infof("ConfigMap %s/%s processing %s in key %s", cm.Namespace, cm.Name, rnodeKind, key)
 
-		// Inject TLS settings into the GenericOperatorConfig while preserving structure
+		// Inject TLS settings into the data node while preserving structure
 		if err := updateRNodeWithTLSSettings(rnode, tlsConf); err != nil {
 			return fmt.Errorf("failed to inject the TLS configuration: %v", err)
 		}
@@ -106,7 +109,7 @@ func (b *builder) modifyConfigMap(ctx context.Context, cm *corev1.ConfigMap) err
 
 		// Update the ConfigMap data entry with the modified YAML
 		cm.Data[key] = modifiedYAML
-		klog.V(2).Infof("ConfigMap %s/%s updated GenericOperatorConfig with TLS profile in key %s", cm.Namespace, cm.Name, key)
+		klog.V(2).Infof("ConfigMap %s/%s updated TLS profile of %s in key %s", cm.Namespace, cm.Name, rnodeKind, key)
 	}
 	return nil
 }
@@ -153,7 +156,8 @@ func (b *builder) observeTLSConfiguration(ctx context.Context, cm *corev1.Config
 	return config, nil
 }
 
-// updateRNodeWithTLSSettings injects TLS settings into a GenericOperatorConfig RNode while preserving structure.
+// updateRNodeWithTLSSettings injects TLS settings into an RNode while preserving structure.
+// Assumes a GenericOperatorConfig or GenericControllerConfig schema.
 // If a field in tlsConf is not found, the corresponding field will be deleted from the RNode.
 func updateRNodeWithTLSSettings(rnode *yaml.RNode, tlsConf *tlsConfig) error {
 	servingInfo, err := rnode.Pipe(yaml.LookupCreate(yaml.MappingNode, "servingInfo"))