Merge pull request #210 from fluxcd/reconcile-request-status

hiddeco · web-flow · commit 9c6c1a85479a · 2020-11-19T14:00:06.000+01:00
Add LastHandledReconcileAt to source statuses
diff --git a/api/v1beta1/bucket_types.go b/api/v1beta1/bucket_types.go
@@ -95,6 +95,8 @@ type BucketStatus struct {
 	// Artifact represents the output of the last successful Bucket sync.
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
+
+	meta.ReconcileRequestStatus `json:",inline"`
 }
 
 const (
diff --git a/api/v1beta1/gitrepository_types.go b/api/v1beta1/gitrepository_types.go
@@ -116,6 +116,8 @@ type GitRepositoryStatus struct {
 	// Artifact represents the output of the last successful repository sync.
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
+
+	meta.ReconcileRequestStatus `json:",inline"`
 }
 
 const (
diff --git a/api/v1beta1/helmchart_types.go b/api/v1beta1/helmchart_types.go
@@ -86,6 +86,8 @@ type HelmChartStatus struct {
 	// Artifact represents the output of the last successful chart sync.
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
+
+	meta.ReconcileRequestStatus `json:",inline"`
 }
 
 const (
diff --git a/api/v1beta1/helmrepository_types.go b/api/v1beta1/helmrepository_types.go
@@ -73,6 +73,8 @@ type HelmRepositoryStatus struct {
 	// Artifact represents the output of the last successful repository sync.
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
+
+	meta.ReconcileRequestStatus `json:",inline"`
 }
 
 const (
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/source.toolkit.fluxcd.io_buckets.yaml b/config/crd/bases/source.toolkit.fluxcd.io_buckets.yaml
@@ -196,6 +196,10 @@ spec:
                   - type
                   type: object
                 type: array
+              lastHandledReconcileAt:
+                description: LastHandledReconcileAt holds the value of the most recent
+                  reconcile request value, so a change can be detected.
+                type: string
               observedGeneration:
                 description: ObservedGeneration is the last observed generation.
                 format: int64
diff --git a/config/crd/bases/source.toolkit.fluxcd.io_gitrepositories.yaml b/config/crd/bases/source.toolkit.fluxcd.io_gitrepositories.yaml
@@ -224,6 +224,10 @@ spec:
                   - type
                   type: object
                 type: array
+              lastHandledReconcileAt:
+                description: LastHandledReconcileAt holds the value of the most recent
+                  reconcile request value, so a change can be detected.
+                type: string
               observedGeneration:
                 description: ObservedGeneration is the last observed generation.
                 format: int64
diff --git a/config/crd/bases/source.toolkit.fluxcd.io_helmcharts.yaml b/config/crd/bases/source.toolkit.fluxcd.io_helmcharts.yaml
@@ -200,6 +200,10 @@ spec:
                   - type
                   type: object
                 type: array
+              lastHandledReconcileAt:
+                description: LastHandledReconcileAt holds the value of the most recent
+                  reconcile request value, so a change can be detected.
+                type: string
               observedGeneration:
                 description: ObservedGeneration is the last observed generation.
                 format: int64
diff --git a/config/crd/bases/source.toolkit.fluxcd.io_helmrepositories.yaml b/config/crd/bases/source.toolkit.fluxcd.io_helmrepositories.yaml
@@ -175,6 +175,10 @@ spec:
                   - type
                   type: object
                 type: array
+              lastHandledReconcileAt:
+                description: LastHandledReconcileAt holds the value of the most recent
+                  reconcile request value, so a change can be detected.
+                type: string
               observedGeneration:
                 description: ObservedGeneration is the last observed generation.
                 format: int64
diff --git a/controllers/bucket_controller.go b/controllers/bucket_controller.go
@@ -109,6 +109,13 @@ func (r *BucketReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 		r.recordReadiness(bucket)
 	}
 
+	// record the value of the reconciliation request, if any
+	// TODO(hidde): would be better to defer this in combination with
+	//   always patching the status sub-resource after a reconciliation.
+	if v, ok := meta.ReconcileAnnotationValue(bucket.GetAnnotations()); ok {
+		bucket.Status.SetLastHandledReconcileRequest(v)
+	}
+
 	// purge old artifacts from storage
 	if err := r.gc(bucket); err != nil {
 		log.Error(err, "unable to purge old artifacts")
diff --git a/controllers/gitrepository_controller.go b/controllers/gitrepository_controller.go
@@ -108,6 +108,13 @@ func (r *GitRepositoryReconciler) Reconcile(req ctrl.Request) (ctrl.Result, erro
 		r.recordReadiness(repository)
 	}
 
+	// record the value of the reconciliation request, if any
+	// TODO(hidde): would be better to defer this in combination with
+	//   always patching the status sub-resource after a reconciliation.
+	if v, ok := meta.ReconcileAnnotationValue(repository.GetAnnotations()); ok {
+		repository.Status.SetLastHandledReconcileRequest(v)
+	}
+
 	// purge old artifacts from storage
 	if err := r.gc(repository); err != nil {
 		log.Error(err, "unable to purge old artifacts")
diff --git a/controllers/helmchart_controller.go b/controllers/helmchart_controller.go
@@ -95,7 +95,7 @@ func (r *HelmChartReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 		return r.reconcileDelete(ctx, chart)
 	}
 
-	// record reconciliation duration
+	// Record reconciliation duration
 	if r.MetricsRecorder != nil {
 		objRef, err := reference.GetReference(r.Scheme, &chart)
 		if err != nil {
@@ -115,6 +115,13 @@ func (r *HelmChartReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 		r.recordReadiness(chart)
 	}
 
+	// Record the value of the reconciliation request, if any
+	// TODO(hidde): would be better to defer this in combination with
+	//   always patching the status sub-resource after a reconciliation.
+	if v, ok := meta.ReconcileAnnotationValue(chart.GetAnnotations()); ok {
+		chart.Status.SetLastHandledReconcileRequest(v)
+	}
+
 	// Purge all but current artifact from storage
 	if err := r.gc(chart); err != nil {
 		log.Error(err, "unable to purge old artifacts")
diff --git a/controllers/helmrepository_controller.go b/controllers/helmrepository_controller.go
@@ -109,6 +109,13 @@ func (r *HelmRepositoryReconciler) Reconcile(req ctrl.Request) (ctrl.Result, err
 		r.recordReadiness(repository)
 	}
 
+	// record the value of the reconciliation request, if any
+	// TODO(hidde): would be better to defer this in combination with
+	//   always patching the status sub-resource after a reconciliation.
+	if v, ok := meta.ReconcileAnnotationValue(repository.GetAnnotations()); ok {
+		repository.Status.SetLastHandledReconcileRequest(v)
+	}
+
 	// purge old artifacts from storage
 	if err := r.gc(repository); err != nil {
 		log.Error(err, "unable to purge old artifacts")
diff --git a/docs/api/source.md b/docs/api/source.md
@@ -908,7 +908,7 @@ int64
 <td>
 <code>conditions</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#condition-v1-meta">
+<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Condition">
 []Kubernetes meta/v1.Condition
 </a>
 </em>
@@ -944,6 +944,21 @@ Artifact
 <p>Artifact represents the output of the last successful Bucket sync.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>ReconcileRequestStatus</code><br>
+<em>
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#ReconcileRequestStatus">
+github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>ReconcileRequestStatus</code> are embedded into this type.)
+</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -1170,7 +1185,7 @@ int64
 <td>
 <code>conditions</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#condition-v1-meta">
+<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Condition">
 []Kubernetes meta/v1.Condition
 </a>
 </em>
@@ -1207,6 +1222,21 @@ Artifact
 <p>Artifact represents the output of the last successful repository sync.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>ReconcileRequestStatus</code><br>
+<em>
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#ReconcileRequestStatus">
+github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>ReconcileRequestStatus</code> are embedded into this type.)
+</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -1373,7 +1403,7 @@ int64
 <td>
 <code>conditions</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#condition-v1-meta">
+<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Condition">
 []Kubernetes meta/v1.Condition
 </a>
 </em>
@@ -1409,6 +1439,21 @@ Artifact
 <p>Artifact represents the output of the last successful chart sync.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>ReconcileRequestStatus</code><br>
+<em>
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#ReconcileRequestStatus">
+github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>ReconcileRequestStatus</code> are embedded into this type.)
+</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -1524,7 +1569,7 @@ int64
 <td>
 <code>conditions</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#condition-v1-meta">
+<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Condition">
 []Kubernetes meta/v1.Condition
 </a>
 </em>
@@ -1560,6 +1605,21 @@ Artifact
 <p>Artifact represents the output of the last successful repository sync.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>ReconcileRequestStatus</code><br>
+<em>
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#ReconcileRequestStatus">
+github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>ReconcileRequestStatus</code> are embedded into this type.)
+</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>
diff --git a/docs/spec/v1beta1/buckets.md b/docs/spec/v1beta1/buckets.md
@@ -81,6 +81,11 @@ type BucketStatus struct {
 	// Artifact represents the output of the last successful Bucket sync.
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
+
+	// LastHandledReconcileAt is the last manual reconciliation request (by
+	// annotating the Bucket) handled by the reconciler.
+	// +optional
+	LastHandledReconcileAt string `json:"lastHandledReconcileAt,omitempty"`
 }
 ```
 
diff --git a/docs/spec/v1beta1/gitrepositories.md b/docs/spec/v1beta1/gitrepositories.md
@@ -103,6 +103,11 @@ type GitRepositoryStatus struct {
 	// Artifact represents the output of the last successful repository sync.
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
+
+	// LastHandledReconcileAt is the last manual reconciliation request (by
+	// annotating the GitRepository) handled by the reconciler.
+	// +optional
+	LastHandledReconcileAt string `json:"lastHandledReconcileAt,omitempty"`
 }
 ```
 
diff --git a/docs/spec/v1beta1/helmcharts.md b/docs/spec/v1beta1/helmcharts.md
@@ -77,6 +77,11 @@ type HelmChartStatus struct {
 	// Artifact represents the output of the last successful chart sync.
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
+
+	// LastHandledReconcileAt is the last manual reconciliation request (by
+	// annotating the HelmChart) handled by the reconciler.
+	// +optional
+	LastHandledReconcileAt string `json:"lastHandledReconcileAt,omitempty"`
 }
 ```
 
diff --git a/docs/spec/v1beta1/helmrepositories.md b/docs/spec/v1beta1/helmrepositories.md
@@ -54,6 +54,11 @@ type HelmRepositoryStatus struct {
 	// Artifact represents the output of the last successful repository sync.
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
+
+	// LastHandledReconcileAt is the last manual reconciliation request (by
+	// annotating the HelmRepository) handled by the reconciler.
+	// +optional
+	LastHandledReconcileAt string `json:"lastHandledReconcileAt,omitempty"`
 }
 ```
 
diff --git a/hack/api-docs/config.json b/hack/api-docs/config.json
@@ -11,13 +11,17 @@
       "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$",
       "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"
     },
+    {
+      "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Condition$",
+      "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Condition"
+    },
     {
       "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/",
       "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
     },
     {
-      "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Condition$",
-      "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Condition"
+      "typeMatchPrefix": "^github.com/fluxcd/pkg/apis/meta",
+      "docsURLTemplate": "https://godoc.org/github.com/fluxcd/pkg/apis/meta#{{ .TypeIdentifier }}"
     }
   ],
   "typeDisplayNamePrefixOverrides": {

Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,8 @@ type BucketStatus struct {`
`95`	`95`	`// Artifact represents the output of the last successful Bucket sync.`
`96`	`96`	`// +optional`
`97`	`97`	Artifact *Artifact `json:"artifact,omitempty"`
	`98`	`+`
	`99`	+ meta.ReconcileRequestStatus `json:",inline"`
`98`	`100`	`}`
`99`	`101`
`100`	`102`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,8 @@ type GitRepositoryStatus struct {`
`116`	`116`	`// Artifact represents the output of the last successful repository sync.`
`117`	`117`	`// +optional`
`118`	`118`	Artifact *Artifact `json:"artifact,omitempty"`
	`119`	`+`
	`120`	+ meta.ReconcileRequestStatus `json:",inline"`
`119`	`121`	`}`
`120`	`122`
`121`	`123`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,8 @@ type HelmChartStatus struct {`
`86`	`86`	`// Artifact represents the output of the last successful chart sync.`
`87`	`87`	`// +optional`
`88`	`88`	Artifact *Artifact `json:"artifact,omitempty"`
	`89`	`+`
	`90`	+ meta.ReconcileRequestStatus `json:",inline"`
`89`	`91`	`}`
`90`	`92`
`91`	`93`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,8 @@ type HelmRepositoryStatus struct {`
`73`	`73`	`// Artifact represents the output of the last successful repository sync.`
`74`	`74`	`// +optional`
`75`	`75`	Artifact *Artifact `json:"artifact,omitempty"`
	`76`	`+`
	`77`	+ meta.ReconcileRequestStatus `json:",inline"`
`76`	`78`	`}`
`77`	`79`
`78`	`80`	`const (`