Merge pull request #423 from anfredette/spec-to-status

Move BpfApplicationState Spec to Status

Author: mergify[bot]

apis/v1alpha1/bpf_application_state_types.go

@@ -64,22 +64,27 @@ type BpfApplicationProgramState struct {
 	URetProbe *UprobeProgramInfoState `json:"uretprobe,omitempty"`
 }
 
-// BpfApplicationSpec defines the desired state of BpfApplication
-type BpfApplicationStateSpec struct {
-	// node is the name of the node for this BpfApplicationStateSpec.
-	Node string `json:"node"`
+// BpfApplicationStateStatus reflects the status of the BpfApplication on the given node
+type BpfApplicationStateStatus struct {
 	// updateCount is the number of times the BpfApplicationState has been updated. Set to 1
 	// when the object is created, then it is incremented prior to each update.
 	// This allows us to verify that the API server has the updated object prior
 	// to starting a new Reconcile operation.
 	UpdateCount int64 `json:"updateCount"`
+	// node is the name of the node for this BpfApplicationStateSpec.
+	Node string `json:"node"`
 	// appLoadStatus reflects the status of loading the bpf application on the
 	// given node.
 	AppLoadStatus AppLoadStatus `json:"appLoadStatus"`
 	// programs is a list of bpf programs contained in the parent application.
-	// It is a map from the bpf program name to BpfApplicationProgramState
-	// elements.
 	Programs []BpfApplicationProgramState `json:"programs,omitempty"`
+	// Conditions contains the overall status of the BpfApplicationState object
+	// on the given node.
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=type
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
 }
 
 // +genclient
@@ -88,15 +93,14 @@ type BpfApplicationStateSpec struct {
 // +kubebuilder:resource:scope=Namespaced
 
 // BpfApplicationState contains the per-node state of a BpfApplication.
-// +kubebuilder:printcolumn:name="Node",type=string,JSONPath=".spec.node"
+// +kubebuilder:printcolumn:name="Node",type=string,JSONPath=".status.node"
 // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.conditions[0].reason`
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
 type BpfApplicationState struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   BpfApplicationStateSpec `json:"spec,omitempty"`
-	Status BpfAppStatus            `json:"status,omitempty"`
+	Status BpfApplicationStateStatus `json:"status,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -123,8 +127,8 @@ func (an BpfApplicationState) GetLabels() map[string]string {
 	return an.Labels
 }
 
-func (an BpfApplicationState) GetStatus() *BpfAppStatus {
-	return &an.Status
+func (an BpfApplicationState) GetConditions() []metav1.Condition {
+	return an.Status.Conditions
 }
 
 func (an BpfApplicationState) GetClientObject() client.Object {

apis/v1alpha1/cluster_bpf_application_state_types.go

@@ -36,6 +36,7 @@ import (
 // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'TracePoint' ?  has(self.tracepoint) : !has(self.tracepoint)",message="tracepoint configuration is required when type is tracepoint, and forbidden otherwise"
 type ClBpfApplicationProgramState struct {
 	BpfProgramStateCommon `json:",inline"`
+
 	// type specifies the bpf program type
 	// +unionDiscriminator
 	// +required
@@ -93,22 +94,27 @@ type ClBpfApplicationProgramState struct {
 	TracePoint *ClTracepointProgramInfoState `json:"tracepoint,omitempty"`
 }
 
-// BpfApplicationSpec defines the desired state of BpfApplication
-type ClBpfApplicationStateSpec struct {
-	// node is the name of the node for this BpfApplicationStateSpec.
-	Node string `json:"node"`
+// ClBpfApplicationStateStatus reflects the status of the ClusterBpfApplicationState on the given node
+type ClBpfApplicationStateStatus struct {
 	// updateCount is the number of times the BpfApplicationState has been updated. Set to 1
 	// when the object is created, then it is incremented prior to each update.
 	// This allows us to verify that the API server has the updated object prior
 	// to starting a new Reconcile operation.
 	UpdateCount int64 `json:"updateCount"`
+	// node is the name of the node for this BpfApplicationStateSpec.
+	Node string `json:"node"`
 	// appLoadStatus reflects the status of loading the bpf application on the
 	// given node.
 	AppLoadStatus AppLoadStatus `json:"appLoadStatus"`
 	// programs is a list of bpf programs contained in the parent application.
-	// It is a map from the bpf program name to BpfApplicationProgramState
-	// elements.
 	Programs []ClBpfApplicationProgramState `json:"programs,omitempty"`
+	// Conditions contains the overall status of the ClusterBpfApplicationState
+	// object on the given node.
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=type
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
 }
 
 // +genclient
@@ -118,15 +124,14 @@ type ClBpfApplicationStateSpec struct {
 // +kubebuilder:resource:scope=Cluster
 
 // ClusterBpfApplicationState contains the per-node state of a BpfApplication.
-// +kubebuilder:printcolumn:name="Node",type=string,JSONPath=".spec.node"
+// +kubebuilder:printcolumn:name="Node",type=string,JSONPath=".status.node"
 // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.conditions[0].reason`
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
 type ClusterBpfApplicationState struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   ClBpfApplicationStateSpec `json:"spec,omitempty"`
-	Status BpfAppStatus              `json:"status,omitempty"`
+	Status ClBpfApplicationStateStatus `json:"status,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -153,8 +158,8 @@ func (an ClusterBpfApplicationState) GetLabels() map[string]string {
 	return an.Labels
 }
 
-func (an ClusterBpfApplicationState) GetStatus() *BpfAppStatus {
-	return &an.Status
+func (an ClusterBpfApplicationState) GetConditions() []metav1.Condition {
+	return an.Status.Conditions
 }
 
 func (an ClusterBpfApplicationState) GetClientObject() client.Object {

apis/v1alpha1/shared_types.go

@@ -339,9 +339,14 @@ const (
 	// node while attempting to apply the configuration described in the CRD.
 	BpfAppStateCondProgramListChangedError BpfApplicationStateConditionType = "ProgramListChangedError"
 
-	// BpfAppStateCondDeleteError indicates that the BPF Application was marked
-	// for deletion, but deletion was unsuccessful on the given node.
-	BpfAppStateCondDeleteError BpfApplicationStateConditionType = "DeleteError"
+	// BpfAppStateCondUnloadError indicates that the BPF Application was marked
+	// for deletion, but unloading one or more programs was unsuccessful on the
+	// given node.
+	BpfAppStateCondUnloadError BpfApplicationStateConditionType = "UnloadError"
+
+	// BpfAppStateCondUnloaded indicates that the BPF Application was marked
+	// for deletion, and has been successfully unloaded.
+	BpfAppStateCondUnloaded BpfApplicationStateConditionType = "Unloaded"
 )
 
 // Condition is a helper method to promote any given
@@ -375,13 +380,21 @@ func (b BpfApplicationStateConditionType) Condition() metav1.Condition {
 			Reason:  "Error",
 			Message: "An error has occurred",
 		}
-	case BpfAppStateCondDeleteError:
-		condType := string(BpfAppStateCondDeleteError)
+	case BpfAppStateCondUnloadError:
+		condType := string(BpfAppStateCondUnloadError)
 		cond = metav1.Condition{
 			Type:    condType,
 			Status:  metav1.ConditionTrue,
-			Reason:  "Delete Error",
-			Message: "Deletion failed on one or more nodes",
+			Reason:  "Unload Error",
+			Message: "Unload failed for one or more programs",
+		}
+	case BpfAppStateCondUnloaded:
+		condType := string(BpfAppStateCondUnloaded)
+		cond = metav1.Condition{
+			Type:    condType,
+			Status:  metav1.ConditionTrue,
+			Reason:  "Unloaded",
+			Message: "The application has been successfully unloaded",
 		}
 	}
 	return cond