Skip to content

Commit 5270455

Browse files
committed
docs: Update docs with new condition and reasons
Signed-off-by: Sunny <[email protected]>
1 parent 882a85b commit 5270455

File tree

4 files changed

+17
-5
lines changed

4 files changed

+17
-5
lines changed

docs/spec/v1beta2/buckets.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -903,17 +903,20 @@ without completing. This can occur due to some of the following factors:
903903
non-existing Secret.
904904
- The credentials in the referenced Secret are invalid.
905905
- The Bucket spec contains a generic misconfiguration.
906+
- A storage related failure when storing the artifact.
906907

907908
When this happens, the controller sets the `Ready` Condition status to `False`,
908909
and adds a Condition with the following attributes to the Bucket's
909910
`.status.conditions`:
910911

911-
- `type: FetchFailed`
912+
- `type: FetchFailed` | `type: StorageOperationFailed`
912913
- `status: "True"`
913914
- `reason: AuthenticationFailed` | `reason: BucketOperationFailed`
914915

915916
This condition has a ["negative polarity"][typical-status-properties],
916917
and is only present on the Bucket while the status value is `"True"`.
918+
There may be more arbitrary values for the `reason` field to provide accurate
919+
reason for a condition.
917920

918921
While the Bucket has this Condition, the controller will continue to attempt
919922
to produce an Artifact for the resource with an exponential backoff, until

docs/spec/v1beta2/gitrepositories.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -763,17 +763,20 @@ factors:
763763
- The verification of the Git commit signature failed.
764764
- The credentials in the referenced Secret are invalid.
765765
- The GitRepository spec contains a generic misconfiguration.
766+
- A storage related failure when storing the artifact.
766767

767768
When this happens, the controller sets the `Ready` Condition status to `False`,
768769
and adds a Condition with the following attributes to the GitRepository's
769770
`.status.conditions`:
770771

771-
- `type: FetchFailed` | `type: IncludeUnavailableCondition`
772+
- `type: FetchFailed` | `type: IncludeUnavailable` | `type: StorageOperationFailed`
772773
- `status: "True"`
773-
- `reason: AuthenticationFailed` | `reason: GitOperationFailed` | `reason: StorageOperationFailed`
774+
- `reason: AuthenticationFailed` | `reason: GitOperationFailed`
774775

775776
This condition has a ["negative polarity"][typical-status-properties],
776777
and is only present on the GitRepository while the status value is `"True"`.
778+
There may be more arbitrary values for the `reason` field to provide accurate
779+
reason for a condition.
777780

778781
In addition to the above Condition types, when the
779782
[verification of a Git commit signature](#verification) fails. A condition with

docs/spec/v1beta2/helmcharts.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -532,17 +532,20 @@ factors:
532532
- The credentials in the [Source reference](#source-reference) Secret are
533533
invalid.
534534
- The HelmChart spec contains a generic misconfiguration.
535+
- A storage related failure when storing the artifact.
535536

536537
When this happens, the controller sets the `Ready` Condition status to `False`,
537538
and adds a Condition with the following attributes to the HelmChart's
538539
`.status.conditions`:
539540

540-
- `type: FetchFailed`
541+
- `type: FetchFailed` | `type: StorageOperationFailed`
541542
- `status: "True"`
542543
- `reason: AuthenticationFailed` | `reason: StorageOperationFailed` | `reason: URLInvalid` | `reason: IllegalPath` | `reason: Failed`
543544

544545
This condition has a ["negative polarity"][typical-status-properties],
545546
and is only present on the HelmChart while the status value is `"True"`.
547+
There may be more arbitrary values for the `reason` field to provide accurate
548+
reason for a condition.
546549

547550
While the HelmChart has this Condition, the controller will continue to
548551
attempt to produce an Artifact for the resource with an exponential backoff,

docs/spec/v1beta2/helmrepositories.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,17 +475,20 @@ factors:
475475
non-existing Secret.
476476
- The credentials in the referenced Secret are invalid.
477477
- The HelmRepository spec contains a generic misconfiguration.
478+
- A storage related failure when storing the artifact.
478479

479480
When this happens, the controller sets the `Ready` Condition status to `False`,
480481
and adds a Condition with the following attributes to the HelmRepository's
481482
`.status.conditions`:
482483

483-
- `type: FetchFailed`
484+
- `type: FetchFailed` | `type: StorageOperationFailed`
484485
- `status: "True"`
485486
- `reason: AuthenticationFailed` | `reason: IndexationFailed` | `reason: Failed`
486487

487488
This condition has a ["negative polarity"][typical-status-properties],
488489
and is only present on the HelmRepository while the status value is `"True"`.
490+
There may be more arbitrary values for the `reason` field to provide accurate
491+
reason for a condition.
489492

490493
While the HelmRepository has this Condition, the controller will continue to
491494
attempt to produce an Artifact for the resource with an exponential backoff,

0 commit comments

Comments
 (0)