Update docs with new conditions and events

Signed-off-by: Sunny <darkowlzz@protonmail.com>
fluxcd · Mar 29, 2022 · f78a225 · f78a225
1 parent 581a1fa
commit f78a225
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 3 deletions.
diff --git a/docs/spec/v1beta2/buckets.md b/docs/spec/v1beta2/buckets.md
@@ -93,6 +93,12 @@ control over.
        Reason:                Succeeded
        Status:                True
        Type:                  Ready
+       Last Transition Time:  2022-02-01T23:43:38Z
+       Message:               stored artifact for revision 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
+       Observed Generation:   1
+       Reason:                Succeeded
+       Status:                True
+       Type:                  ArtifactInStorage
      Observed Generation:     1
      URL:                     http://source-controller.source-system.svc.cluster.local./bucket/default/minio-bucket/latest.tar.gz
    Events:
@@ -780,6 +786,7 @@ lists
 ```console
 LAST SEEN   TYPE      REASON                       OBJECT                 MESSAGE
 2m30s       Normal    NewArtifact                  bucket/<bucket-name>   fetched 16 files with revision from 'my-new-bucket'
+36s         Normal    ArtifactUpToDate             bucket/<bucket-name>   artifact up-to-date with remote revision: 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
 18s         Warning   BucketOperationFailed        bucket/<bucket-name>   bucket 'my-new-bucket' does not exist
 ```
 
