Add configurable logging to CiscoDevice API (#74)

Co-authored-by: Richard Cunningham <cunningr@cisco.com>

Author: cunningr

api/v1alpha1/types.go

@@ -117,6 +117,13 @@ type DeviceSpec struct {
 	// +kubebuilder:validation:Optional
 	Zone string `json:"zone,omitempty" mapstructure:"zone,omitempty"`
 
+	// LogLevel sets the logging verbosity for the VK instance.
+	// Valid values are: debug, info, warn, error.
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:validation:Enum=debug;info;warn;error
+	// +kubebuilder:default=info
+	LogLevel string `json:"logLevel,omitempty" mapstructure:"logLevel"`
+
 	// ResourceLimits defines default and maximum resource allocations.
 	// +kubebuilder:validation:Optional
 	ResourceLimits ResourceConfig `json:"resourceLimits,omitempty" mapstructure:"resourceLimits"`

charts/cisco-virtual-kubelet/crds/cisco.vk_ciscodevices.yaml

@@ -96,6 +96,17 @@ spec:
                   type: string
                 description: Labels to apply to the virtual kubelet node.
                 type: object
+              logLevel:
+                default: info
+                description: |-
+                  LogLevel sets the logging verbosity for the VK instance.
+                  Valid values are: debug, info, warn, error.
+                enum:
+                - debug
+                - info
+                - warn
+                - error
+                type: string
               maxPods:
                 default: 16
                 description: MaxPods is the maximum number of pods the device can

cmd/cisco-vk/run.go

@@ -139,11 +139,14 @@ func runVirtualKubelet(cmd *cobra.Command, args []string) error {
 		},
 	})
 
-	// Log level: flag > env > default
+	// Log level: flag > env > config > default
 	lvl := logLevel
 	if lvl == "" {
 		lvl = os.Getenv("LOG_LEVEL")
 	}
+	if lvl == "" {
+		lvl = appCfg.Device.LogLevel
+	}
 	if err := validateLogLevel(lvl); err != nil {
 		return err
 	}

config/crd/cisco.vk_ciscodevices.yaml

@@ -96,6 +96,17 @@ spec:
                   type: string
                 description: Labels to apply to the virtual kubelet node.
                 type: object
+              logLevel:
+                default: info
+                description: |-
+                  LogLevel sets the logging verbosity for the VK instance.
+                  Valid values are: debug, info, warn, error.
+                enum:
+                - debug
+                - info
+                - warn
+                - error
+                type: string
               maxPods:
                 default: 16
                 description: MaxPods is the maximum number of pods the device can

dev/deviceConfig.yaml

@@ -12,6 +12,7 @@ spec:
   tls:
     enabled: true
     insecureSkipVerify: true
+  logLevel: info
   podCIDR: "10.0.0.0/24"
   xe:
     networking:

internal/config/testdata/valid_config.yaml

@@ -4,6 +4,7 @@ device:
   port: 80
   username: admin
   password: admin
+  logLevel: debug
   tls:
     enabled: true
     insecureSkipVerify: true

internal/controller/ciscodevice_controller.go

@@ -178,11 +178,7 @@ func (r *CiscoDeviceReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 				{
 					Name:  "cisco-vk",
 					Image: image,
-					Args: []string{
-						"run",
-						"--config", configMountPath + "/" + configFileName,
-						"--nodename", device.Name,
-					},
+					Args:  vkContainerArgs(device.Name, device.Spec.LogLevel),
 					VolumeMounts: []corev1.VolumeMount{
 						{
 							Name:      "device-config",
@@ -255,6 +251,20 @@ func renderDeviceConfig(spec *ciskov1.DeviceSpec) (string, error) {
 	return string(out), nil
 }
 
+// vkContainerArgs builds the argument list for the VK container.
+// If logLevel is set on the CiscoDevice spec it is forwarded via --log-level.
+func vkContainerArgs(deviceName, logLevel string) []string {
+	args := []string{
+		"run",
+		"--config", configMountPath + "/" + configFileName,
+		"--nodename", deviceName,
+	}
+	if logLevel != "" {
+		args = append(args, "--log-level", logLevel)
+	}
+	return args
+}
+
 // shortHash returns the first 8 hex chars of an FNV-1a hash of s.
 // Used as a cheap change-detector for pod template annotations.
 func shortHash(s string) string {

internal/controller/ciscodevice_controller_test.go

@@ -326,6 +326,63 @@ func TestReconcile_OwnerReferenceSet(t *testing.T) {
 	}
 }
 
+// ─────────────────────────────────────────────────────────────────────────────
+// vkContainerArgs helper
+// ─────────────────────────────────────────────────────────────────────────────
+
+func TestVkContainerArgs_NoLogLevel(t *testing.T) {
+	args := vkContainerArgs("router-x", "")
+	for _, a := range args {
+		if a == "--log-level" {
+			t.Fatal("--log-level should not be present when logLevel is empty")
+		}
+	}
+	if args[0] != "run" {
+		t.Errorf("expected first arg 'run', got %q", args[0])
+	}
+}
+
+func TestVkContainerArgs_WithLogLevel(t *testing.T) {
+	args := vkContainerArgs("router-x", "debug")
+	found := false
+	for i, a := range args {
+		if a == "--log-level" && i+1 < len(args) && args[i+1] == "debug" {
+			found = true
+			break
+		}
+	}
+	if !found {
+		t.Errorf("expected --log-level debug in args, got %v", args)
+	}
+}
+
+func TestReconcile_LogLevelPassedToDeployment(t *testing.T) {
+	device := newDevice("router-ll", "default")
+	device.Spec.LogLevel = "debug"
+	r := reconcilerFor(t, device)
+	ctx := context.Background()
+
+	if _, err := r.Reconcile(ctx, reconcileRequest("default", "router-ll")); err != nil {
+		t.Fatalf("Reconcile error: %v", err)
+	}
+
+	var deploy appsv1.Deployment
+	if err := r.Get(ctx, types.NamespacedName{Namespace: "default", Name: "router-ll" + deploymentSuffix}, &deploy); err != nil {
+		t.Fatalf("Deployment not found: %v", err)
+	}
+	args := deploy.Spec.Template.Spec.Containers[0].Args
+	found := false
+	for i, a := range args {
+		if a == "--log-level" && i+1 < len(args) && args[i+1] == "debug" {
+			found = true
+			break
+		}
+	}
+	if !found {
+		t.Errorf("expected --log-level debug in container args, got %v", args)
+	}
+}
+
 // ─────────────────────────────────────────────────────────────────────────────
 // Pure helper: renderDeviceConfig
 // ─────────────────────────────────────────────────────────────────────────────