Add comment about caller responsibility

storageos · Jun 14, 2022 · 1a05b8d · 1a05b8d
1 parent 35ead41
commit 1a05b8d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/controllers/etcdcluster_controller.go b/controllers/etcdcluster_controller.go
@@ -1457,6 +1457,8 @@ func (r *EtcdClusterReconciler) defragCronJob(log logr.Logger, cluster *etcdv1al
 	}
 }
 
+// setupDefragDeps gathers the dependencies for running a defrag (etcd client and list of etcd members).
+// The caller is responsible for closing the etcd client when done with the operations.
 func (r *EtcdClusterReconciler) setupDefragDeps(log logr.Logger, cluster *etcdv1alpha1.EtcdCluster) (
 	etcd.API,
 	[]etcd.Member,