Skip to content

⚠️ Remove per node-data from rule status #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Karthik-K-N wants to merge 1 commit into
base: main
Choose a base branch
from
Open

⚠️ Remove per node-data from rule status #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 3 additions & 113 deletions api/v1alpha1/nodereadinessrule_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,33 +112,10 @@ type NodeReadinessRuleStatus struct {
// +kubebuilder:validation:Minimum=1
ObservedGeneration int64 `json:"observedGeneration,omitempty"`

// appliedNodes lists the names of Nodes where the taint has been successfully managed.
// This provides a quick reference to the scope of impact for this rule.
// lastEvaluationTime is the timestamp when the rule was evaluated against all the nodes in the cluster.
//
// +optional
// +listType=set
// +kubebuilder:validation:MaxItems=5000
// +kubebuilder:validation:items:MaxLength=253
AppliedNodes []string `json:"appliedNodes,omitempty"`

// failedNodes lists the Nodes where the rule evaluation encountered an error.
// This is used for troubleshooting configuration issues, such as invalid selectors during node lookup.
//
// +optional
// +listType=map
// +listMapKey=nodeName
// +kubebuilder:validation:MaxItems=5000
FailedNodes []NodeFailure `json:"failedNodes,omitempty"`

// nodeEvaluations provides detailed insight into the rule's assessment for individual Nodes.
// This is primarily used for auditing and debugging why specific Nodes were or
// were not targeted by the rule.
//
// +optional
// +listType=map
// +listMapKey=nodeName
// +kubebuilder:validation:MaxItems=5000
NodeEvaluations []NodeEvaluation `json:"nodeEvaluations,omitempty"`
// +required
LastEvaluationTime metav1.Time `json:"lastEvaluationTime,omitempty,omitzero"`

// dryRunResults captures the outcome of the rule evaluation when DryRun is enabled.
// This field provides visibility into the actions the controller would have taken,
Expand All @@ -148,93 +125,6 @@ type NodeReadinessRuleStatus struct {
DryRunResults DryRunResults `json:"dryRunResults,omitempty,omitzero"`
}

// NodeFailure provides diagnostic details for Nodes that could not be successfully evaluated by the rule.
type NodeFailure struct {
// nodeName is the name of the failed Node.
//
// Following kubebuilder validation is referred from
// https://github.com/kubernetes/apimachinery/blob/84d740c9e27f3ccc94c8bc4d13f1b17f60f7080b/pkg/util/validation/validation.go#L198
//
// +required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=253
// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
NodeName string `json:"nodeName,omitempty"`

// reason provides a brief explanation of the evaluation result.
//
// +optional
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=256
Reason string `json:"reason,omitempty"`

// message is a human-readable message indicating details about the evaluation.
//
// +optional
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=10240
Message string `json:"message,omitempty"`

// lastEvaluationTime is the timestamp of the last rule check failed for this Node.
//
// +required
LastEvaluationTime metav1.Time `json:"lastEvaluationTime,omitempty,omitzero"`
}

// NodeEvaluation provides a detailed audit of a single Node's compliance with the rule.
type NodeEvaluation struct {
// nodeName is the name of the evaluated Node.
//
// +required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=253
// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
NodeName string `json:"nodeName,omitempty"`

// conditionResults provides a detailed breakdown of each condition evaluation
// for this Node. This allows for granular auditing of which specific
// criteria passed or failed during the rule assessment.
//
// +required
// +listType=map
// +listMapKey=type
// +kubebuilder:validation:MaxItems=5000
ConditionResults []ConditionEvaluationResult `json:"conditionResults,omitempty"`

// taintStatus represents the taint status on the Node, one of Present, Absent.
//
// +required
TaintStatus TaintStatus `json:"taintStatus,omitempty"`

// lastEvaluationTime is the timestamp when the controller last assessed this Node.
//
// +required
LastEvaluationTime metav1.Time `json:"lastEvaluationTime,omitempty,omitzero"`
}

// ConditionEvaluationResult provides a detailed report of the comparison between
// the Node's observed condition and the rule's requirement.
type ConditionEvaluationResult struct {
// type corresponds to the Node condition type being evaluated.
//
// +required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=316
Type string `json:"type,omitempty"`

// currentStatus is the actual status value observed on the Node, one of True, False, Unknown.
//
// +required
// +kubebuilder:validation:Enum=True;False;Unknown
CurrentStatus corev1.ConditionStatus `json:"currentStatus,omitempty"`

// requiredStatus is the status value defined in the rule that must be matched, one of True, False, Unknown.
//
// +required
// +kubebuilder:validation:Enum=True;False;Unknown
RequiredStatus corev1.ConditionStatus `json:"requiredStatus,omitempty"`
}

