Comment all exported functions

Author: J12934

operator/controllers/execution/scan_controller.go

@@ -179,7 +179,7 @@ func (r *ScanReconciler) startScan(scan *executionv1.Scan) error {
 			Verbs:     []string{"get"},
 		},
 	}
-	r.EnsureServiceAccountExists(
+	r.ensureServiceAccountExists(
 		scan.Namespace,
 		"lurcher",
 		"Lurcher is used to extract results from secureCodeBox Scans. It needs rights to get and watch the status of pods to see when the scans have finished.",
@@ -277,7 +277,7 @@ func (r *ScanReconciler) startParser(scan *executionv1.Scan) error {
 			Verbs:     []string{"get", "patch"},
 		},
 	}
-	r.EnsureServiceAccountExists(
+	r.ensureServiceAccountExists(
 		scan.Namespace,
 		"parser",
 		"Parser need to access the status of Scans to update how many findings have been identified",
@@ -533,7 +533,7 @@ func (r *ScanReconciler) startPersistenceProvider(scan *executionv1.Scan) error
 			Verbs:     []string{"get"},
 		},
 	}
-	r.EnsureServiceAccountExists(
+	r.ensureServiceAccountExists(
 		scan.Namespace,
 		"persistence",
 		"PersistenceProvider need to access the current scan to view where its results are stored",
@@ -659,7 +659,7 @@ func (r *ScanReconciler) checkIfPersistingIsCompleted(scan *executionv1.Scan) er
 	return nil
 }
 
-func (r *ScanReconciler) EnsureServiceAccountExists(namespace, serviceAccountName, description string, policyRules []rbacv1.PolicyRule) error {
+func (r *ScanReconciler) ensureServiceAccountExists(namespace, serviceAccountName, description string, policyRules []rbacv1.PolicyRule) error {
 	ctx := context.Background()
 
 	var serviceAccount corev1.ServiceAccount
@@ -746,6 +746,7 @@ func (r *ScanReconciler) EnsureServiceAccountExists(namespace, serviceAccountNam
 	return nil
 }
 
+// SetupWithManager sets up the controller and initializes every thing it needs
 func (r *ScanReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	endpoint := os.Getenv("S3_ENDPOINT")
 	accessKeyID := os.Getenv("S3_ACCESS_KEY")

operator/controllers/execution/scheduledscan_controller.go

@@ -40,6 +40,7 @@ type ScheduledScanReconciler struct {
 // +kubebuilder:rbac:groups=execution.experimental.securecodebox.io,resources=scheduledscans,verbs=get;list;watch;create;update;patch;delete
 // +kubebuilder:rbac:groups=execution.experimental.securecodebox.io,resources=scheduledscans/status,verbs=get;update;patch
 
+// Reconcile comapares the ScheduledScan Resource with the State of the Cluster and updates both accordingly
 func (r *ScheduledScanReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 	ctx := context.Background()
 	log := r.Log.WithValues("scheduledscan", req.NamespacedName)
@@ -106,6 +107,7 @@ func (r *ScheduledScanReconciler) Reconcile(req ctrl.Request) (ctrl.Result, erro
 	return ctrl.Result{RequeueAfter: nextSchedule.Sub(time.Now())}, nil
 }
 
+// SetupWithManager sets up the controller and initializes every thing it needs
 func (r *ScheduledScanReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	if err := mgr.GetFieldIndexer().IndexField(&executionv1.Scan{}, ownerKey, func(rawObj runtime.Object) []string {
 		// grab the job object, extract the owner...