SynaXG plugin dev scheme review

Author: einsteinXue

Dockerfile.SynaXGVSP.rhel

@@ -0,0 +1,30 @@
+FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.24-openshift-4.21 AS builder
+ARG TARGETOS
+ARG TARGETARCH
+
+WORKDIR /workspace
+COPY . .
+
+# Due to https://github.com/golang/go/issues/70329 cross-compilation hangs at times.
+# As a temporary workaround, we can try specifying GOMAXPROCS=2 to relieve this issue
+RUN mkdir -p /bin && \
+    GOMAXPROCS=2 CGO_ENABLED=1 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} make build-synaxg-vsp
+
+FROM registry.ci.openshift.org/ocp/4.21:base-rhel9
+ARG TARGETARCH
+COPY --from=builder /workspace/bin/vsp-synaxg.${TARGETARCH} /vsp-synaxg
+
+RUN yum update -y \
+    && yum install -y \
+       ethtool \
+       net-tools \
+       kmod \
+       pciutils \
+       iputils \
+       iproute \
+    && yum clean all \
+    && rm -rf /var/cache/dnf
+
+USER 0
+
+ENTRYPOINT ["/vsp-synaxg"]

Makefile

@@ -152,7 +152,7 @@ fast-test:
 
 
 .PHONY: build
-build: manifests generate fmt vet build-manager build-daemon build-intel-vsp build-marvell-vsp build-intel-netsec-vsp build-network-resources-injector
+build: manifests generate fmt vet build-manager build-daemon build-intel-vsp build-marvell-vsp build-intel-netsec-vsp build-synaxg-vsp build-network-resources-injector
 	@echo "Built all components"
 
 .PHONY: build-manager
@@ -175,6 +175,10 @@ build-marvell-vsp:
 build-intel-netsec-vsp:
 	go run tools/task/task.go build-bin-intel-netsec-vsp
 
+.PHONY: build-synaxg-vsp
+build-synaxg-vsp:
+	go run tools/task/task.go build-bin-synaxg-vsp
+
 .PHONY: build-network-resources-injector
 build-network-resources-injector:
 	go run tools/task/task.go build-bin-network-resources-injector

api/v1/dataprocessingunitconfig_types.go

