Add docs

Author: fabianvf

pkg/cache/cache.go

@@ -109,8 +109,8 @@ type Options struct {
 	// So that all informers will not send list requests simultaneously.
 	Resync *time.Duration
 
-	// KeyFunction is the cache.KeyFunc that the informers will be configured to use.
-	// Defaults to cache.MetaNamespaceKeyFunc from client-go
+	// NewInformerFunc is a function that is used to create SharedIndexInformers.
+	// Defaults to cache.NewSharedIndexInformer from client-go
 	NewInformerFunc client.NewInformerFunc
 
 	// Indexers is the indexers that the informers will be configured to use.

pkg/cache/internal/cache_reader.go

@@ -36,6 +36,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
+// TODO(KCP) need to implement and plumb through our own cache reader
+
 // CacheReader is a client.Reader.
 var _ client.Reader = &CacheReader{}
 

pkg/client/interfaces.go

@@ -44,6 +44,8 @@ type Patch interface {
 	Data(obj Object) ([]byte, error)
 }
 
+// NewInformerFunc describes a function that creates SharedIndexInformers.
+// Its signature matches cache.NewSharedIndexInformer from client-go
 type NewInformerFunc func(cache.ListerWatcher, runtime.Object, time.Duration, cache.Indexers) cache.SharedIndexInformer
 
 // TODO(directxman12): is there a sane way to deal with get/delete options?

pkg/handler/enqueue.go

@@ -77,6 +77,7 @@ func (e *EnqueueRequestForObject) Generic(evt event.GenericEvent, q workqueue.Ra
 
 func request(obj client.Object) reconcile.Request {
 	return reconcile.Request{
+		// TODO(kcp) Need to implement a non-kcp-specific way to support this
 		ClusterName: logicalcluster.From(obj).String(),
 		ObjectKey: client.ObjectKey{
 			Namespace: obj.GetNamespace(),

pkg/reconcile/reconcile.go

@@ -48,6 +48,8 @@ type Request struct {
 	// ObjectKey is the name, namespace, and cluster of the object to reconcile.
 	client.ObjectKey
 
+	// ClusterName can be used for reconciling requests across multiple clusters,
+	// to prevent objects with the same name and namespace from conflicting
 	ClusterName string
 }