Skip to content

Commit a91e37d

Browse files
committed
update docs with progressive status
Signed-off-by: Sunny <darkowlzz@protonmail.com>
1 parent 77b34b0 commit a91e37d

File tree

5 files changed

+42
-27
lines changed

5 files changed

+42
-27
lines changed

docs/spec/v1beta2/buckets.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -866,9 +866,9 @@ Status:
866866
...
867867
Conditions:
868868
Last Transition Time: 2022-02-02T13:26:55Z
869-
Message: reconciling new object generation (2)
869+
Message: processing object: new generation 1 -> 2
870870
Observed Generation: 2
871-
Reason: NewGeneration
871+
Reason: ProgressingWithRetry
872872
Status: True
873873
Type: Reconciling
874874
Last Transition Time: 2022-02-02T13:26:55Z
@@ -978,13 +978,13 @@ is true:
978978
- The generation of the Bucket is newer than the [Observed Generation](#observed-generation).
979979
- The newly calculated Artifact revision differs from the current Artifact.
980980

981-
When the Bucket is "reconciling", the `Ready` Condition status becomes `False`,
982-
and the controller adds a Condition with the following attributes to the
983-
Bucket's `.status.conditions`:
981+
When the Bucket is "reconciling", the `Ready` Condition status becomes
982+
`Unknown` when the controller detects drift, and the controller adds a Condition
983+
with the following attributes to the Bucket's `.status.conditions`:
984984

985985
- `type: Reconciling`
986986
- `status: "True"`
987-
- `reason: NewGeneration` | `reason: NoArtifact` | `reason: NewRevision`
987+
- `reason: Progressing` | `reason: ProgressingWithRetry`
988988

989989
If the reconciling state is due to a new revision, an additional Condition is
990990
added with the following attributes:
@@ -1062,7 +1062,9 @@ it succeeds and the Bucket is marked as [ready](#ready-bucket).
10621062

10631063
Note that a Bucket can be [reconciling](#reconciling-bucket) while failing at
10641064
the same time, for example due to a newly introduced configuration issue in the
1065-
Bucket spec.
1065+
Bucket spec. When a reconciliation fails, the `Reconciling` Condition reason
1066+
would be `ProgressingWithRetry`. When the reconciliation is performed again
1067+
after the failure, the reason is updated to `Progressing`.
10661068

10671069
### Observed Ignore
10681070

docs/spec/v1beta2/gitrepositories.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -610,9 +610,9 @@ Status:
610610
...
611611
Conditions:
612612
Last Transition Time: 2022-02-14T09:40:27Z
613-
Message: reconciling new object generation (2)
613+
Message: processing object: new generation 1 -> 2
614614
Observed Generation: 2
615-
Reason: NewGeneration
615+
Reason: ProgressingWithRetry
616616
Status: True
617617
Type: Reconciling
618618
Last Transition Time: 2022-02-14T09:40:27Z
@@ -724,12 +724,13 @@ following is true:
724724
- The newly resolved Artifact revision differs from the current Artifact.
725725

726726
When the GitRepository is "reconciling", the `Ready` Condition status becomes
727-
`False`, and the controller adds a Condition with the following attributes to
728-
the GitRepository's `.status.conditions`:
727+
`Unknown` when the controller detects drift, and the controller adds a Condition
728+
with the following attributes to the GitRepository's
729+
`.status.conditions`:
729730

730731
- `type: Reconciling`
731732
- `status: "True"`
732-
- `reason: NewGeneration` | `reason: NoArtifact` | `reason: NewRevision`
733+
- `reason: Progressing` | `reason: ProgressingWithRetry`
733734

734735
If the reconciling state is due to a new revision, an additional Condition is
735736
added with the following attributes:
@@ -819,7 +820,10 @@ exponential backoff, until it succeeds and the GitRepository is marked as
819820

820821
Note that a GitRepository can be [reconciling](#reconciling-gitrepository)
821822
while failing at the same time, for example due to a newly introduced
822-
configuration issue in the GitRepository spec.
823+
configuration issue in the GitRepository spec. When a reconciliation fails, the
824+
`Reconciling` Condition reason would be `ProgressingWithRetry`. When the
825+
reconciliation is performed again after the failure, the reason is updated to
826+
`Progressing`.
823827

824828
### Content Configuration Checksum
825829

docs/spec/v1beta2/helmcharts.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -633,12 +633,12 @@ following is true:
633633
- The newly fetched Artifact revision differs from the current Artifact.
634634

635635
When the HelmChart is "reconciling", the `Ready` Condition status becomes
636-
`False`, and the controller adds a Condition with the following attributes to
637-
the HelmChart's `.status.conditions`:
636+
`Unknown` when the controller detects drift, and the controller adds a Condition
637+
with the following attributes to the HelmChart's `.status.conditions`:
638638

639639
- `type: Reconciling`
640640
- `status: "True"`
641-
- `reason: NewGeneration` | `reason: NoArtifact`
641+
- `reason: Progressing` | `reason: ProgressingWithRetry`
642642

643643
If the reconciling state is due to a new version, it adds an additional
644644
Condition with the following attributes:
@@ -715,7 +715,10 @@ until it succeeds and the HelmChart is marked as [ready](#ready-helmchart).
715715

716716
Note that a HelmChart can be [reconciling](#reconciling-helmchart)
717717
while failing at the same time, for example due to a newly introduced
718-
configuration issue in the HelmChart spec.
718+
configuration issue in the HelmChart spec. When a reconciliation fails, the
719+
`Reconciling` Condition reason would be `ProgressingWithRetry`. When the
720+
reconciliation is performed again after the failure, the reason is updated to
721+
`Progressing`.
719722

720723
#### Stalled HelmChart
721724

docs/spec/v1beta2/helmrepositories.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -676,12 +676,12 @@ is true:
676676
- The newly fetched Artifact revision differs from the current Artifact.
677677

678678
When the HelmRepository is "reconciling", the `Ready` Condition status becomes
679-
`False`, and the controller adds a Condition with the following attributes to
680-
the HelmRepository's `.status.conditions`:
679+
`Unknown` when the controller detects drift, and the controller adds a Condition
680+
with the following attributes to the HelmRepository's `.status.conditions`:
681681

682682
- `type: Reconciling`
683683
- `status: "True"`
684-
- `reason: NewGeneration` | `reason: NoArtifact` | `reason: NewRevision`
684+
- `reason: Progressing` | `reason: ProgressingWithRetry`
685685

686686
If the reconciling state is due to a new revision, it adds an additional
687687
Condition with the following attributes:
@@ -760,7 +760,10 @@ until it succeeds and the HelmRepository is marked as [ready](#ready-helmreposit
760760

761761
Note that a HelmRepository can be [reconciling](#reconciling-helmrepository)
762762
while failing at the same time, for example due to a newly introduced
763-
configuration issue in the HelmRepository spec.
763+
configuration issue in the HelmRepository spec. When a reconciliation fails, the
764+
`Reconciling` Condition reason would be `ProgressingWithRetry`. When the
765+
reconciliation is performed again after the failure, the reason is updated to
766+
`Progressing`.
764767

765768
#### Stalled HelmRepository
766769

docs/spec/v1beta2/ocirepositories.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -642,9 +642,9 @@ Status:
642642
...
643643
Conditions:
644644
Last Transition Time: 2022-02-14T09:40:27Z
645-
Message: reconciling new object generation (2)
645+
Message: processing object: new generation 1 -> 2
646646
Observed Generation: 2
647-
Reason: NewGeneration
647+
Reason: ProgressingWithRetry
648648
Status: True
649649
Type: Reconciling
650650
Last Transition Time: 2022-02-14T09:40:27Z
@@ -769,12 +769,12 @@ following is true:
769769
- The newly resolved Artifact digest differs from the current Artifact.
770770

771771
When the OCIRepository is "reconciling", the `Ready` Condition status becomes
772-
`False`, and the controller adds a Condition with the following attributes to
773-
the OCIRepository's `.status.conditions`:
772+
`Unknown` when the controller detects drift, and the controller adds a Condition
773+
with the following attributes to the OCIRepository's `.status.conditions`:
774774

775775
- `type: Reconciling`
776776
- `status: "True"`
777-
- `reason: NewGeneration` | `reason: NoArtifact` | `reason: NewRevision`
777+
- `reason: Progressing` | `reason: ProgressingWithRetry`
778778

779779
If the reconciling state is due to a new revision, an additional Condition is
780780
added with the following attributes:
@@ -862,7 +862,10 @@ exponential backoff, until it succeeds and the OCIRepository is marked as
862862

863863
Note that a OCIRepository can be [reconciling](#reconciling-ocirepository)
864864
while failing at the same time, for example due to a newly introduced
865-
configuration issue in the OCIRepository spec.
865+
configuration issue in the OCIRepository spec. When a reconciliation fails, the
866+
`Reconciling` Condition reason would be `ProgressingWithRetry`. When the
867+
reconciliation is performed again after the failure, the reason is updated to
868+
`Progressing`.
866869

867870
### Content Configuration Checksum
868871

0 commit comments

Comments
 (0)