k8s API for healtheventwithstatus model

.gitignore

@@ -137,6 +137,7 @@ dist/
 # IDE & Editor Configurations
 # ============================================================================
 
+
 ### JetBrains IDEs (GoLand, PyCharm, IntelliJ) ###
 ### JetBrains IDEs (GoLand, PyCharm, IntelliJ) ###
 # User-specific stuff
@@ -457,3 +458,8 @@ tests/scale-tests/FQM_LATENCY_TEST_PLAN.md
 tests/scale-tests/CONCURRENT_DRAIN_TEST_PLAN.md
 tests/scale-tests/results/*.csv
 tests/scale-tests/cmd/fqm-scale-test/results/
+
+# data-models Local Go tools installed via Makefile
+data-models/.tools/
+data-models/bin/
+

data-models/Makefile

@@ -37,10 +37,56 @@ DOCKER_EXTRA_ARGS :=
 include ../make/common.mk
 include ../make/go.mk
 
+# Version of controller-gen to use for generating CRD deepcopy, client, etc.
+CONTROLLER_GEN_VERSION := v0.17.2
+
+# Local path to controller-gen binary
+CONTROLLER_GEN_BIN := $(PWD)/bin/controller-gen
+
+# API and CRD paths
+API_DIR := api/v1alpha1
+CRD_OUTPUT_DIR := $(REPO_ROOT)/distros/kubernetes/nvsentinel/charts/data-models/crds
+
+
 # =============================================================================
 # MODULE-SPECIFIC TARGETS
 # =============================================================================
 
+# tools: Install controller-gen locally if not present or version mismatch
+.PHONY: tools
+tools:
+	@echo "Ensuring controller-gen $(CONTROLLER_GEN_VERSION) is installed..."
+	mkdir -p $(PWD)/bin
+	@if [ -f "$(CONTROLLER_GEN_BIN)" ]; then \
+		VERSION="$$( $(CONTROLLER_GEN_BIN) --version 2>/dev/null | awk '{print $$2}' )"; \
+		if [ "$$VERSION" = "$(CONTROLLER_GEN_VERSION)" ]; then \
+			echo "controller-gen $(CONTROLLER_GEN_VERSION) already installed."; \
+		else \
+			echo "controller-gen version mismatch (found $$VERSION). Installing correct version..."; \
+			GO111MODULE=on GOPATH=$(PWD)/.tools go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_GEN_VERSION); \
+			ln -sf $(PWD)/.tools/bin/controller-gen $(CONTROLLER_GEN_BIN); \
+		fi \
+	else \
+		echo "controller-gen not found. Installing..."; \
+		GO111MODULE=on GOPATH=$(PWD)/.tools go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_GEN_VERSION); \
+		ln -sf $(PWD)/.tools/bin/controller-gen $(CONTROLLER_GEN_BIN); \
+	fi
+
+# generate: Generate deepcopy, CRD types, and other Kubernetes boilerplate
+# Depends on tools being installed
+.PHONY: generate
+generate: tools
+	@echo "Generating deepcopy files for API types..."
+	@$(CONTROLLER_GEN_BIN) object paths=./$(API_DIR)
+	@echo "Generating CRD YAML manifests..."
+	@$(CONTROLLER_GEN_BIN) crd paths=./$(API_DIR) output:crd:artifacts:config=./$(API_DIR)/crds
+	@echo "Moving CRDs to Helm chart directory..."
+	@mkdir -p $(CRD_OUTPUT_DIR)
+	@mv ./$(API_DIR)/crds/*.yaml $(CRD_OUTPUT_DIR)/ || true
+	@echo "CRDs generated and moved to $(CRD_OUTPUT_DIR)"
+	@ls -1 $(CRD_OUTPUT_DIR)/*.yaml || echo "No CRD YAMLs generated"
+
+
 # Generate Go protobuf files for data-models (shared across all Go modules)
 .PHONY: protos-generate
 protos-generate: protos-clean

data-models/api/v1alpha1/groupversion_info.go

@@ -0,0 +1,34 @@
+// Copyright (c) 2025, NVIDIA CORPORATION.  All rights reserved.
+//
+// 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 v1alpha1 contains API Schema definitions for the data-models v1alpha1 API group
+// +kubebuilder:object:generate=true
+// +groupName=data-models.dgxc.nvidia.com
+package v1alpha1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "data-models.dgxc.nvidia.com", Version: "v1alpha1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)

data-models/api/v1alpha1/healthstatus_types.go

@@ -0,0 +1,135 @@
+// Copyright (c) 2025, NVIDIA CORPORATION.  All rights reserved.
+//
+// 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 v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// +kubebuilder:validation:Enum=NotStarted;InProgress;Failed;Succeeded;AlreadyDrained;UnQuarantined;Quarantined;AlreadyQuarantined;Cancelled
+type Status string
+
+const (
+	StatusNotStarted Status = "NotStarted"
+	StatusInProgress Status = "InProgress"
+	StatusFailed     Status = "Failed"
+	StatusSucceeded  Status = "Succeeded"
+	AlreadyDrained   Status = "AlreadyDrained"
+
+	UnQuarantined      Status = "UnQuarantined"
+	Quarantined        Status = "Quarantined"
+	AlreadyQuarantined Status = "AlreadyQuarantined"
+	Cancelled          Status = "Cancelled"
+)
+
+// HealthEventSpec defines the desired state of HealthStatus
+type HealthEventSpec struct {
+	// Unique identifier for the health event
+	EventID string `json:"eventID"`
+
+	// Node associated with this health event
+	NodeName string `json:"nodeName"`
+}
+
+// OperationStatus captures the status of a remediation operation
+type OperationStatus struct {
+	// Current operation status
+	Status Status `json:"status"`
+
+	// Optional human-readable message
+	Message string `json:"message,omitempty"`
+}
+
+// HealthEventSnapshot represents a read-only snapshot of a reported health event.
+// This data is observational and originates outside Kubernetes.
+type HealthEventSnapshot struct {
+	// Version of the reported health event schema
+	Version uint32 `json:"version,omitempty"`
+
+	// Reporting agent that generated the event
+	Agent string `json:"agent,omitempty"`
+
+	// Component class that raised the event
+	ComponentClass string `json:"componentClass,omitempty"`
+
+	// Specific check or rule that triggered the event
+	CheckName string `json:"checkName,omitempty"`
+
+	// Indicates whether the event is fatal
+	IsFatal bool `json:"isFatal,omitempty"`
+
+	// Indicates whether the system was reported healthy
+	IsHealthy bool `json:"isHealthy,omitempty"`
+
+	// Human-readable event message
+	Message string `json:"message,omitempty"`
+
+	// Recommended action provided by the reporting system
+	RecommendedAction string `json:"recommendedAction,omitempty"`
+
+	// Error codes associated with this health event
+	ErrorCode []string `json:"errorCode,omitempty"`
+
+	// Additional key-value metadata provided by the agent
+	Metadata map[string]string `json:"metadata,omitempty"`
+
+	// Time at which the event was generated by the source
+	GeneratedTimestamp *metav1.Time `json:"generatedTimestamp,omitempty"`
+}
+
+// RemediationStatus captures the observed state of remediation workflows
+type RemediationStatus struct {
+	// Indicates whether the node is quarantined
+	NodeQuarantined *Status `json:"nodeQuarantined,omitempty"`
+
+	// Status of user pods eviction process
+	UserPodsEvictionStatus *OperationStatus `json:"userPodsEvictionStatus,omitempty"`
+
+	// Whether the fault has been remediated
+	FaultRemediated *bool `json:"faultRemediated,omitempty"`
+
+	// Timestamp of the last remediation attempt
+	LastRemediationTimestamp *metav1.Time `json:"lastRemediationTimestamp,omitempty"`
+}
+
+// HealthEventStatus defines the observed state of HealthStatus
+type HealthEventStatus struct {
+	// Snapshot of the reported health event
+	Event *HealthEventSnapshot `json:"event,omitempty"`
+
+	// Observed remediation state
+	Remediation *RemediationStatus `json:"remediation,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+type HealthStatus struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   HealthEventSpec   `json:"spec,omitempty"`
+	Status HealthEventStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+type HealthStatusList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []HealthStatus `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&HealthStatus{}, &HealthStatusList{})
+}