fluxcd
/
source-controller
mirror of https://github.com/fluxcd/source-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Update docs with new condition and reasons 

Signed-off-by: Sunny <darkowlzz@protonmail.com>
This commit is contained in:
Sunny 2022-03-14 20:40:38 +05:30
parent a2d6af126d
commit 6830e4e423
No known key found for this signature in database
GPG Key ID: 9F3D25DDFF7FA3CF
4 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/spec/v1beta2/buckets.md
View File

@ -903,17 +903,20 @@ without completing. This can occur due to some of the following factors:
non-existing Secret. non-existing Secret.
- The credentials in the referenced Secret are invalid. - The credentials in the referenced Secret are invalid.
- The Bucket spec contains a generic misconfiguration. - The Bucket spec contains a generic misconfiguration.
- A storage related failure when storing the artifact.
When this happens, the controller sets the `Ready` Condition status to `False`, When this happens, the controller sets the `Ready` Condition status to `False`,
and adds a Condition with the following attributes to the Bucket's and adds a Condition with the following attributes to the Bucket's
`.status.conditions`: `.status.conditions`:
- `type: FetchFailed` - `type: FetchFailed` | `type: StorageOperationFailed`
- `status: "True"` - `status: "True"`
- `reason: AuthenticationFailed` | `reason: BucketOperationFailed` - `reason: AuthenticationFailed` | `reason: BucketOperationFailed`
This condition has a ["negative polarity"][typical-status-properties], This condition has a ["negative polarity"][typical-status-properties],
and is only present on the Bucket while the status value is `"True"`. and is only present on the Bucket while the status value is `"True"`.
There may be more arbitrary values for the `reason` field to provide accurate
reason for a condition.
While the Bucket has this Condition, the controller will continue to attempt While the Bucket has this Condition, the controller will continue to attempt
to produce an Artifact for the resource with an exponential backoff, until to produce an Artifact for the resource with an exponential backoff, until

7
docs/spec/v1beta2/gitrepositories.md
View File

@ -763,17 +763,20 @@ factors:
- The verification of the Git commit signature failed. - The verification of the Git commit signature failed.
- The credentials in the referenced Secret are invalid. - The credentials in the referenced Secret are invalid.
- The GitRepository spec contains a generic misconfiguration. - The GitRepository spec contains a generic misconfiguration.
- A storage related failure when storing the artifact.
When this happens, the controller sets the `Ready` Condition status to `False`, When this happens, the controller sets the `Ready` Condition status to `False`,
and adds a Condition with the following attributes to the GitRepository's and adds a Condition with the following attributes to the GitRepository's
`.status.conditions`: `.status.conditions`:
- `type: FetchFailed` | `type: IncludeUnavailableCondition` - `type: FetchFailed` | `type: IncludeUnavailable` | `type: StorageOperationFailed`
- `status: "True"` - `status: "True"`
- `reason: AuthenticationFailed` | `reason: GitOperationFailed` | `reason: StorageOperationFailed` - `reason: AuthenticationFailed` | `reason: GitOperationFailed`
This condition has a ["negative polarity"][typical-status-properties], This condition has a ["negative polarity"][typical-status-properties],
and is only present on the GitRepository while the status value is `"True"`. and is only present on the GitRepository while the status value is `"True"`.
There may be more arbitrary values for the `reason` field to provide accurate
reason for a condition.
In addition to the above Condition types, when the In addition to the above Condition types, when the
[verification of a Git commit signature](#verification) fails. A condition with [verification of a Git commit signature](#verification) fails. A condition with

5
docs/spec/v1beta2/helmcharts.md
View File

@ -532,17 +532,20 @@ factors:
- The credentials in the [Source reference](#source-reference) Secret are - The credentials in the [Source reference](#source-reference) Secret are
invalid. invalid.
- The HelmChart spec contains a generic misconfiguration. - The HelmChart spec contains a generic misconfiguration.
- A storage related failure when storing the artifact.
When this happens, the controller sets the `Ready` Condition status to `False`, When this happens, the controller sets the `Ready` Condition status to `False`,
and adds a Condition with the following attributes to the HelmChart's and adds a Condition with the following attributes to the HelmChart's
`.status.conditions`: `.status.conditions`:
- `type: FetchFailed` - `type: FetchFailed` | `type: StorageOperationFailed`
- `status: "True"` - `status: "True"`
- `reason: AuthenticationFailed` | `reason: StorageOperationFailed` | `reason: URLInvalid` | `reason: IllegalPath` | `reason: Failed` - `reason: AuthenticationFailed` | `reason: StorageOperationFailed` | `reason: URLInvalid` | `reason: IllegalPath` | `reason: Failed`
This condition has a ["negative polarity"][typical-status-properties], This condition has a ["negative polarity"][typical-status-properties],
and is only present on the HelmChart while the status value is `"True"`. and is only present on the HelmChart while the status value is `"True"`.
There may be more arbitrary values for the `reason` field to provide accurate
reason for a condition.
While the HelmChart has this Condition, the controller will continue to While the HelmChart has this Condition, the controller will continue to
attempt to produce an Artifact for the resource with an exponential backoff, attempt to produce an Artifact for the resource with an exponential backoff,

5
docs/spec/v1beta2/helmrepositories.md
View File

@ -475,17 +475,20 @@ factors:
non-existing Secret. non-existing Secret.
- The credentials in the referenced Secret are invalid. - The credentials in the referenced Secret are invalid.
- The HelmRepository spec contains a generic misconfiguration. - The HelmRepository spec contains a generic misconfiguration.
- A storage related failure when storing the artifact.
When this happens, the controller sets the `Ready` Condition status to `False`, When this happens, the controller sets the `Ready` Condition status to `False`,
and adds a Condition with the following attributes to the HelmRepository's and adds a Condition with the following attributes to the HelmRepository's
`.status.conditions`: `.status.conditions`:
- `type: FetchFailed` - `type: FetchFailed` | `type: StorageOperationFailed`
- `status: "True"` - `status: "True"`
- `reason: AuthenticationFailed` | `reason: IndexationFailed` | `reason: Failed` - `reason: AuthenticationFailed` | `reason: IndexationFailed` | `reason: Failed`
This condition has a ["negative polarity"][typical-status-properties], This condition has a ["negative polarity"][typical-status-properties],
and is only present on the HelmRepository while the status value is `"True"`. and is only present on the HelmRepository while the status value is `"True"`.
There may be more arbitrary values for the `reason` field to provide accurate
reason for a condition.
While the HelmRepository has this Condition, the controller will continue to While the HelmRepository has this Condition, the controller will continue to
attempt to produce an Artifact for the resource with an exponential backoff, attempt to produce an Artifact for the resource with an exponential backoff,