Add ptpconfig status condition

Signed-off-by: Aneesh Puttur <[email protected]>

Author: aneeshkp

README.md

@@ -4,6 +4,7 @@
 - [PTP Operator](#ptp-operator)
 - [PtpOperatorConfig](#ptpoperatorconfig)
 - [PtpConfig](#ptpconfig)
+- [PtpConfig Status](#ptpconfig-status)
 - [Quick Start](#quick-start)
 
 ## PTP Operator
@@ -314,6 +315,42 @@ Two ptp4l configurations must exist with the phc2sysOPts field set to an empty s
 The names of these ptp4l configurations will be used and listed under the ptpSettings/haProfiles key in the phc2sys-only enabled ptpConfig.
 
 
+## PtpConfig Status
+PtpConfig includes a status subresource with `ptpStatus.conditions[]` that operands (linuxptp-daemon, cloud-event-proxy) can update. Each condition includes `type`, `profile` (logical profile), `filename` (active config file), `status`, `reason`, `message`, and `lastUpdateTime`.
+
+Example populated status:
+```yaml
+status:
+  matchList:
+    - nodeName: worker-0
+      profile: GM-Profile-A
+  ptpStatus:
+    conditions:
+      - type: PTP4lRunning
+        profile: GM-Profile-A
+        filename: ptp4l.0.config
+        status: "True"
+        reason: Started
+        message: "ptp4l is running (pid 3124)"
+        lastUpdateTime: "2025-06-27T10:13:10Z"
+      - type: LockState
+        profile: GM-Profile-A
+        filename: ptp4l.0.config
+        status: "True"
+        reason: LOCKED
+        message: "clock state is LOCKED"
+        lastUpdateTime: "2025-06-27T10:15:00Z"
+      - type: ClockClass
+        profile: GM-Profile-A
+        filename: /ptp4l.0.config
+        status: "True"
+        reason: Class6
+        message: "clock class is 6"
+        lastUpdateTime: "2025-06-27T10:15:00Z"
+```
+
+RBAC for linuxptp-daemon to update `ptpconfigs/status` is included in `bindata/linuxptp/ptp-daemon.yaml`.
+
 ## Quick Start
 
 To install PTP Operator:

api/v1/ptpconfig_types.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1
 
 import (
+	corev1 "k8s.io/api/core/v1"
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -38,6 +39,7 @@ type PtpConfigStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
 	MatchList []NodeMatchList `json:"matchList,omitempty"`
+	PtpStatus PtpStatus       `json:"ptpStatus,omitempty"`
 }
 
 //+kubebuilder:object:root=true
@@ -112,6 +114,56 @@ type NodeMatchList struct {
 	Profile  *string `json:"profile"`
 }
 
+// PtpConditionType represents categories of PTP conditions reported by operands
+type PtpConditionType string
+
+const (
+	// Process lifecycle
+	ConditionPodRestarted   PtpConditionType = "PodRestarted"
+	ConditionPTP4lRunning   PtpConditionType = "PTP4lRunning"
+	ConditionPhc2sysRunning PtpConditionType = "Phc2sysRunning"
+	ConditionTs2phcRunning  PtpConditionType = "Ts2phcRunning"
+	ConditionSynce4lRunning PtpConditionType = "Synce4lRunning"
+	ConditionChronydRunning PtpConditionType = "ChronydRunning"
+
+	// Profile/apply
+	ConditionProfileApplied PtpConditionType = "ProfileApplied"
+
+	// NIC/PHC capabilities
+	ConditionNICCapabilities PtpConditionType = "NICCapabilities"
+
+	// State and class (values reflected in Reason/Message)
+	ConditionLockState  PtpConditionType = "LockState"  // LOCKED/HOLDOVER/FREERUN
+	ConditionClockClass PtpConditionType = "ClockClass" // 6/7/248
+	ConditionPortState  PtpConditionType = "PortState"  // INITIALIZING/LISTENING/SLAVE/MASTER/FAULTY
+
+	// Event/CEP
+	ConditionEventFramework PtpConditionType = "EventFramework"
+
+	// GNSS/DPLL (when applicable)
+	ConditionGNSSState  PtpConditionType = "GNSSState"
+	ConditionDPLLStatus PtpConditionType = "DPLLStatus"
+
+	// Overall service readiness
+	ConditionPTPServiceReady PtpConditionType = "PTPServiceReady"
+)
+
+// PtpCondition mirrors standard Kubernetes condition patterns
+type PtpCondition struct {
+	Type           PtpConditionType       `json:"type"`
+	Profile        string                 `json:"profile,omitempty"`
+	Filename       string                 `json:"filename,omitempty"`
+	Status         corev1.ConditionStatus `json:"status"`
+	Reason         string                 `json:"reason,omitempty"`
+	Message        string                 `json:"message,omitempty"`
+	LastUpdateTime metav1.Time            `json:"lastUpdateTime,omitempty"`
+}
+
+// PtpStatus aggregates conditions emitted by operands for this PtpConfig
+type PtpStatus struct {
+	Conditions []PtpCondition `json:"conditions,omitempty"`
+}
+
 func init() {
 	SchemeBuilder.Register(&PtpConfig{}, &PtpConfigList{})
 }

api/v1/zz_generated.deepcopy.go

@@ -227,6 +227,35 @@ subjects:
     name: prometheus-k8s
     namespace: openshift-monitoring
 ---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: Role
+metadata:
+  name: ptpconfig-status-writer
+  namespace: openshift-ptp
+rules:
+  - apiGroups:
+      - ptp.openshift.io
+    resources:
+      - ptpconfigs/status
+    verbs:
+      - get
+      - update
+      - patch
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: RoleBinding
+metadata:
+  name: ptpconfig-status-writer-linuxptp
+  namespace: openshift-ptp
+subjects:
+  - kind: ServiceAccount
+    name: linuxptp-daemon
+    namespace: openshift-ptp
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: Role
+  name: ptpconfig-status-writer
+---
 apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:

bindata/linuxptp/ptp-daemon.yaml

@@ -150,6 +150,38 @@ spec:
                   - profile
                   type: object
                 type: array
+              ptpStatus:
+                description: PtpStatus aggregates conditions emitted by operands for
+                  this PtpConfig
+                properties:
+                  conditions:
+                    items:
+                      description: PtpCondition mirrors standard Kubernetes condition
+                        patterns
+                      properties:
+                        filename:
+                          type: string
+                        lastUpdateTime:
+                          format: date-time
+                          type: string
+                        message:
+                          type: string
+                        profile:
+                          type: string
+                        reason:
+                          type: string
+                        status:
+                          type: string
+                        type:
+                          description: PtpConditionType represents categories of PTP
+                            conditions reported by operands
+                          type: string
+                      required:
+                      - status
+                      - type
+                      type: object
+                    type: array
+                type: object
             type: object
         type: object
     served: true

config/crd/bases/ptp.openshift.io_ptpconfigs.yaml

@@ -0,0 +1,50 @@
+package status
+
+import (
+	"context"
+	"time"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/wait"
+
+	ptpv1 "github.com/k8snetworkplumbingwg/ptp-operator/api/v1"
+	clientset "github.com/k8snetworkplumbingwg/ptp-operator/pkg/client/clientset/versioned"
+)
+
+// UpsertPtpCondition updates or appends a condition on the PtpConfig status and issues UpdateStatus with retry
+func UpsertPtpCondition(ctx context.Context, cs clientset.Interface, namespace, name string, cond ptpv1.PtpCondition) error {
+	backoff := wait.Backoff{Duration: 100 * time.Millisecond, Factor: 1.5, Jitter: 0.1, Steps: 6}
+	return wait.ExponentialBackoff(backoff, func() (bool, error) {
+		pc, err := cs.PtpV1().PtpConfigs(namespace).Get(ctx, name, metav1.GetOptions{})
+		if err != nil {
+			return false, err
+		}
+
+		// upsert by Type+Profile
+		updated := false
+		for i := range pc.Status.PtpStatus.Conditions {
+			c := &pc.Status.PtpStatus.Conditions[i]
+			if c.Type == cond.Type && c.Profile == cond.Profile {
+				*c = cond
+				updated = true
+				break
+			}
+		}
+		if !updated {
+			pc.Status.PtpStatus.Conditions = append(pc.Status.PtpStatus.Conditions, cond)
+		}
+
+		// enforce max history
+		const maxConditions = 100
+		if n := len(pc.Status.PtpStatus.Conditions); n > maxConditions {
+			pc.Status.PtpStatus.Conditions = pc.Status.PtpStatus.Conditions[n-maxConditions:]
+		}
+
+		_, err = cs.PtpV1().PtpConfigs(namespace).UpdateStatus(ctx, pc, metav1.UpdateOptions{})
+		if err != nil {
+			// retry on conflict or transient errors
+			return false, nil
+		}
+		return true, nil
+	})
+}