@@ -892,6 +899,17 @@ This `Ready` Condition will retain a status value of `"True"` until the Bucket
 is marked as [reconciling](#reconciling-bucket), or e.g. a
 [transient error](#failed-bucket) occurs due to a temporary network issue.
 
+When the Bucket Artifact is archived in the controller's Artifact
+storage, the controller sets a Condition with the following attributes in the
+Bucket's `.status.conditions`:
+
+- `type: ArtifactInStorage`
+- `status: "True"`
+- `reason: Succeeded`
+
+This `ArtifactInStorage` Condition will retain a status value of `"True"` until
+the Artifact in the storage no longer exists.
+
 #### Failed Bucket
 
 The source-controller may get stuck trying to produce an Artifact for a Bucket

diff --git a/docs/spec/v1beta2/gitrepositories.md b/docs/spec/v1beta2/gitrepositories.md
@@ -71,6 +71,12 @@ You can run this example by saving the manifest into `gitrepository.yaml`.
        Reason:                Succeeded
        Status:                True
        Type:                  Ready
+       Last Transition Time:  2022-02-14T11:23:36Z
+       Message:               stored artifact for revision 'master/132f4e719209eb10b9485302f8593fc0e680f4fc'
+       Observed Generation:   1
+       Reason:                Succeeded
+       Status:                True
+       Type:                  ArtifactInStorage
      Observed Generation:     1
      URL:                     http://source-controller.source-system.svc.cluster.local./gitrepository/default/podinfo/latest.tar.gz
    Events:
@@ -647,6 +653,7 @@ lists
 ```console
 LAST SEEN   TYPE     REASON                OBJECT                               MESSAGE
 2m14s       Normal   NewArtifact           gitrepository/<repository-name>      stored artifact for commit 'Merge pull request #160 from stefanprodan/release-6.0.3'
+36s         Normal   ArtifactUpToDate      gitrepository/<repository-name>      artifact up-to-date with remote revision: 'master/132f4e719209eb10b9485302f8593fc0e680f4fc'
 94s         Warning  GitOperationFailed    gitrepository/<repository-name>      failed to checkout and determine revision: unable to clone 'https://github.com/stefanprodan/podinfo': couldn't find remote ref "refs/heads/invalid"
 ```
 
@@ -760,6 +767,17 @@ This `Ready` Condition will retain a status value of `"True"` until the
 GitRepository is marked as [reconciling](#reconciling-gitrepository), or e.g. a
 [transient error](#failed-gitrepository) occurs due to a temporary network issue.
 
+When the GitRepository Artifact is archived in the controller's Artifact
+storage, the controller sets a Condition with the following attributes in the
+GitRepository's `.status.conditions`:
+
+- `type: ArtifactInStorage`
+- `status: "True"`
+- `reason: Succeeded`
+
+This `ArtifactInStorage` Condition will retain a status value of `"True"` until
+the Artifact in the storage no longer exists.
+
 #### Failed GitRepository
 
 The source-controller may get stuck trying to produce an Artifact for a

diff --git a/docs/spec/v1beta2/helmcharts.md b/docs/spec/v1beta2/helmcharts.md
@@ -79,6 +79,12 @@ helm-controller.
        Reason:                ChartPullSucceeded
        Status:                True
        Type:                  Ready
+       Last Transition Time:  2022-02-13T11:24:10Z
+       Message:               pulled 'podinfo' chart with version '5.2.1'
+       Observed Generation:   1
+       Reason:                ChartPullSucceeded
+       Status:                True
+       Type:                  ArtifactInStorage
      Observed Chart Name:     podinfo
      Observed Generation:     1
      URL:                     http://source-controller.flux-system.svc.cluster.local./helmchart/default/podinfo/latest.tar.gz
@@ -377,6 +383,7 @@ lists
 LAST SEEN   TYPE      REASON                       OBJECT                   MESSAGE
 22s         Warning   InvalidChartReference        helmchart/<chart-name>   invalid chart reference: failed to get chart version for remote reference: no 'podinfo' chart with version matching '9.*' found
 2s          Normal    ChartPullSucceeded           helmchart/<chart-name>   pulled 'podinfo' chart with version '6.0.3'
+2s          Normal    ArtifactUpToDate             helmchart/<chart-name>   artifact up-to-date with remote revision: '6.0.3'
 ```
 
 Besides being reported in Events, the reconciliation errors are also logged by
@@ -522,6 +529,17 @@ This `Ready` Condition will retain a status value of `"True"` until the
 HelmChart is marked as [reconciling](#reconciling-helmchart), or e.g.
 a [transient error](#failed-helmchart) occurs due to a temporary network issue.
 
+When the HelmChart Artifact is archived in the controller's Artifact
+storage, the controller sets a Condition with the following attributes in the
+HelmChart's `.status.conditions`:
+
+- `type: ArtifactInStorage`
+- `status: "True"`
+- `reason: Succeeded`
+
+This `ArtifactInStorage` Condition will retain a status value of `"True"` until
+the Artifact in the storage no longer exists.
+
 #### Failed HelmChart
 
 The source-controller may get stuck trying to produce an Artifact for a

diff --git a/docs/spec/v1beta2/helmrepositories.md b/docs/spec/v1beta2/helmrepositories.md
@@ -69,6 +69,12 @@ You can run this example by saving the manifest into `helmrepository.yaml`.
        Reason:                Succeeded
        Status:                True
        Type:                  Ready
+       Last Transition Time:  2022-02-04T09:55:58Z
+       Message:               stored artifact for revision '83a3c595163a6ff0333e0154c790383b5be441b9db632cb36da11db1c4ece111'
+       Observed Generation:   1
+       Reason:                Succeeded
+       Status:                True
+       Type:                  ArtifactInStorage
      Observed Generation:     1
      URL:                     http://source-controller.flux-system.svc.cluster.local./helmrepository/default/podinfo/index.yaml
    Events:
@@ -359,9 +365,10 @@ kubectl get events --field-selector involvedObject.kind=HelmRepository,involvedO
 lists
 
 ```console
-LAST SEEN   TYPE      REASON        OBJECT                             MESSAGE
-107s        Warning   Failed        helmrepository/<repository-name>   failed to construct Helm client: scheme "invalid" not supported
-7s          Normal    NewArtifact   helmrepository/<repository-name>   fetched index of size 30.88kB from 'https://stefanprodan.github.io/podinfo'
+LAST SEEN   TYPE      REASON           OBJECT                             MESSAGE
+107s        Warning   Failed           helmrepository/<repository-name>   failed to construct Helm client: scheme "invalid" not supported
+7s          Normal    NewArtifact      helmrepository/<repository-name>   fetched index of size 30.88kB from 'https://stefanprodan.github.io/podinfo'
+3s          Normal    ArtifactUpToDate helmrepository/<repository-name>   artifact up-to-date with remote revision: '83a3c595163a6ff0333e0154c790383b5be441b9db632cb36da11db1c4ece111'
 ```
 
 Besides being reported in Events, the reconciliation errors are also logged by
@@ -464,6 +471,17 @@ HelmRepository is marked as [reconciling](#reconciling-helmrepository), or e.g.
 a [transient error](#failed-helmrepository) occurs due to a temporary network
 issue.
 
+When the HelmRepository Artifact is archived in the controller's Artifact
+storage, the controller sets a Condition with the following attributes in the
+HelmRepository's `.status.conditions`:
+
+- `type: ArtifactInStorage`
+- `status: "True"`
+- `reason: Succeeded`
+
+This `ArtifactInStorage` Condition will retain a status value of `"True"` until
+the Artifact in the storage no longer exists.
+
 #### Failed HelmRepository
 
 The source-controller may get stuck trying to produce an Artifact for a