Make Config API compliant with OpenShift API standards

Update ConfigSpec and AgentSpec field documentation to follow
OpenShift API conventions (lowercase first letter). Remove redundant
kubebuilder validation tags and make HealthProbePort optional with
a default value of 8175 applied via the controller instead of via the
API.

Signed-off-by: Andreas Karis <[email protected]>

Author: andreaskaris

apis/v1alpha1/config_types.go

@@ -38,44 +38,46 @@ type Config struct {
 	Status ConfigStatus `json:"status,omitempty"`
 }
 
-// Spec defines the desired state of the bpfman-operator.
+// spec defines the desired state of the bpfman-operator.
 type ConfigSpec struct {
-	// Agent holds the configuration for the bpfman agent.
+	// agent holds the configuration for the bpfman agent.
 	// +required
-	Agent AgentSpec `json:"agent,omitempty"`
-	// Configuration holds the content of bpfman.toml.
+	Agent AgentSpec `json:"agent"`
+	// configuration holds the content of bpfman.toml.
 	// +required
-	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:MinLength=1
 	Configuration string `json:"configuration"`
-	// Image holds the image of the bpfman DaemonSets.
+	// image sets the image of the bpfman DaemonSets.
 	// +required
-	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:MinLength=1
 	Image string `json:"image"`
-	// LogLevel holds the log level for the bpfman-operator.
+	// logLevel sets the log level for the bpfman's DaemonSets via the RUST_LOG environment variable.
+	// The RUST_LOG environment variable controls logging with the syntax: RUST_LOG=[target][=][level][,...].
+	// For further information, see https://docs.rs/env_logger/latest/env_logger/.
 	// +optional
 	LogLevel string `json:"logLevel,omitempty"`
-	// Namespace holds the namespace where bpfman-operator resources shall be
-	// deployed.
+	// namespace sets the namespace where bpfman-operator resources shall be
+	// deployed. If not specified, resources will be deployed in the default
+	// bpfman namespace.
+	// +optional
 	Namespace string `json:"namespace,omitempty"`
 }
 
 // AgentSpec defines the desired state of the bpfman agent.
 type AgentSpec struct {
-	// HealthProbePort holds the health probe bind port for the bpfman agent.
+	// healthProbePort configures the health probe bind port for the bpfman agent.
+	// If unspecified, the default port will be used.
 	// +optional
-	// +kubebuilder:default=8175
-	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Minimum=0
 	// +kubebuilder:validation:Maximum=65535
-	HealthProbePort int `json:"healthProbePort"`
-	// Image holds the image for the bpfman agent.
+	HealthProbePort int32 `json:"healthProbePort,omitempty"`
+	// image holds the image for the bpfman agent.
 	// +required
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:MinLength=1
 	Image string `json:"image"`
-	// LogLevel holds the log level for the bpfman agent.
+	// logLevel holds the log level for the bpfman agent.
+	// Valid values are: "", "info", "debug", "trace".
 	// +optional
+	// +kubebuilder:validation:Enum="";info;debug;trace
 	LogLevel string `json:"logLevel,omitempty"`
 }
 
@@ -101,10 +103,14 @@ type ConfigList struct {
 	Items           []Config `json:"items"`
 }
 
+// ConfigComponentStatus holds the status of a single Config component.
 type ConfigComponentStatus string
 
 const (
-	ConfigStatusUnknown     ConfigComponentStatus = "Unknown"
+	// ConfigStatusUnknown indicates the component state cannot be determined.
+	ConfigStatusUnknown ConfigComponentStatus = "Unknown"
+	// ConfigStatusProgressing indicates the component is being updated or reconciled.
 	ConfigStatusProgressing ConfigComponentStatus = "Progressing"
-	ConfigStatusReady       ConfigComponentStatus = "Ready"
+	// ConfigStatusReady indicates the component is fully operational and ready.
+	ConfigStatusReady ConfigComponentStatus = "Ready"
 )

controllers/bpfman-operator/config.go

@@ -614,9 +614,12 @@ func (r *BpfmanConfigReconciler) handleDeletion(ctx context.Context, config *v1a
 	return ctrl.Result{}, nil
 }
 
-func healthProbeAddress(healthProbePort int) string {
-	if healthProbePort <= 0 || healthProbePort > 65535 {
+func healthProbeAddress(healthProbePort int32) string {
+	if healthProbePort < 0 || healthProbePort > 65535 {
 		return ""
 	}
+	if healthProbePort == 0 {
+		healthProbePort = internal.DefaultHealthProbePort
+	}
 	return fmt.Sprintf(":%d", healthProbePort)
 }

internal/constants.go

@@ -48,6 +48,7 @@ const (
 	BpfmanLogLevel                = "bpfman.log.level"
 	BpfmanAgentLogLevel           = "bpfman.agent.log.level"
 	BpfmanAgentHealthProbeAddress = "bpfman.agent.healthprobeaddr"
+	DefaultHealthProbePort        = 8175
 	APIPrefix                     = "bpfman.io"
 )