chore: cleanup irrelevant comments (#1756)

This PR is a general housekeeping, removing some auto-generated comments with trivial or non-up-to-date info, that does not give any value to our code base.
odigos-io · Nov 15, 2024 · dc16c6f · dc16c6f
1 parent 9d99599
commit dc16c6f
Show file tree

Hide file tree

Showing 13 changed files with 0 additions and 73 deletions.
diff --git a/autoscaler/controllers/collectorsgroup_controller.go b/autoscaler/controllers/collectorsgroup_controller.go
@@ -32,7 +32,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-// CollectorsGroupReconciler reconciles a CollectorsGroup object
 type CollectorsGroupReconciler struct {
 	client.Client
 	Scheme               *runtime.Scheme
@@ -42,24 +41,6 @@ type CollectorsGroupReconciler struct {
 	Config               *controllerconfig.ControllerConfig
 }
 
-//+kubebuilder:rbac:groups=odigos.io,namespace=odigos-system,resources=collectorsgroups,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=odigos.io,namespace=odigos-system,resources=collectorsgroups/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=odigos.io,namespace=odigos-system,resources=collectorsgroups/finalizers,verbs=update
-//+kubebuilder:rbac:groups=apps,namespace=odigos-system,resources=deployments,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=apps,namespace=odigos-system,resources=deployments/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=apps,namespace=odigos-system,resources=daemonsets,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=apps,namespace=odigos-system,resources=daemonsets/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups="",namespace=odigos-system,resources=services,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups="",namespace=odigos-system,resources=configmaps,verbs=get;list;watch;create;update;patch;delete
-
-// Reconcile is part of the main kubernetes reconciliation loop which aims to
-// move the current state of the cluster closer to the desired state.
-// the CollectorsGroup object against the actual cluster state, and then
-// perform operations to make the cluster state reflect the state specified by
-// the user.
-//
-// For more details, check Reconcile and its Result here:
-// - https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/reconcile
 func (r *CollectorsGroupReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	logger := log.FromContext(ctx)
 	logger.V(0).Info("Reconciling CollectorsGroup")
@@ -77,7 +58,6 @@ func (r *CollectorsGroupReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 	return ctrl.Result{}, nil
 }
 
-// SetupWithManager sets up the controller with the Manager.
 func (r *CollectorsGroupReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&odigosv1.CollectorsGroup{}).

diff --git a/autoscaler/controllers/datacollectiondaemonset_controller.go b/autoscaler/controllers/datacollectiondaemonset_controller.go
@@ -56,7 +56,6 @@ func calcDataCollectionReadyStatus(ds *appsv1.DaemonSet) bool {
 	return ds.Status.DesiredNumberScheduled > 0 && float64(ds.Status.NumberReady) >= float64(ds.Status.DesiredNumberScheduled)/float64(2)
 }
 
-// SetupWithManager sets up the controller with the Manager.
 func (r *DataCollectionDaemonSetReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&appsv1.DaemonSet{}).

diff --git a/autoscaler/controllers/destination_controller.go b/autoscaler/controllers/destination_controller.go
@@ -29,7 +29,6 @@ import (
 	v1 "github.com/odigos-io/odigos/api/odigos/v1alpha1"
 )
 
-// DestinationReconciler reconciles a Destination object
 type DestinationReconciler struct {
 	client.Client
 	Scheme           *runtime.Scheme
@@ -38,18 +37,6 @@ type DestinationReconciler struct {
 	Config           *controllerconfig.ControllerConfig
 }
 
-//+kubebuilder:rbac:groups=odigos.io,namespace=odigos-system,resources=destinations,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=odigos.io,namespace=odigos-system,resources=destinations/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=odigos.io,namespace=odigos-system,resources=destinations/finalizers,verbs=update
-
-// Reconcile is part of the main kubernetes reconciliation loop which aims to
-// move the current state of the cluster closer to the desired state.
-// the Destination object against the actual cluster state, and then
-// perform operations to make the cluster state reflect the state specified by
-// the user.
-//
-// For more details, check Reconcile and its Result here:
-// - https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/reconcile
 func (r *DestinationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	logger := log.FromContext(ctx)
 	logger.V(0).Info("Reconciling Destination")

diff --git a/autoscaler/controllers/gatewaydeployment_controller.go b/autoscaler/controllers/gatewaydeployment_controller.go
@@ -50,7 +50,6 @@ func (r *GatewayDeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Re
 	return ctrl.Result{}, nil
 }
 
-// SetupWithManager sets up the controller with the Manager.
 func (r *GatewayDeploymentReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&appsv1.Deployment{}).

diff --git a/autoscaler/controllers/instrumentedapplication_controller.go b/autoscaler/controllers/instrumentedapplication_controller.go
@@ -27,7 +27,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-// InstrumentedApplicationReconciler reconciles a InstrumentedApplication object
 type InstrumentedApplicationReconciler struct {
 	client.Client
 	Scheme               *runtime.Scheme
@@ -36,18 +35,6 @@ type InstrumentedApplicationReconciler struct {
 	DisableNameProcessor bool
 }
 
-//+kubebuilder:rbac:groups=odigos.io,resources=instrumentedapplications,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=odigos.io,resources=instrumentedapplications/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=odigos.io,resources=instrumentedapplications/finalizers,verbs=update
-
-// Reconcile is part of the main kubernetes reconciliation loop which aims to
-// move the current state of the cluster closer to the desired state.
-// the InstrumentedApplication object against the actual cluster state, and then
-// perform operations to make the cluster state reflect the state specified by
-// the user.
-//
-// For more details, check Reconcile and its Result here:
-// - https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/reconcile
 func (r *InstrumentedApplicationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	logger := log.FromContext(ctx)
 	logger.V(0).Info("Reconciling InstrumentedApps")
@@ -59,7 +46,6 @@ func (r *InstrumentedApplicationReconciler) Reconcile(ctx context.Context, req c
 	return ctrl.Result{}, nil
 }
 
-// SetupWithManager sets up the controller with the Manager.
 func (r *InstrumentedApplicationReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&odigosv1.InstrumentedApplication{}).

diff --git a/autoscaler/controllers/odigosconfig_controller.go b/autoscaler/controllers/odigosconfig_controller.go
@@ -35,7 +35,6 @@ func (r *OdigosConfigReconciler) Reconcile(ctx context.Context, req ctrl.Request
 	return ctrl.Result{}, nil
 }
 
-// SetupWithManager sets up the controller with the Manager.
 func (r *OdigosConfigReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&v1.ConfigMap{}).

diff --git a/instrumentor/controllers/deleteinstrumentedapplication/daemonset_controller.go b/instrumentor/controllers/deleteinstrumentedapplication/daemonset_controller.go
@@ -28,16 +28,11 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-// DaemonSetReconciler reconciles a DaemonSet object
 type DaemonSetReconciler struct {
 	client.Client
 	Scheme *runtime.Scheme
 }
 
-//+kubebuilder:rbac:groups=apps,resources=daemonsets,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=apps,resources=daemonsets/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=apps,resources=daemonsets/finalizers,verbs=update
-
 func (r *DaemonSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	logger := log.FromContext(ctx)
 

diff --git a/instrumentor/controllers/deleteinstrumentedapplication/deployment_controller.go b/instrumentor/controllers/deleteinstrumentedapplication/deployment_controller.go
@@ -27,16 +27,11 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-// DeploymentReconciler reconciles a Deployment object
 type DeploymentReconciler struct {
 	client.Client
 	Scheme *runtime.Scheme
 }
 
-//+kubebuilder:rbac:groups=apps,resources=deployments,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=apps,resources=deployments/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=apps,resources=deployments/finalizers,verbs=update
-
 func (r *DeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	logger := log.FromContext(ctx)
 

diff --git a/instrumentor/controllers/deleteinstrumentedapplication/instrumentedapplication_controller.go b/instrumentor/controllers/deleteinstrumentedapplication/instrumentedapplication_controller.go
@@ -57,7 +57,6 @@ func getObjectByOwnerReference(ctx context.Context, k8sClient client.Client, own
 	return nil, fmt.Errorf("unsupported owner kind %s", ownerRef.Kind)
 }
 
-// DeploymentReconciler reconciles a Deployment object
 type InstrumentedApplicationReconciler struct {
 	client.Client
 	Scheme *runtime.Scheme

diff --git a/instrumentor/controllers/deleteinstrumentedapplication/namespace_controller.go b/instrumentor/controllers/deleteinstrumentedapplication/namespace_controller.go
@@ -68,7 +68,6 @@ func (i *NsLabelBecameDisabledPredicate) Generic(e event.GenericEvent) bool {
 	return false
 }
 
-// NamespaceReconciler reconciles a Namespace object
 type NamespaceReconciler struct {
 	client.Client
 	Scheme *runtime.Scheme

diff --git a/instrumentor/controllers/deleteinstrumentedapplication/statefulset_controller.go b/instrumentor/controllers/deleteinstrumentedapplication/statefulset_controller.go
@@ -28,16 +28,11 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-// StatefulSetReconciler reconciles a StatefulSet object
 type StatefulSetReconciler struct {
 	client.Client
 	Scheme *runtime.Scheme
 }
 
-//+kubebuilder:rbac:groups=apps,resources=statefulsets,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=apps,resources=statefulsets/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=apps,resources=statefulsets/finalizers,verbs=update
-
 func (r *StatefulSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	logger := log.FromContext(ctx)
 

diff --git a/instrumentor/controllers/instrumentationdevice/instrumentedapplication_controller.go b/instrumentor/controllers/instrumentationdevice/instrumentedapplication_controller.go
@@ -29,7 +29,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-// InstrumentedApplicationReconciler reconciles a InstrumentedApplication object
 type InstrumentedApplicationReconciler struct {
 	client.Client
 	Scheme *runtime.Scheme

diff --git a/scheduler/controllers/destination_controller.go b/scheduler/controllers/destination_controller.go
@@ -31,15 +31,11 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-// DestinationReconciler reconciles a Destination object
 type DestinationReconciler struct {
 	client.Client
 	Scheme *runtime.Scheme
 }
 
-// +kubebuilder:rbac:groups=odigos.io,resources=destinations,verbs=get;list;watch;create;update;patch;delete
-// +kubebuilder:rbac:groups=odigos.io,resources=destinations/status,verbs=get;update;patch
-// +kubebuilder:rbac:groups=odigos.io,resources=destinations/finalizers,verbs=update
 func (r *DestinationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	logger := log.FromContext(ctx)
 
@@ -64,7 +60,6 @@ func (r *DestinationReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 	return ctrl.Result{}, nil
 }
 
-// SetupWithManager sets up the controller with the Manager.
 func (r *DestinationReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&odigosv1.Destination{}).