Lint fixes

Author: dprince

api/core/v1beta1/openstackcontrolplane_webhook.go

@@ -715,6 +715,7 @@ func (r *OpenStackControlPlane) ValidateServiceDependencies(basePath *field.Path
 	return allErrs
 }
 
+// ValidateVersion validates the OpenStackVersion reference in the OpenStackControlPlane
 func (r *OpenStackControlPlane) ValidateVersion(ctx context.Context, c client.Client) (field.ErrorList, error) {
 	var allErrs field.ErrorList
 
@@ -851,7 +852,7 @@ func (r *OpenStackControlPlane) DefaultServices() {
 		// clean up the APIOverrides for each glanceAPI that has been
 		// deleted from the ctlplane
 		apis := maps.Keys(r.Spec.Glance.Template.GlanceAPIs)
-		for k, _ := range r.Spec.Glance.APIOverride {
+		for k := range r.Spec.Glance.APIOverride {
 			if !slices.Contains(apis, k) {
 				delete(r.Spec.Glance.APIOverride, k)
 			}
@@ -1113,6 +1114,7 @@ func validateTLSOverrideSpec(override **route.OverrideSpec, basePath *field.Path
 	return allErrs
 }
 
+// ValidateTopology validates the TopologyRef in the OpenStackControlPlane
 func (r *OpenStackControlPlane) ValidateTopology(basePath *field.Path) *field.Error {
 	// When a TopologyRef CR is referenced, fail if a different Namespace is
 	// referenced because is not supported

api/core/v1beta1/openstackversion_types.go

@@ -213,7 +213,8 @@ type OpenStackVersionStatus struct {
 // +kubebuilder:printcolumn:name="Target Version",type=string,JSONPath=`.spec.targetVersion`
 // +kubebuilder:printcolumn:name="Available Version",type=string,JSONPath=`.status.availableVersion`
 // +kubebuilder:printcolumn:name="Deployed Version",type=string,JSONPath=`.status.deployedVersion`
-// OpenStackVersion is the Schema for the openstackversionupdates API
+
+// OpenStackVersion defines the Schema for the openstackversionupdates API
 type OpenStackVersion struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -223,6 +224,7 @@ type OpenStackVersion struct {
 }
 
 // +kubebuilder:object:root=true
+
 // OpenStackVersionList contains a list of OpenStackVersion
 type OpenStackVersionList struct {
 	metav1.TypeMeta `json:",inline"`
@@ -256,9 +258,8 @@ func getOpenStackReleaseVersion(openstackReleaseVersion string, releaseVersionSc
 		operatorConditionEpoch := re.FindString(operatorConditionName)
 		if operatorConditionEpoch == "" {
 			return openstackReleaseVersion
-		} else {
-			return openstackReleaseVersion + operatorConditionEpoch
 		}
+		return openstackReleaseVersion + operatorConditionEpoch
 	}
 	return openstackReleaseVersion
 }

api/dataplane/v1beta1/openstackdataplanedeployment_webhook.go

@@ -57,6 +57,7 @@ func (spec *OpenStackDataPlaneDeploymentSpec) Default() {
 
 var _ webhook.Validator = &OpenStackDataPlaneDeployment{}
 
+// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
 func (r *OpenStackDataPlaneDeployment) ValidateCreate() (admission.Warnings, error) {
 
 	openstackdataplanedeploymentlog.Info("validate create", "name", r.Name)
@@ -74,12 +75,14 @@ func (r *OpenStackDataPlaneDeployment) ValidateCreate() (admission.Warnings, err
 	return nil, nil
 }
 
-func (r *OpenStackDataPlaneDeploymentSpec) ValidateCreate() field.ErrorList {
+// ValidateCreate validates the OpenStackDataPlaneDeploymentSpec on creation
+func (spec *OpenStackDataPlaneDeploymentSpec) ValidateCreate() field.ErrorList {
 	// TODO(user): fill in your validation logic upon object creation.
 
 	return field.ErrorList{}
 }
 
+// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
 func (r *OpenStackDataPlaneDeployment) ValidateUpdate(original runtime.Object) (admission.Warnings, error) {
 	openstackdataplanedeploymentlog.Info("validate update", "name", r.Name)
 
@@ -97,12 +100,14 @@ func (r *OpenStackDataPlaneDeployment) ValidateUpdate(original runtime.Object) (
 	return nil, nil
 }
 
-func (r *OpenStackDataPlaneDeploymentSpec) ValidateUpdate() field.ErrorList {
+// ValidateUpdate validates the OpenStackDataPlaneDeploymentSpec on update
+func (spec *OpenStackDataPlaneDeploymentSpec) ValidateUpdate() field.ErrorList {
 	// TODO(user): fill in your validation logic upon object update.
 
 	return field.ErrorList{}
 }
 
+// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
 func (r *OpenStackDataPlaneDeployment) ValidateDelete() (admission.Warnings, error) {
 	openstackdataplanedeploymentlog.Info("validate delete", "name", r.Name)
 
@@ -119,7 +124,8 @@ func (r *OpenStackDataPlaneDeployment) ValidateDelete() (admission.Warnings, err
 	return nil, nil
 }
 
-func (r *OpenStackDataPlaneDeploymentSpec) ValidateDelete() field.ErrorList {
+// ValidateDelete validates the OpenStackDataPlaneDeploymentSpec on delete
+func (spec *OpenStackDataPlaneDeploymentSpec) ValidateDelete() field.ErrorList {
 	// TODO(user): fill in your validation logic upon object creation.
 
 	return field.ErrorList{}

api/dataplane/v1beta1/openstackdataplanenodeset_types.go

@@ -315,10 +315,10 @@ func (r *OpenStackDataPlaneNodeSetSpec) duplicateNodeCheck(nodeSetList *OpenStac
 	return
 }
 
-// Compare TLS settings of control plane and data plane
-// if control plane name is specified attempt to retrieve it
+// ValidateTLS compares TLS settings of control plane and data plane.
+// If control plane name is specified attempt to retrieve it,
 // otherwise get any control plane in the namespace
-func (r *OpenStackDataPlaneNodeSetSpec) ValidateTLS(namespace string, reconcilerClient client.Client, ctx context.Context) error {
+func (r *OpenStackDataPlaneNodeSetSpec) ValidateTLS(ctx context.Context, namespace string, reconcilerClient client.Client) error {
 	var err error
 	controlPlanes := openstackv1.OpenStackControlPlaneList{}
 	opts := client.ListOptions{
@@ -342,7 +342,7 @@ func (r *OpenStackDataPlaneNodeSetSpec) ValidateTLS(namespace string, reconciler
 	return err
 }
 
-// Do TLS flags match in control plane ingress, pods and data plane
+// TLSMatch checks if TLS flags match in control plane ingress, pods and data plane
 func (r *OpenStackDataPlaneNodeSetSpec) TLSMatch(controlPlane openstackv1.OpenStackControlPlane) *field.Error {
 
 	if controlPlane.Spec.TLS.PodLevel.Enabled != r.TLSEnabled {

api/dataplane/v1beta1/openstackdataplanenodeset_webhook.go

@@ -178,18 +178,19 @@ func (r *OpenStackDataPlaneNodeSet) ValidateUpdate(ctx context.Context, old runt
 	return nil, nil
 }
 
-func (r *OpenStackDataPlaneNodeSetSpec) ValidateUpdate(oldSpec *OpenStackDataPlaneNodeSetSpec) field.ErrorList {
+// ValidateUpdate validates the OpenStackDataPlaneNodeSetSpec on update
+func (spec *OpenStackDataPlaneNodeSetSpec) ValidateUpdate(oldSpec *OpenStackDataPlaneNodeSetSpec) field.ErrorList {
 
 	var errors field.ErrorList
 	// Some changes to the baremetalSetTemplate after the initial deployment would necessitate
 	// a redeploy of the node. Thus we should block these changes and require the user to
 	// delete and redeploy should they wish to make such changes after the initial deploy.
 	// If the BaremetalSetTemplate is changed, we will offload the parsing of these details
 	// to the openstack-baremetal-operator webhook to avoid duplicating logic.
-	if !reflect.DeepEqual(r.BaremetalSetTemplate, oldSpec.BaremetalSetTemplate) {
+	if !reflect.DeepEqual(spec.BaremetalSetTemplate, oldSpec.BaremetalSetTemplate) {
 		// Call openstack-baremetal-operator webhook Validate() to parse changes
-		if r.BaremetalSetTemplate != nil && oldSpec.BaremetalSetTemplate != nil {
-			err := r.BaremetalSetTemplate.ValidateTemplate(
+		if spec.BaremetalSetTemplate != nil && oldSpec.BaremetalSetTemplate != nil {
+			err := spec.BaremetalSetTemplate.ValidateTemplate(
 				len(oldSpec.Nodes), *oldSpec.BaremetalSetTemplate)
 			if err != nil {
 				errors = append(errors, field.Forbidden(
@@ -219,7 +220,8 @@ func (r *OpenStackDataPlaneNodeSet) ValidateDelete(ctx context.Context, c client
 	return nil, nil
 }
 
-func (r *OpenStackDataPlaneNodeSetSpec) ValidateDelete() field.ErrorList {
+// ValidateDelete validates the OpenStackDataPlaneNodeSetSpec on delete
+func (spec *OpenStackDataPlaneNodeSetSpec) ValidateDelete() field.ErrorList {
 	// TODO(user): fill in your validation logic upon object deletion.
 
 	return field.ErrorList{}

api/dataplane/v1beta1/openstackdataplaneservice_types.go

@@ -130,7 +130,8 @@ type OpenStackDataPlaneServiceStatus struct {
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:shortName=osdps;osdpservice;osdpservices
 // +operator-sdk:csv:customresourcedefinitions:displayName="OpenStack Data Plane Service"
-// OpenStackDataPlaneService is the Schema for the openstackdataplaneservices API
+
+// OpenStackDataPlaneService defines the Schema for the openstackdataplaneservices API.
 // OpenStackDataPlaneService name must be a valid RFC1123 as it is used in labels
 type OpenStackDataPlaneService struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -141,6 +142,7 @@ type OpenStackDataPlaneService struct {
 }
 
 // +kubebuilder:object:root=true
+
 // OpenStackDataPlaneServiceList contains a list of OpenStackDataPlaneService
 type OpenStackDataPlaneServiceList struct {
 	metav1.TypeMeta `json:",inline"`
@@ -152,7 +154,7 @@ func init() {
 	SchemeBuilder.Register(&OpenStackDataPlaneService{}, &OpenStackDataPlaneServiceList{})
 }
 
-// DefaultLabel - adding default label to the OpenStackDataPlaneService
+// DefaultLabels adds default labels to the OpenStackDataPlaneService
 func (r *OpenStackDataPlaneService) DefaultLabels() {
 	labels := map[string]string{
 		"app.kubernetes.io/name":     "openstackdataplaneservice",

api/dataplane/v1beta1/openstackdataplaneservice_webhook.go

@@ -60,6 +60,7 @@ func (spec *OpenStackDataPlaneServiceSpec) Default(name string) {
 
 var _ webhook.Validator = &OpenStackDataPlaneService{}
 
+// ValidateCreate implements webhook.Validator so a webhook will be registered for the type
 func (r *OpenStackDataPlaneService) ValidateCreate() (admission.Warnings, error) {
 
 	openstackdataplaneservicelog.Info("validate create", "name", r.Name)
@@ -78,31 +79,34 @@ func (r *OpenStackDataPlaneService) ValidateCreate() (admission.Warnings, error)
 	return nil, nil
 }
 
-func (r *OpenStackDataPlaneServiceSpec) ValidateArtifact() field.ErrorList {
-	if len(r.Playbook) == len(r.PlaybookContents) && len(r.Playbook) == len(r.Role) && len(r.Playbook) == 0 {
+// ValidateArtifact validates that at least one of Playbook, PlaybookContents, or Role is specified
+func (spec *OpenStackDataPlaneServiceSpec) ValidateArtifact() field.ErrorList {
+	if len(spec.Playbook) == len(spec.PlaybookContents) && len(spec.Playbook) == len(spec.Role) && len(spec.Playbook) == 0 {
 		return field.ErrorList{
 			field.Invalid(
 				field.NewPath("Playbook"),
-				r.Playbook, "Playbook, PlaybookContents and Role cannot be empty at the same time",
+				spec.Playbook, "Playbook, PlaybookContents and Role cannot be empty at the same time",
 			),
 			field.Invalid(
 				field.NewPath("PlaybookContents"),
-				r.Playbook, "Playbook, PlaybookContents and Role cannot be empty at the same time",
+				spec.Playbook, "Playbook, PlaybookContents and Role cannot be empty at the same time",
 			),
 			field.Invalid(
 				field.NewPath("Role"),
-				r.Playbook, "Playbook, PlaybookContents and Role cannot be empty at the same time",
+				spec.Playbook, "Playbook, PlaybookContents and Role cannot be empty at the same time",
 			),
 		}
 	}
 
 	return field.ErrorList{}
 }
 
-func (r *OpenStackDataPlaneServiceSpec) ValidateCreate() field.ErrorList {
-	return r.ValidateArtifact()
+// ValidateCreate validates the OpenStackDataPlaneServiceSpec on creation
+func (spec *OpenStackDataPlaneServiceSpec) ValidateCreate() field.ErrorList {
+	return spec.ValidateArtifact()
 }
 
+// ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
 func (r *OpenStackDataPlaneService) ValidateUpdate(original runtime.Object) (admission.Warnings, error) {
 	openstackdataplaneservicelog.Info("validate update", "name", r.Name)
 	errors := r.Spec.ValidateUpdate()
@@ -118,10 +122,12 @@ func (r *OpenStackDataPlaneService) ValidateUpdate(original runtime.Object) (adm
 	return nil, nil
 }
 
-func (r *OpenStackDataPlaneServiceSpec) ValidateUpdate() field.ErrorList {
-	return r.ValidateArtifact()
+// ValidateUpdate validates the OpenStackDataPlaneServiceSpec on update
+func (spec *OpenStackDataPlaneServiceSpec) ValidateUpdate() field.ErrorList {
+	return spec.ValidateArtifact()
 }
 
+// ValidateDelete implements webhook.Validator so a webhook will be registered for the type
 func (r *OpenStackDataPlaneService) ValidateDelete() (admission.Warnings, error) {
 	openstackdataplaneservicelog.Info("validate delete", "name", r.Name)
 
@@ -138,7 +144,8 @@ func (r *OpenStackDataPlaneService) ValidateDelete() (admission.Warnings, error)
 	return nil, nil
 }
 
-func (r *OpenStackDataPlaneServiceSpec) ValidateDelete() field.ErrorList {
+// ValidateDelete validates the OpenStackDataPlaneServiceSpec on delete
+func (spec *OpenStackDataPlaneServiceSpec) ValidateDelete() field.ErrorList {
 	// TODO(user): fill in your validation logic upon object creation.
 
 	return field.ErrorList{}

api/operator/v1beta1/openstack_types.go

@@ -24,6 +24,7 @@ import (
 	"k8s.io/utils/ptr"
 )
 
+// Operator names for OpenStack components
 const (
 	OpenStackOperatorName          = "openstack"
 	BarbicanOperatorName           = "barbican"
@@ -270,7 +271,8 @@ type OpenStackStatus struct {
 // +operator-sdk:csv:customresourcedefinitions:displayName="OpenStack"
 // +kubebuilder:printcolumn:name="Deployed Operator Count",type=integer,JSONPath=`.status.deployedOperatorCount`
 // +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[0].status",description="Status"
-// OpenStack is the Schema for the openstacks API
+
+// OpenStack defines the Schema for the openstacks API
 type OpenStack struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

bindata/operator/managers.yaml

@@ -11,7 +11,7 @@ spec:
   replicas: {{ .Deployment.Replicas }}
   selector:
     matchLabels:
-      app.kubernetes.io/name: {{ .Name }}
+      app.kubernetes.io/name: {{ .Name }}-operator
   template:
     metadata:
       annotations:

cmd/main.go

@@ -41,7 +41,6 @@ import (
 	clientcontroller "github.com/openstack-k8s-operators/openstack-operator/internal/controller/client"
 	corecontroller "github.com/openstack-k8s-operators/openstack-operator/internal/controller/core"
 	dataplanecontroller "github.com/openstack-k8s-operators/openstack-operator/internal/controller/dataplane"
-	operatorcontroller "github.com/openstack-k8s-operators/openstack-operator/internal/controller/operator"
 	webhookcorev1beta1 "github.com/openstack-k8s-operators/openstack-operator/internal/webhook/core/v1beta1"
 	webhookdataplanev1beta1 "github.com/openstack-k8s-operators/openstack-operator/internal/webhook/dataplane/v1beta1"
 
@@ -355,14 +354,6 @@ func main() {
 		setupLog.Error(err, "unable to create controller", "controller", "OpenStackDataPlaneDeployment")
 		os.Exit(1)
 	}
-	if err := (&operatorcontroller.OpenStackReconciler{
-		Client:  mgr.GetClient(),
-		Scheme:  mgr.GetScheme(),
-		Kclient: kclient,
-	}).SetupWithManager(mgr); err != nil {
-		setupLog.Error(err, "unable to create controller", "controller", "OpenStack")
-		os.Exit(1)
-	}
 
 	corecontroller.SetupVersionDefaults()