// DryRunResults provides a summary of the actions the controller would perform if DryRun mode is enabled.
// +kubebuilder:validation:MinProperties=1
type DryRunResults struct {
Expand Down
72 changes: 1 addition & 71 deletions api/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

142 changes: 7 additions & 135 deletions config/crd/bases/readiness.node.x-k8s.io_nodereadinessrules.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,16 +189,6 @@ spec:
description: status defines the observed state of NodeReadinessRule
minProperties: 1
properties:
appliedNodes:
description: |-
appliedNodes lists the names of Nodes where the taint has been successfully managed.
This provides a quick reference to the scope of impact for this rule.
items:
maxLength: 253
type: string
maxItems: 5000
type: array
x-kubernetes-list-type: set
dryRunResults:
description: |-
dryRunResults captures the outcome of the rule evaluation when DryRun is enabled.
Expand Down Expand Up @@ -242,137 +232,19 @@ spec:
required:
- summary
type: object
failedNodes:
description: |-
failedNodes lists the Nodes where the rule evaluation encountered an error.
This is used for troubleshooting configuration issues, such as invalid selectors during node lookup.
items:
description: NodeFailure provides diagnostic details for Nodes that
could not be successfully evaluated by the rule.
properties:
lastEvaluationTime:
description: lastEvaluationTime is the timestamp of the last
rule check failed for this Node.
format: date-time
type: string
message:
description: message is a human-readable message indicating
details about the evaluation.
maxLength: 10240
minLength: 1
type: string
nodeName:
description: |-
nodeName is the name of the failed Node.

Following kubebuilder validation is referred from
https://github.com/kubernetes/apimachinery/blob/84d740c9e27f3ccc94c8bc4d13f1b17f60f7080b/pkg/util/validation/validation.go#L198
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
reason:
description: reason provides a brief explanation of the evaluation
result.
maxLength: 256
minLength: 1
type: string
required:
- lastEvaluationTime
- nodeName
type: object
maxItems: 5000
type: array
x-kubernetes-list-map-keys:
- nodeName
x-kubernetes-list-type: map
nodeEvaluations:
description: |-
nodeEvaluations provides detailed insight into the rule's assessment for individual Nodes.
This is primarily used for auditing and debugging why specific Nodes were or
were not targeted by the rule.
items:
description: NodeEvaluation provides a detailed audit of a single
Node's compliance with the rule.
properties:
conditionResults:
description: |-
conditionResults provides a detailed breakdown of each condition evaluation
for this Node. This allows for granular auditing of which specific
criteria passed or failed during the rule assessment.
items:
description: |-
ConditionEvaluationResult provides a detailed report of the comparison between
the Node's observed condition and the rule's requirement.
properties:
currentStatus:
description: currentStatus is the actual status value
observed on the Node, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
requiredStatus:
description: requiredStatus is the status value defined
in the rule that must be matched, one of True, False,
Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type corresponds to the Node condition type
being evaluated.
maxLength: 316
minLength: 1
type: string
required:
- currentStatus
- requiredStatus
- type
type: object
maxItems: 5000
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
lastEvaluationTime:
description: lastEvaluationTime is the timestamp when the controller
last assessed this Node.
format: date-time
type: string
nodeName:
description: nodeName is the name of the evaluated Node.
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
taintStatus:
description: taintStatus represents the taint status on the
Node, one of Present, Absent.
enum:
- Present
- Absent
type: string
required:
- conditionResults
- lastEvaluationTime
- nodeName
- taintStatus
type: object
maxItems: 5000
type: array
x-kubernetes-list-map-keys:
- nodeName
x-kubernetes-list-type: map
lastEvaluationTime:
description: lastEvaluationTime is the timestamp when the rule was
evaluated against all the nodes in the cluster.
format: date-time
type: string
observedGeneration:
description: observedGeneration reflects the generation of the most
recently observed NodeReadinessRule by the controller.
format: int64
minimum: 1
type: integer
required:
- lastEvaluationTime
type: object
required:
- spec
Expand Down
7 changes: 7 additions & 0 deletions config/rbac/role.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ kind: ClusterRole
metadata:
name: manager-role
rules:
- apiGroups:
- ""
resources:
- events
verbs:
- create
- patch
- apiGroups:
- ""
resources:
Expand Down
Loading
Loading