docs: Update go docs of pkg/controller

Signed-off-by: Eric Zhao <[email protected]>

pkg/controller/crd_cache.go

@@ -27,9 +27,12 @@ type CRDObjectsHolder struct {
 	version int64
 }
 
+// CRDCache caches versioned CRD objects in local.
 type CRDCache struct {
-	kind            string
-	crdEntityMap    map[types.NamespacedName]client.Object
+	kind string
+	// crdEntityMap represents a map: (namespace, name) -> unique CRD
+	crdEntityMap map[types.NamespacedName]client.Object
+	// namespaceAppMap represents a map for CRD group: (namespace, app) -> versionedCRDs
 	namespaceAppMap map[model.NamespacedApp]*CRDObjectsHolder
 
 	updateMux sync.RWMutex

pkg/controller/crd_meta.go

@@ -20,6 +20,8 @@ import (
 )
 
 type CRDKind = string
+
+// CRDGenerator represents a generator function of an OpenSergo CRD.
 type CRDGenerator = func() client.Object
 
 type CRDMetadata struct {

pkg/controller/crd_watcher.go

@@ -36,22 +36,25 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-// CRDWatcher reconciles a specific CRD object.
+// CRDWatcher watches a specific kind of CRD.
 type CRDWatcher struct {
 	kind model.SubscribeKind
 
 	client.Client
 	logger logr.Logger
 	scheme *runtime.Scheme
 
+	// crdCache represents associated local cache for current kind of CRD.
+	crdCache *CRDCache
+
+	// subscribedList consists of all subscribed target of current kind of CRD.
 	subscribedList       map[model.SubscribeTarget]bool
 	subscribedNamespaces map[string]bool
 	subscribedApps       map[string]bool
 
 	crdGenerator    func() client.Object
 	sendDataHandler model.DataEntirePushHandler
 
-	crdCache  *CRDCache
 	updateMux sync.RWMutex
 }