update docs with progressive status

Signed-off-by: Sunny <darkowlzz@protonmail.com>
fluxcd · Jan 9, 2023 · 197a03b · 197a03b
1 parent 7b44c9d
commit 197a03b
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 27 deletions.
diff --git a/docs/spec/v1beta2/buckets.md b/docs/spec/v1beta2/buckets.md
@@ -866,9 +866,9 @@ Status:
 ...
   Conditions:
     Last Transition Time:  2022-02-02T13:26:55Z
-    Message:               reconciling new object generation (2)
+    Message:               processing object: new generation 1 -> 2
     Observed Generation:   2
-    Reason:                NewGeneration
+    Reason:                ProgressingWithRetry
     Status:                True
     Type:                  Reconciling
     Last Transition Time:  2022-02-02T13:26:55Z
@@ -978,13 +978,13 @@ is true:
 - The generation of the Bucket is newer than the [Observed Generation](#observed-generation).
 - The newly calculated Artifact revision differs from the current Artifact.
 
-When the Bucket is "reconciling", the `Ready` Condition status becomes `False`,
-and the controller adds a Condition with the following attributes to the
-Bucket's `.status.conditions`:
+When the Bucket is "reconciling", the `Ready` Condition status becomes
+`Unknown` when the controller detects drift, and the controller adds a Condition
+with the following attributes to the Bucket's `.status.conditions`:
 
 - `type: Reconciling`
 - `status: "True"`
-- `reason: NewGeneration` | `reason: NoArtifact` | `reason: NewRevision`
+- `reason: Progressing` | `reason: ProgressingWithRetry`
 
 If the reconciling state is due to a new revision, an additional Condition is
 added with the following attributes:
@@ -1062,7 +1062,9 @@ it succeeds and the Bucket is marked as [ready](#ready-bucket).
 
 Note that a Bucket can be [reconciling](#reconciling-bucket) while failing at
 the same time, for example due to a newly introduced configuration issue in the
-Bucket spec.
+Bucket spec. When a reconciliation fails, the `Reconciling` Condition reason
+would be `ProgressingWithRetry`. When the reconciliation is performed again
+after the failure, the reason is updated to `Progressing`.
 
 ### Observed Ignore
 

diff --git a/docs/spec/v1beta2/gitrepositories.md b/docs/spec/v1beta2/gitrepositories.md
@@ -610,9 +610,9 @@ Status:
 ...
   Conditions:
     Last Transition Time:  2022-02-14T09:40:27Z
-    Message:               reconciling new object generation (2)
+    Message:               processing object: new generation 1 -> 2
     Observed Generation:   2
-    Reason:                NewGeneration
+    Reason:                ProgressingWithRetry
     Status:                True
     Type:                  Reconciling
     Last Transition Time:  2022-02-14T09:40:27Z
@@ -724,12 +724,13 @@ following is true:
 - The newly resolved Artifact revision differs from the current Artifact.
 
 When the GitRepository is "reconciling", the `Ready` Condition status becomes
-`False`, and the controller adds a Condition with the following attributes to
-the GitRepository's `.status.conditions`:
+`Unknown` when the controller detects drift, and the controller adds a Condition
+with the following attributes to the GitRepository's
+`.status.conditions`:
 
 - `type: Reconciling`
 - `status: "True"`
-- `reason: NewGeneration` | `reason: NoArtifact` | `reason: NewRevision`
+- `reason: Progressing` | `reason: ProgressingWithRetry`
 
 If the reconciling state is due to a new revision, an additional Condition is
 added with the following attributes:
@@ -819,7 +820,10 @@ exponential backoff, until it succeeds and the GitRepository is marked as
 
 Note that a GitRepository can be [reconciling](#reconciling-gitrepository)
 while failing at the same time, for example due to a newly introduced
-configuration issue in the GitRepository spec.
+configuration issue in the GitRepository spec. When a reconciliation fails, the
+`Reconciling` Condition reason would be `ProgressingWithRetry`. When the
+reconciliation is performed again after the failure, the reason is updated to
+`Progressing`.
 
 ### Content Configuration Checksum
 

diff --git a/docs/spec/v1beta2/helmcharts.md b/docs/spec/v1beta2/helmcharts.md
@@ -633,12 +633,12 @@ following is true:
 - The newly fetched Artifact revision differs from the current Artifact.
 
 When the HelmChart is "reconciling", the `Ready` Condition status becomes
-`False`, and the controller adds a Condition with the following attributes to
-the HelmChart's `.status.conditions`:
+`Unknown` when the controller detects drift, and the controller adds a Condition
+with the following attributes to the HelmChart's `.status.conditions`:
 
 - `type: Reconciling`
 - `status: "True"`
-- `reason: NewGeneration` | `reason: NoArtifact`
+- `reason: Progressing` | `reason: ProgressingWithRetry`
 
 If the reconciling state is due to a new version, it adds an additional
 Condition with the following attributes:
@@ -715,7 +715,10 @@ until it succeeds and the HelmChart is marked as [ready](#ready-helmchart).
 
 Note that a HelmChart can be [reconciling](#reconciling-helmchart)
 while failing at the same time, for example due to a newly introduced
-configuration issue in the HelmChart spec.
+configuration issue in the HelmChart spec. When a reconciliation fails, the
+`Reconciling` Condition reason would be `ProgressingWithRetry`. When the
+reconciliation is performed again after the failure, the reason is updated to
+`Progressing`.
 
 #### Stalled HelmChart
 

diff --git a/docs/spec/v1beta2/helmrepositories.md b/docs/spec/v1beta2/helmrepositories.md
@@ -676,12 +676,12 @@ is true:
 - The newly fetched Artifact revision differs from the current Artifact.
 
 When the HelmRepository is "reconciling", the `Ready` Condition status becomes
-`False`, and the controller adds a Condition with the following attributes to
-the HelmRepository's `.status.conditions`:
+`Unknown` when the controller detects drift, and the controller adds a Condition
+with the following attributes to the HelmRepository's `.status.conditions`:
 
 - `type: Reconciling`
 - `status: "True"`
-- `reason: NewGeneration` | `reason: NoArtifact` | `reason: NewRevision`
+- `reason: Progressing` | `reason: ProgressingWithRetry`
 
 If the reconciling state is due to a new revision, it adds an additional
 Condition with the following attributes:
@@ -760,7 +760,10 @@ until it succeeds and the HelmRepository is marked as [ready](#ready-helmreposit
 
 Note that a HelmRepository can be [reconciling](#reconciling-helmrepository)
 while failing at the same time, for example due to a newly introduced
-configuration issue in the HelmRepository spec.
+configuration issue in the HelmRepository spec. When a reconciliation fails, the
+`Reconciling` Condition reason would be `ProgressingWithRetry`. When the
+reconciliation is performed again after the failure, the reason is updated to
+`Progressing`.
 
 #### Stalled HelmRepository
 

diff --git a/docs/spec/v1beta2/ocirepositories.md b/docs/spec/v1beta2/ocirepositories.md
@@ -642,9 +642,9 @@ Status:
 ...
   Conditions:
     Last Transition Time:  2022-02-14T09:40:27Z
-    Message:               reconciling new object generation (2)
+    Message:               processing object: new generation 1 -> 2
     Observed Generation:   2
-    Reason:                NewGeneration
+    Reason:                ProgressingWithRetry
     Status:                True
     Type:                  Reconciling
     Last Transition Time:  2022-02-14T09:40:27Z
@@ -769,12 +769,12 @@ following is true:
 - The newly resolved Artifact digest differs from the current Artifact.
 
 When the OCIRepository is "reconciling", the `Ready` Condition status becomes
-`False`, and the controller adds a Condition with the following attributes to
-the OCIRepository's `.status.conditions`:
+`Unknown` when the controller detects drift, and the controller adds a Condition
+with the following attributes to the OCIRepository's `.status.conditions`:
 
 - `type: Reconciling`
 - `status: "True"`
-- `reason: NewGeneration` | `reason: NoArtifact` | `reason: NewRevision`
+- `reason: Progressing` | `reason: ProgressingWithRetry`
 
 If the reconciling state is due to a new revision, an additional Condition is
 added with the following attributes:
@@ -862,7 +862,10 @@ exponential backoff, until it succeeds and the OCIRepository is marked as
 
 Note that a OCIRepository can be [reconciling](#reconciling-ocirepository)
 while failing at the same time, for example due to a newly introduced
-configuration issue in the OCIRepository spec.
+configuration issue in the OCIRepository spec. When a reconciliation fails, the
+`Reconciling` Condition reason would be `ProgressingWithRetry`. When the
+reconciliation is performed again after the failure, the reason is updated to
+`Progressing`.
 
 ### Content Configuration Checksum