updates to readability, standard practices, optimizations, etc

Signed-off-by: Brian Downs <[email protected]>

Makefile

@@ -11,4 +11,4 @@ $(TARGETS): .dapper
 
 .DEFAULT_GOAL := default
 
-.PHONY: $(TARGETS)
+.PHONY: $(TARGETS)

cli/cmds/cluster/create.go

@@ -118,6 +118,7 @@ var (
 
 func create(clx *cli.Context) error {
 	ctx := context.Background()
+
 	if err := validateCreateFlags(); err != nil {
 		return err
 	}
@@ -226,8 +227,8 @@ func validateCreateFlags() error {
 	if cmds.Kubeconfig == "" && os.Getenv("KUBECONFIG") == "" {
 		return errors.New("empty kubeconfig")
 	}
-	if mode != "shared" && mode != "virtual" {
-		return errors.New(`mode should be one of "shared" or "virtual"`)
+	if mode != k3kcluster.OperatingModeShared && mode != k3kcluster.OperatingModeVirtual {
+		return errors.New("mode should be one of " + k3kcluster.OperatingModeShared + " or " + k3kcluster.OperatingModeVirtual)
 	}
 
 	return nil

cli/cmds/cluster/delete.go

@@ -44,5 +44,6 @@ func delete(clx *cli.Context) error {
 			Namespace: cmds.Namespace(),
 		},
 	}
+
 	return ctrlClient.Delete(ctx, &cluster)
 }

cli/cmds/kubeconfig/kubeconfig.go

@@ -93,7 +93,6 @@ func NewCommand() cli.Command {
 }
 
 func generate(clx *cli.Context) error {
-	var cluster v1alpha1.Cluster
 	ctx := context.Background()
 
 	restConfig, err := clientcmd.BuildConfigFromFlags("", cmds.Kubeconfig)
@@ -107,6 +106,8 @@ func generate(clx *cli.Context) error {
 	if err != nil {
 		return err
 	}
+
+	var cluster v1alpha1.Cluster
 	clusterKey := types.NamespacedName{
 		Name:      name,
 		Namespace: cmds.Namespace(),
@@ -126,12 +127,14 @@ func generate(clx *cli.Context) error {
 	if org == nil {
 		org = cli.StringSlice{user.SystemPrivilegedGroup}
 	}
+
 	cfg := kubeconfig.KubeConfig{
 		CN:         cn,
 		ORG:        org,
 		ExpiryDate: time.Hour * 24 * time.Duration(expirationDays),
 		AltNames:   certAltNames,
 	}
+
 	logrus.Infof("waiting for cluster to be available..")
 	var kubeconfig []byte
 	if err := retry.OnError(controller.Backoff, apierrors.IsNotFound, func() error {
@@ -143,6 +146,7 @@ func generate(clx *cli.Context) error {
 	}); err != nil {
 		return err
 	}
+
 	pwd, err := os.Getwd()
 	if err != nil {
 		return err

cli/cmds/root.go

@@ -55,5 +55,6 @@ func Namespace() string {
 	if namespace == "" {
 		return defaultNamespace
 	}
+
 	return namespace
 }

k3k-kubelet/README.md → docs/shared_mode.md

@@ -1,6 +1,6 @@
 ## Virtual Kubelet
 
-This package provides an impelementation of a virtual cluster node using [virtual-kubelet](https://github.com/virtual-kubelet/virtual-kubelet).
+The shared mode of k3k is an impelementation of a virtual cluster node using [virtual-kubelet](https://github.com/virtual-kubelet/virtual-kubelet).
 
 The implementation is based on several projects, including:
 - [Virtual Kubelet](https://github.com/virtual-kubelet/virtual-kubelet)

k3k-kubelet/config.go

@@ -54,6 +54,7 @@ func (c *config) unmarshalYAML(data []byte) error {
 	if c.AgentIP == "" {
 		c.AgentIP = conf.AgentIP
 	}
+
 	return nil
 }
 
@@ -67,6 +68,7 @@ func (c *config) validate() error {
 	if c.AgentHostname == "" {
 		return errors.New("agent Hostname is not provided")
 	}
+
 	return nil
 }
 
@@ -79,5 +81,6 @@ func (c *config) parse(path string) error {
 	if err != nil {
 		return err
 	}
+
 	return c.unmarshalYAML(b)
 }

k3k-kubelet/controller/configmap.go

@@ -2,7 +2,6 @@ package controller
 
 import (
 	"context"
-	"fmt"
 	"sync"
 
 	"github.com/rancher/k3k/pkg/controller"
@@ -17,7 +16,7 @@ import (
 )
 
 type ConfigMapSyncer struct {
-	mutex sync.RWMutex
+	mu sync.RWMutex
 	// VirtualClient is the client for the virtual cluster
 	VirtualClient client.Client
 	// CoreClient is the client for the host cluster
@@ -41,16 +40,14 @@ func (c *ConfigMapSyncer) Reconcile(ctx context.Context, req reconcile.Request)
 	var virtual corev1.ConfigMap
 
 	if err := c.VirtualClient.Get(ctx, req.NamespacedName, &virtual); err != nil {
-		return reconcile.Result{
-			Requeue: true,
-		}, fmt.Errorf("unable to get configmap %s/%s from virtual cluster: %w", req.Namespace, req.Name, err)
+		return reconcile.Result{Requeue: true}, err
 	}
+
 	translated, err := c.TranslateFunc(&virtual)
 	if err != nil {
-		return reconcile.Result{
-			Requeue: true,
-		}, fmt.Errorf("unable to translate configmap %s/%s from virtual cluster: %w", req.Namespace, req.Name, err)
+		return reconcile.Result{Requeue: true}, err
 	}
+
 	translatedKey := types.NamespacedName{
 		Namespace: translated.Namespace,
 		Name:      translated.Name,
@@ -61,29 +58,28 @@ func (c *ConfigMapSyncer) Reconcile(ctx context.Context, req reconcile.Request)
 			err = c.HostClient.Create(ctx, translated)
 			// for simplicity's sake, we don't check for conflict errors. The existing object will get
 			// picked up on in the next re-enqueue
-			return reconcile.Result{
-					Requeue: true,
-				}, fmt.Errorf("unable to create host configmap %s/%s for virtual configmap %s/%s: %w",
-					translated.Namespace, translated.Name, req.Namespace, req.Name, err)
+			return reconcile.Result{Requeue: true}, err
 		}
-		return reconcile.Result{Requeue: true}, fmt.Errorf("unable to get host configmap %s/%s: %w", translated.Namespace, translated.Name, err)
+
+		return reconcile.Result{Requeue: true}, err
 	}
 	// we are going to use the host in order to avoid conflicts on update
 	host.Data = translated.Data
 	if host.Labels == nil {
 		host.Labels = make(map[string]string, len(translated.Labels))
 	}
+
 	// we don't want to override labels made on the host cluster by other applications
 	// but we do need to make sure the labels that the kubelet uses to track host cluster values
 	// are being tracked appropriately
 	for key, value := range translated.Labels {
 		host.Labels[key] = value
 	}
+
 	if err = c.HostClient.Update(ctx, &host); err != nil {
 		return reconcile.Result{
-				Requeue: true,
-			}, fmt.Errorf("unable to update host configmap %s/%s for virtual configmap %s/%s: %w",
-				translated.Namespace, translated.Name, req.Namespace, req.Name, err)
+			Requeue: true,
+		}, err
 
 	}
 	return reconcile.Result{}, nil
@@ -92,8 +88,8 @@ func (c *ConfigMapSyncer) Reconcile(ctx context.Context, req reconcile.Request)
 // isWatching is a utility method to determine if a key is in objs without the caller needing
 // to handle mutex lock/unlock.
 func (c *ConfigMapSyncer) isWatching(key types.NamespacedName) bool {
-	c.mutex.RLock()
-	defer c.mutex.RUnlock()
+	c.mu.RLock()
+	defer c.mu.RUnlock()
 	return c.objs.Has(key)
 }
 
@@ -108,19 +104,21 @@ func (c *ConfigMapSyncer) AddResource(ctx context.Context, namespace, name strin
 	if c.isWatching(objKey) {
 		return nil
 	}
+
 	// lock in write mode since we are now adding the key
-	c.mutex.Lock()
+	c.mu.Lock()
 	if c.objs == nil {
 		c.objs = sets.Set[types.NamespacedName]{}
 	}
 	c.objs = c.objs.Insert(objKey)
-	c.mutex.Unlock()
-	_, err := c.Reconcile(ctx, reconcile.Request{
+	c.mu.Unlock()
+
+	if _, err := c.Reconcile(ctx, reconcile.Request{
 		NamespacedName: objKey,
-	})
-	if err != nil {
-		return fmt.Errorf("unable to reconcile new object %s/%s: %w", objKey.Namespace, objKey.Name, err)
+	}); err != nil {
+		return err
 	}
+
 	return nil
 }
 
@@ -141,26 +139,27 @@ func (c *ConfigMapSyncer) RemoveResource(ctx context.Context, namespace, name st
 	}, func() error {
 		return c.removeHostConfigMap(ctx, namespace, name)
 	}); err != nil {
-		return fmt.Errorf("unable to remove configmap: %w", err)
+		return err
 	}
-	c.mutex.Lock()
+	c.mu.Lock()
 	if c.objs == nil {
 		c.objs = sets.Set[types.NamespacedName]{}
 	}
 	c.objs = c.objs.Delete(objKey)
-	c.mutex.Unlock()
+	c.mu.Unlock()
 	return nil
 }
 
 func (c *ConfigMapSyncer) removeHostConfigMap(ctx context.Context, virtualNamespace, virtualName string) error {
 	var vConfigMap corev1.ConfigMap
-	err := c.VirtualClient.Get(ctx, types.NamespacedName{Namespace: virtualNamespace, Name: virtualName}, &vConfigMap)
-	if err != nil {
-		return fmt.Errorf("unable to get virtual configmap %s/%s: %w", virtualNamespace, virtualName, err)
+	if err := c.VirtualClient.Get(ctx, types.NamespacedName{Namespace: virtualNamespace, Name: virtualName}, &vConfigMap); err != nil {
+		return err
 	}
+
 	translated, err := c.TranslateFunc(&vConfigMap)
 	if err != nil {
-		return fmt.Errorf("unable to translate virtual secret: %s/%s: %w", virtualNamespace, virtualName, err)
+		return err
 	}
+
 	return c.HostClient.Delete(ctx, translated)
 }

k3k-kubelet/controller/handler.go

@@ -2,6 +2,7 @@ package controller
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"sync"
 
@@ -55,6 +56,7 @@ func (c *ControllerHandler) AddResource(ctx context.Context, obj client.Object)
 	}
 	// we need to manually lock/unlock since we intned on write locking to add a new controller
 	c.RUnlock()
+
 	var r updateableReconciler
 	switch obj.(type) {
 	case *v1.Secret:
@@ -68,7 +70,7 @@ func (c *ControllerHandler) AddResource(ctx context.Context, obj client.Object)
 				c.Translater.TranslateTo(s)
 				return s, nil
 			},
-			Logger: c.Logger,
+			logger: c.Logger,
 		}
 	case *v1.ConfigMap:
 		r = &ConfigMapSyncer{
@@ -82,17 +84,16 @@ func (c *ControllerHandler) AddResource(ctx context.Context, obj client.Object)
 			Logger: c.Logger,
 		}
 	default:
-		// TODO: Technically, the configmap/secret syncers are relatively generic, and this
-		// logic could be used for other types.
 		return fmt.Errorf("unrecognized type: %T", obj)
 
 	}
-	err := ctrl.NewControllerManagedBy(c.Mgr).
+
+	if err := ctrl.NewControllerManagedBy(c.Mgr).
 		For(&v1.ConfigMap{}).
-		Complete(r)
-	if err != nil {
-		return fmt.Errorf("unable to start configmap controller: %w", err)
+		Complete(r); err != nil {
+		return err
 	}
+
 	c.Lock()
 	if c.controllers == nil {
 		c.controllers = map[schema.GroupVersionKind]updateableReconciler{}
@@ -109,7 +110,8 @@ func (c *ControllerHandler) RemoveResource(ctx context.Context, obj client.Objec
 	ctrl, ok := c.controllers[obj.GetObjectKind().GroupVersionKind()]
 	c.RUnlock()
 	if !ok {
-		return fmt.Errorf("no controller found for gvk" + obj.GetObjectKind().GroupVersionKind().String())
+		return errors.New("no controller found for gvk" + obj.GetObjectKind().GroupVersionKind().String())
 	}
+
 	return ctrl.RemoveResource(ctx, obj.GetNamespace(), obj.GetName())
 }