@@ -23,24 +23,185 @@ import (
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
+// ========== DPU operation types ==========
+
+type DpuOperationType string
+
+const (
+	// DpuOpNone No operation (default)
+	DpuOpNone DpuOperationType = "None"
+	// DpuOpFirmwareUpgrade Firmware upgrade operation
+	DpuOpFirmwareUpgrade DpuOperationType = "FirmwareUpgrade"
+	// DpuOpReboot DPU reboot operation (mandatory after firmware upgrade)
+	DpuOpReboot DpuOperationType = "Reboot"
+)
+
+// ========== Firmware types ==========
+
+type DpuFirmwareType string
+
+const (
+	// DpuFirmwareTypeOAM OAM type firmware
+	DpuFirmwareTypeOAM DpuFirmwareType = "OAM"
+	// DpuFirmwareTypeSDK SDK type firmware
+	DpuFirmwareTypeSDK DpuFirmwareType = "SDK"
+)
+
+// ========== Operation status phases ==========
+
+type DpuOperationStatusPhase string
+
+const (
+	// DpuPhasePending Operation pending execution (default)
+	DpuPhasePending DpuOperationStatusPhase = "Pending"
+	// DpuPhaseRunning Operation is in progress
+	DpuPhaseRunning DpuOperationStatusPhase = "Running"
+	// DpuPhaseRebooting DPU is rebooting (waiting for it to come back online)
+	DpuPhaseRebooting DpuOperationStatusPhase = "Rebooting"
+	// DpuPhaseSucceeded Operation completed successfully
+	DpuPhaseSucceeded DpuOperationStatusPhase = "Succeeded"
+	// DpuPhaseFailed Operation execution failed
+	DpuPhaseFailed DpuOperationStatusPhase = "Failed"
+	// DpuPhaseCancelled Operation was cancelled
+	DpuPhaseCancelled DpuOperationStatusPhase = "Cancelled"
+)
+
+// ========== Health status ==========
+
+type DpuHealthStatus string
+
+const (
+	// HealthStatusHealthy DPU is healthy and responding
+	HealthStatusHealthy DpuHealthStatus = "Healthy"
+	// HealthStatusUnhealthy DPU is not responding
+	HealthStatusUnhealthy DpuHealthStatus = "Unhealthy"
+	// HealthStatusUnknown DPU health is unknown
+	HealthStatusUnknown DpuHealthStatus = "Unknown"
+)
+
+// ========== Firmware specification ==========
+
+// DpuFirmwareSpec defines the firmware upgrade parameters.
+type DpuFirmwareSpec struct {
+	// Firmware type (OAM/SDK)
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Enum=OAM;SDK
+	Type DpuFirmwareType `json:"type"`
+
+	// Target firmware version number
+	// +kubebuilder:validation:Required
+	TargetVersion string `json:"targetVersion"`
+
+	// Firmware image path or URI (e.g. quay.io/openshift/firmware/dpu:v1.0.8)
+	// +optional
+	FirmwarePath string `json:"firmwarePath,omitempty"`
+}
+
+// ========== DPU management (spec) ==========
+
+// DataProcessingUnitManagement defines the desired management operation on a DPU.
+type DataProcessingUnitManagement struct {
+	// DPU operation type to execute: None, FirmwareUpgrade, or Reboot.
+	// +kubebuilder:validation:Enum=None;FirmwareUpgrade;Reboot
+	// +kubebuilder:default=None
+	Operation DpuOperationType `json:"operation,omitempty"`
+
+	// Detailed configuration for firmware upgrade.
+	// Required when Operation is FirmwareUpgrade.
+	// +optional
+	Firmware *DpuFirmwareSpec `json:"firmware,omitempty"`
+}
+
+// ========== Spec ==========
+
 // DataProcessingUnitConfigSpec defines the desired state of DataProcessingUnitConfig.
 type DataProcessingUnitConfigSpec struct {
-	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
-
-	// DpuSelector specifies which DPUs this DpuConfig CR should target.
-	// If empty, the DpuConfig will target all DPUs.
+	// DpuSelector specifies which DPUs this config should target.
+	// Must include a pci-address label to uniquely identify the DPU on
+	// nodes that have more than one DPU of the same vendor.
 	// +optional
 	DpuSelector *metav1.LabelSelector `json:"dpuSelector,omitempty"`
 
-	// Foo is an example field of DataProcessingUnitConfig. Edit dataprocessingunitconfig_types.go to remove/update
-	Foo string `json:"foo,omitempty"`
+	// DpuManagement specifies the management operation to perform.
+	DpuManagement DataProcessingUnitManagement `json:"dpuManagement,omitempty"`
 }
 
+// ========== Status ==========
+
+// DpuNodeOperationStatus tracks the status of the current management operation.
+type DpuNodeOperationStatus struct {
+	// SubOperation type: distinguishes FirmwareUpgrade from Reboot.
+	SubOperation DpuOperationType `json:"subOperation,omitempty"`
+
+	// FirmwareType (valid only when SubOperation is FirmwareUpgrade): OAM/SDK
+	FirmwareType DpuFirmwareType `json:"firmwareType,omitempty"`
+
+	// Phase is the current status of the operation: Pending/Running/Succeeded/Failed.
+	Phase DpuOperationStatusPhase `json:"phase,omitempty"`
+
+	// StartTime is when the operation started.
+	// +optional
+	StartTime *metav1.Time `json:"startTime,omitempty"`
+
+	// CompletionTime is when the operation completed (success or failure).
+	// +optional
+	CompletionTime *metav1.Time `json:"completionTime,omitempty"`
+
+	// PreviousVersion is the firmware version before upgrade.
+	// +optional
+	PreviousVersion string `json:"previousVersion,omitempty"`
+
+	// TargetVersion is the desired firmware version for upgrade.
+	// +optional
+	TargetVersion string `json:"targetVersion,omitempty"`
+
+	// Message is a human-readable summary of the operation result.
+	// +optional
+	Message string `json:"message,omitempty"`
+
+	// ErrorMessage contains error details when the operation fails.
+	// +optional
+	ErrorMessage string `json:"errorMessage,omitempty"`
+}
+
+// DpuHealthInfo tracks the health / liveness of the DPU.
+type DpuHealthInfo struct {
+	// Status is the current health of the DPU: Healthy/Unhealthy/Unknown.
+	Status DpuHealthStatus `json:"status,omitempty"`
+
+	// Message is a human-readable health description.
+	// +optional
+	Message string `json:"message,omitempty"`
+
+	// LastProbeTime is the last time the health was checked.
+	// +optional
+	LastProbeTime *metav1.Time `json:"lastProbeTime,omitempty"`
+}
+
+// ConditionTypeReady is the standard K8s condition used for kubectl-wait support.
+//
+//	kubectl wait dpuconfig/<name> --for=condition=Ready --timeout=600s
+//
+// Condition values:
+//   - True:    phase=Succeeded and DPU is healthy
+//   - False:   phase=Failed or DPU is unreachable
+//   - Unknown: operation in progress (Rebooting/Running)
+const ConditionTypeReady = "Ready"
+
 // DataProcessingUnitConfigStatus defines the observed state of DataProcessingUnitConfig.
 type DataProcessingUnitConfigStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
+	// NodeStatus tracks the current management-operation status.
+	NodeStatus DpuNodeOperationStatus `json:"nodeStatus,omitempty"`
+
+	// Health tracks the DPU liveness information.
+	Health DpuHealthInfo `json:"health,omitempty"`
+
+	// Conditions holds standard Kubernetes status conditions.
+	// The "Ready" condition supports `kubectl wait --for=condition=Ready`.
+	// +optional
+	// +listType=map
+	// +listMapKey=type
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true

api/v1/dataprocessingunitconfig_webhook.go

@@ -0,0 +1,72 @@
+/*
+Copyright 2024.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	"context"
+	"fmt"
+
+	"k8s.io/apimachinery/pkg/runtime"
+	ctrl "sigs.k8s.io/controller-runtime"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/webhook"
+	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
+)
+
+var dpuconfiglog = logf.Log.WithName("dataprocessingunitconfig-resource")
+
+// SetupWebhookWithManager registers the validating webhook for DataProcessingUnitConfig.
+// Vendor-specific defaults (e.g. default firmware image) and allowlist enforcement are
+// handled inside each VSP process, which is the only component that knows the vendor.
+func (r *DataProcessingUnitConfig) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	return ctrl.NewWebhookManagedBy(mgr).
+		For(r).
+		WithValidator(r).
+		Complete()
+}
+
+// +kubebuilder:webhook:path=/validate-config-openshift-io-v1-dataprocessingunitconfig,mutating=false,failurePolicy=fail,sideEffects=None,groups=config.openshift.io,resources=dataprocessingunitconfigs,verbs=create;update,versions=v1,name=vdataprocessingunitconfig.kb.io,admissionReviewVersions=v1
+
+var _ webhook.CustomValidator = &DataProcessingUnitConfig{}
+
+// validateDataProcessingUnitConfig performs vendor-neutral structural validation.
+func validateDataProcessingUnitConfig(cfg *DataProcessingUnitConfig) (admission.Warnings, error) {
+	if cfg.Spec.DpuManagement.Operation == DpuOpFirmwareUpgrade &&
+		cfg.Spec.DpuManagement.Firmware == nil {
+		return nil, fmt.Errorf("spec.dpuManagement.firmware is required when operation is FirmwareUpgrade")
+	}
+	return nil, nil
+}
+
+// ValidateCreate validates a new DataProcessingUnitConfig on creation.
+func (r *DataProcessingUnitConfig) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
+	cfg := obj.(*DataProcessingUnitConfig)
+	dpuconfiglog.Info("validate create", "name", cfg.Name)
+	return validateDataProcessingUnitConfig(cfg)
+}
+
+// ValidateUpdate validates changes to an existing DataProcessingUnitConfig.
+func (r *DataProcessingUnitConfig) ValidateUpdate(ctx context.Context, oldObj runtime.Object, newObj runtime.Object) (admission.Warnings, error) {
+	cfg := newObj.(*DataProcessingUnitConfig)
+	dpuconfiglog.Info("validate update", "name", cfg.Name)
+	return validateDataProcessingUnitConfig(cfg)
+}
+
+// ValidateDelete allows deletion without restriction.
+func (r *DataProcessingUnitConfig) ValidateDelete(ctx context.Context, obj runtime.Object) (admission.Warnings, error) {
+	return nil, nil
+}

api/v1/zz_generated.deepcopy.go

@@ -138,14 +138,20 @@ func main() {
 			setupLog.Error(err, "unable to create webhook", "webhook", "DpuOperatorConfig")
 			os.Exit(1)
 		}
+		if err = (&configv1.DataProcessingUnitConfig{}).SetupWebhookWithManager(mgr); err != nil {
+			setupLog.Error(err, "unable to create webhook", "webhook", "DataProcessingUnitConfig")
+			os.Exit(1)
+		}
 	}
-	if err := (&controller.DataProcessingUnitConfigReconciler{
-		Client: mgr.GetClient(),
-		Scheme: mgr.GetScheme(),
-	}).SetupWithManager(mgr); err != nil {
-		setupLog.Error(err, "unable to create controller", "controller", "DataProcessingUnitConfig")
-		os.Exit(1)
-	}
+	// Note: DataProcessingUnitConfig webhook validates generic structure only.
+	// Vendor-specific firmware defaults and registry allowlists are enforced in each VSP.
+	// if err := (&controller.DataProcessingUnitConfigReconciler{
+	// 	Client: mgr.GetClient(),
+	// 	Scheme: mgr.GetScheme(),
+	// }).SetupWithManager(mgr); err != nil {
+	// 	setupLog.Error(err, "unable to create controller", "controller", "DataProcessingUnitConfig")
+	// 	os.Exit(1)
+	// }
 	//+kubebuilder:scaffold:builder
 
 	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {