Surface CollectorDaemonSetExists status condition on OperatorConfig

charts/operator/crds/monitoring.googleapis.com_operatorconfigs.yaml

@@ -512,9 +512,52 @@ spec:
                     type: boolean
                 type: object
             type: object
+          status:
+            description: Status holds the status of the OperatorConfig.
+            properties:
+              conditions:
+                description: Represents the latest available observations of a podmonitor's
+                  current state.
+                items:
+                  description: MonitoringCondition describes the condition of a PodMonitoring.
+                  properties:
+                    lastTransitionTime:
+                      description: Last time the condition transitioned from one status
+                        to another.
+                      format: date-time
+                      type: string
+                    lastUpdateTime:
+                      description: The last time this condition was updated.
+                      format: date-time
+                      type: string
+                    message:
+                      description: A human-readable message indicating details about
+                        the transition.
+                      type: string
+                    reason:
+                      description: The reason for the condition's last transition.
+                      type: string
+                    status:
+                      description: Status of the condition, one of True, False, Unknown.
+                      type: string
+                    type:
+                      description: MonitoringConditionType is the type of MonitoringCondition.
+                      type: string
+                  required:
+                  - status
+                  - type
+                  type: object
+                type: array
+              observedGeneration:
+                description: The generation observed by the controller.
+                format: int64
+                type: integer
+            type: object
         type: object
     served: true
     storage: true
+    subresources:
+      status: {}
   - deprecated: true
     name: v1alpha1
     schema:

doc/api.md

@@ -66,6 +66,8 @@ Resource Types:
 </li><li>
 <a href="#monitoring.googleapis.com/v1.OperatorConfig">OperatorConfig</a>
 </li><li>
+<a href="#monitoring.googleapis.com/v1.OperatorConfigStatus">OperatorConfigStatus</a>
+</li><li>
 <a href="#monitoring.googleapis.com/v1.OperatorConfigValidator">OperatorConfigValidator</a>
 </li><li>
 <a href="#monitoring.googleapis.com/v1.OperatorFeatures">OperatorFeatures</a>
@@ -948,9 +950,11 @@ CompressionType
 </tr>
 </thead>
 <tbody><tr><td><p>&#34;gzip&#34;</p></td>
-<td></td>
+<td><p>CompressionGzip indicates that gzip compression should be used.</p>
+</td>
 </tr><tr><td><p>&#34;none&#34;</p></td>
-<td></td>
+<td><p>CompressionNone indicates that no compression should be used.</p>
+</td>
 </tr></tbody>
 </table>
 <h3 id="monitoring.googleapis.com/v1.ConfigSpec">
@@ -1462,7 +1466,10 @@ string
 <th>Description</th>
 </tr>
 </thead>
-<tbody><tr><td><p>&#34;ConfigurationCreateSuccess&#34;</p></td>
+<tbody><tr><td><p>&#34;CollectorDaemonSetExists&#34;</p></td>
+<td><p>CollectorDaemonSetExists indicates whether the collector DaemonSet exists.</p>
+</td>
+</tr><tr><td><p>&#34;ConfigurationCreateSuccess&#34;</p></td>
 <td><p>ConfigurationCreateSuccess indicates that the config generated from the
 monitoring resource was created successfully.</p>
 </td>
@@ -1473,7 +1480,7 @@ monitoring resource was created successfully.</p>
 </span>
 </h3>
 <p>
-(<em>Appears in: </em><a href="#monitoring.googleapis.com/v1.ClusterNodeMonitoring">ClusterNodeMonitoring</a>, <a href="#monitoring.googleapis.com/v1.PodMonitoringStatus">PodMonitoringStatus</a>, <a href="#monitoring.googleapis.com/v1.RulesStatus">RulesStatus</a>)
+(<em>Appears in: </em><a href="#monitoring.googleapis.com/v1.ClusterNodeMonitoring">ClusterNodeMonitoring</a>, <a href="#monitoring.googleapis.com/v1.OperatorConfigStatus">OperatorConfigStatus</a>, <a href="#monitoring.googleapis.com/v1.PodMonitoringStatus">PodMonitoringStatus</a>, <a href="#monitoring.googleapis.com/v1.RulesStatus">RulesStatus</a>)
 </p>
 <div>
 <p>MonitoringStatus holds status information of a monitoring resource.</p>
@@ -1734,6 +1741,54 @@ ScalingSpec
 <p>Scaling contains configuration options for scaling GMP.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>status</code><br/>
+<em>
+<a href="#monitoring.googleapis.com/v1.OperatorConfigStatus">
+OperatorConfigStatus
+</a>
+</em>
+</td>
+<td>
+<p>Status holds the status of the OperatorConfig.</p>
+</td>
+</tr>
+</tbody>
+</table>
+<h3 id="monitoring.googleapis.com/v1.OperatorConfigStatus">
+<span id="OperatorConfigStatus">OperatorConfigStatus
+</span>
+</h3>
+<p>
+(<em>Appears in: </em><a href="#monitoring.googleapis.com/v1.OperatorConfig">OperatorConfig</a>)
+</p>
+<div>
+<p>OperatorConfigStatus holds status information of the OperatorConfig.</p>
+</div>
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>MonitoringStatus</code><br/>
+<em>
+<a href="#monitoring.googleapis.com/v1.MonitoringStatus">
+MonitoringStatus
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>MonitoringStatus</code> are embedded into this type.)
+</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="monitoring.googleapis.com/v1.OperatorConfigValidator">

manifests/setup.yaml

@@ -2318,9 +2318,49 @@ spec:
                       type: boolean
                   type: object
               type: object
+            status:
+              description: Status holds the status of the OperatorConfig.
+              properties:
+                conditions:
+                  description: Represents the latest available observations of a podmonitor's current state.
+                  items:
+                    description: MonitoringCondition describes the condition of a PodMonitoring.
+                    properties:
+                      lastTransitionTime:
+                        description: Last time the condition transitioned from one status to another.
+                        format: date-time
+                        type: string
+                      lastUpdateTime:
+                        description: The last time this condition was updated.
+                        format: date-time
+                        type: string
+                      message:
+                        description: A human-readable message indicating details about the transition.
+                        type: string
+                      reason:
+                        description: The reason for the condition's last transition.
+                        type: string
+                      status:
+                        description: Status of the condition, one of True, False, Unknown.
+                        type: string
+                      type:
+                        description: MonitoringConditionType is the type of MonitoringCondition.
+                        type: string
+                    required:
+                      - status
+                      - type
+                    type: object
+                  type: array
+                observedGeneration:
+                  description: The generation observed by the controller.
+                  format: int64
+                  type: integer
+              type: object
           type: object
       served: true
       storage: true
+      subresources:
+        status: {}
     - deprecated: true
       name: v1alpha1
       schema:

pkg/operator/apis/monitoring/v1/monitoring_types.go

@@ -35,6 +35,8 @@ const (
 	// ConfigurationCreateSuccess indicates that the config generated from the
 	// monitoring resource was created successfully.
 	ConfigurationCreateSuccess MonitoringConditionType = "ConfigurationCreateSuccess"
+	// CollectorDaemonSetExists indicates whether the collector DaemonSet exists.
+	CollectorDaemonSetExists MonitoringConditionType = "CollectorDaemonSetExists"
 )
 
 // MonitoringCondition describes the condition of a PodMonitoring.
@@ -68,6 +70,7 @@ func NewDefaultConditions(now metav1.Time) []MonitoringCondition {
 	}
 }
 
+// IsValid returns true if the condition has a valid type and status.
 func (cond *MonitoringCondition) IsValid() bool {
 	return cond.Type != "" && cond.Status != ""
 }
@@ -107,7 +110,7 @@ func (status *MonitoringStatus) SetMonitoringCondition(gen int64, now metav1.Tim
 	cond.LastUpdateTime = now
 
 	// Check if the condition results in a transition of status state.
-	if old := conds[cond.Type]; old.Status == cond.Status {
+	if old := conds[cond.Type]; old != nil && old.Status == cond.Status {
 		cond.LastTransitionTime = old.LastTransitionTime
 	} else {
 		cond.LastTransitionTime = cond.LastUpdateTime

pkg/operator/apis/monitoring/v1/operator_types.go

@@ -28,6 +28,7 @@ import (
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:storageversion
+// +kubebuilder:subresource:status
 type OperatorConfig struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -47,6 +48,13 @@ type OperatorConfig struct {
 	Features OperatorFeatures `json:"features,omitempty"`
 	// Scaling contains configuration options for scaling GMP.
 	Scaling ScalingSpec `json:"scaling,omitempty"`
+	// Status holds the status of the OperatorConfig.
+	Status OperatorConfigStatus `json:"status,omitempty"`
+}
+
+// GetMonitoringStatus returns the status of the OperatorConfig.
+func (oc *OperatorConfig) GetMonitoringStatus() *MonitoringStatus {
+	return &oc.Status.MonitoringStatus
 }
 
 func (oc *OperatorConfig) Validate() error {
@@ -213,8 +221,12 @@ type TargetStatusSpec struct {
 // +kubebuilder:validation:Enum=none;gzip
 type CompressionType string
 
-const CompressionNone CompressionType = "none"
-const CompressionGzip CompressionType = "gzip"
+const (
+	// CompressionNone indicates that no compression should be used.
+	CompressionNone CompressionType = "none"
+	// CompressionGzip indicates that gzip compression should be used.
+	CompressionGzip CompressionType = "gzip"
+)
 
 // KubeletScraping allows enabling scraping of the Kubelets' metric endpoints.
 type KubeletScraping struct {
@@ -225,6 +237,11 @@ type KubeletScraping struct {
 	TLSInsecureSkipVerify bool `json:"tlsInsecureSkipVerify,omitempty"`
 }
 
+// OperatorConfigStatus holds status information of the OperatorConfig.
+type OperatorConfigStatus struct {
+	MonitoringStatus `json:",inline"`
+}
+
 // ExportFilters provides mechanisms to filter the scraped data that's sent to GMP.
 type ExportFilters struct {
 	// A list of Prometheus time series matchers. Every time series must match at least one

pkg/operator/collection.go

@@ -77,7 +77,10 @@ func setupCollectionControllers(op *Operator) error {
 		// at least once initially.
 		For(
 			&monitoringv1.OperatorConfig{},
-			builder.WithPredicates(objFilterOperatorConfig),
+			builder.WithPredicates(
+				objFilterOperatorConfig,
+				predicate.GenerationChangedPredicate{},
+			),
 		).
 		// Any update to a PodMonitoring requires regenerating the config.
 		Watches(
@@ -163,6 +166,7 @@ func (r *collectionReconciler) Reconcile(ctx context.Context, req reconcile.Requ
 	// Fetch OperatorConfig if it exists.
 	if err := r.client.Get(ctx, req.NamespacedName, &config); apierrors.IsNotFound(err) {
 		logger.Info("no operatorconfig created yet")
+		return reconcile.Result{}, nil
 	} else if err != nil {
 		return reconcile.Result{}, fmt.Errorf("get operatorconfig for incoming: %q: %w", req.String(), err)
 	}
@@ -171,10 +175,13 @@ func (r *collectionReconciler) Reconcile(ctx context.Context, req reconcile.Requ
 		return reconcile.Result{}, fmt.Errorf("ensure collector secrets: %w", err)
 	}
 	// Deploy Prometheus collector as a node agent.
-	if err := r.ensureCollectorDaemonSet(ctx); err != nil {
+	if changed, err := r.ensureCollectorDaemonSet(ctx, &config); err != nil {
 		return reconcile.Result{}, fmt.Errorf("ensure collector daemon set: %w", err)
+	} else if changed {
+		if err := patchMonitoringStatus(ctx, r.client, &config, config.GetMonitoringStatus()); err != nil {
+			return reconcile.Result{}, fmt.Errorf("patch operatorconfig status: %w", err)
+		}
 	}
-
 	if err := r.ensureCollectorConfig(ctx, &config.Collection, config.Features.Config.Compression, config.Exports); err != nil {
 		return reconcile.Result{}, fmt.Errorf("ensure collector config: %w", err)
 	}
@@ -216,18 +223,36 @@ func (r *collectionReconciler) ensureCollectorSecrets(ctx context.Context, spec
 }
 
 // ensureCollectorDaemonSet populates the collector DaemonSet with operator-provided values.
-func (r *collectionReconciler) ensureCollectorDaemonSet(ctx context.Context) error {
+func (r *collectionReconciler) ensureCollectorDaemonSet(ctx context.Context, config *monitoringv1.OperatorConfig) (bool, error) {
 	logger, _ := logr.FromContext(ctx)
 
-	var ds appsv1.DaemonSet
-	err := r.client.Get(ctx, client.ObjectKey{Namespace: r.opts.OperatorNamespace, Name: NameCollector}, &ds)
+	// Build the DaemonSet.
+	// For now, we only ensure the DaemonSet exists.
+	// In the future, we might want to reconcile the DaemonSet spec as well.
+	ds := &appsv1.DaemonSet{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      NameCollector,
+			Namespace: r.opts.OperatorNamespace,
+		},
+	}
+
+	err := r.client.Get(ctx, client.ObjectKeyFromObject(ds), ds)
 	// Some users deliberately not want to run the collectors. Only emit a warning but don't cause
 	// retries as this logic gets re-triggered anyway if the DaemonSet is created later.
+	cond := &monitoringv1.MonitoringCondition{
+		Type:   monitoringv1.CollectorDaemonSetExists,
+		Status: corev1.ConditionUnknown,
+	}
 	if apierrors.IsNotFound(err) {
 		logger.Error(err, "collector DaemonSet does not exist")
-		return nil
-	}
-	return err
+		cond.Status = corev1.ConditionFalse
+		cond.Reason = "DaemonSetMissing"
+		cond.Message = "Collector DaemonSet does not exist."
+		err = nil
+	} else if err == nil {
+		cond.Status = corev1.ConditionTrue
+	}
+	return config.Status.SetMonitoringCondition(config.GetGeneration(), metav1.Now(), cond), err
 }
 
 func gzipData(data []byte) ([]byte, error) {