Skip to content

Commit

Permalink
docs/spec: Update the outputs
Browse files Browse the repository at this point in the history
Signed-off-by: Sunny <darkowlzz@protonmail.com>
  • Loading branch information
darkowlzz committed Mar 3, 2022
1 parent 370ce27 commit 132e118
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 21 deletions.
12 changes: 5 additions & 7 deletions docs/spec/v1beta2/buckets.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ control over.
2. Run `kubectl get buckets` to see the Bucket:

```console
NAME ENDPOINT READY STATUS AGE
minio-bucket minio.example.com True stored artifact for revision 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' 34s
NAME ENDPOINT AGE READY STATUS
minio-bucket minio.example.com 34s True stored artifact for revision 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
```

3. Run `kubectl describe bucket minio-bucket` to see the [Artifact](#artifact)
Expand All @@ -98,8 +98,7 @@ control over.
Events:
Type Reason Age From Message
---- ------ ---- ---- -------
Normal BucketOperationSucceed 43s source-controller downloaded 16 files with revision 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' from 'my-minio-bucket'
Normal NewArtifact 43s source-controller stored artifact for revision 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
Normal NewArtifact 82s source-controller fetched 16 files from 'example'
```

## Writing a Bucket spec
Expand Down Expand Up @@ -575,7 +574,7 @@ Status:
...
Conditions:
Last Transition Time: 2022-02-02T13:26:55Z
Message: reconciling new generation 2
Message: reconciling new object generation (2)
Observed Generation: 2
Reason: NewGeneration
Status: True
Expand Down Expand Up @@ -614,8 +613,7 @@ lists

```console
LAST SEEN TYPE REASON OBJECT MESSAGE
2m30s Normal BucketOperationSucceed bucket/<bucket-name> downloaded 16 files with revision 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' from 'my-minio-bucket'
2m30s Normal NewArtifact bucket/<bucket-name> stored artifact for revision 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
2m30s Normal NewArtifact bucket/<bucket-name> fetched 16 files with revision from 'my-new-bucket'
18s Warning BucketOperationFailed bucket/<bucket-name> bucket 'my-new-bucket' does not exist
```

Expand Down
14 changes: 6 additions & 8 deletions docs/spec/v1beta2/gitrepositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ You can run this example by saving the manifest into `gitrepository.yaml`.
2. Run `kubectl get gitrepository` to see the GitRepository:

```console
NAME URL READY STATUS AGE
podinfo https://github.com/stefanprodan/podinfo True stored artifact for revision 'master/132f4e719209eb10b9485302f8593fc0e680f4fc' 5s
NAME URL AGE READY STATUS
podinfo https://github.com/stefanprodan/podinfo 5s True stored artifact for revision 'master/132f4e719209eb10b9485302f8593fc0e680f4fc'
```

3. Run `kubectl describe gitrepository podinfo` to see the [Artifact](#artifact)
Expand All @@ -76,8 +76,7 @@ You can run this example by saving the manifest into `gitrepository.yaml`.
Events:
Type Reason Age From Message
---- ------ ---- ---- -------
Normal GitOperationSucceed 62s source-controller cloned 'https://github.com/stefanprodan/podinfo' and checked out revision 'master/132f4e719209eb10b9485302f8593fc0e680f4fc'
Normal NewArtifact 62s source-controller stored artifact for revision 'master/132f4e719209eb10b9485302f8593fc0e680f4fc'
Normal NewArtifact 62s source-controller stored artifact for commit 'Merge pull request #160 from stefanprodan/release-6.0.3'
```

## Writing a GitRepository spec
Expand Down Expand Up @@ -597,7 +596,7 @@ Status:
...
Conditions:
Last Transition Time: 2022-02-14T09:40:27Z
Message: reconciling new generation 2
Message: reconciling new object generation (2)
Observed Generation: 2
Reason: NewGeneration
Status: True
Expand Down Expand Up @@ -636,9 +635,8 @@ lists

```console
LAST SEEN TYPE REASON OBJECT MESSAGE
2m14s Normal GitOperationSucceed gitrepository/<repository-name> cloned 'https://github.com/stefanprodan/podinfo' and checked out revision 'master/132f4e719209eb10b9485302f8593fc0e680f4fc'
2m14s Normal NewArtifact gitrepository/<repository-name> stored artifact for revision 'master/132f4e719209eb10b9485302f8593fc0e680f4fc'
94s Warning GitOperationFailed gitrepository/gitrepository-sample failed to checkout and determine revision: unable to clone 'https://github.com/stefanprodan/podinfo': couldn't find remote ref "refs/heads/invalid"
2m14s Normal NewArtifact gitrepository/<repository-name> stored artifact for commit 'Merge pull request #160 from stefanprodan/release-6.0.3'
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"
```

Besides being reported in Events, the reconciliation errors are also logged by
Expand Down
4 changes: 2 additions & 2 deletions docs/spec/v1beta2/helmcharts.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ helm-controller.
2. Run `kubectl get helmchart` to see the HelmChart:

```console
NAME CHART VERSION SOURCE KIND SOURCE NAME READY STATUS AGE
podinfo podinfo 5.* HelmRepository podinfo True pulled 'podinfo' chart with version '5.2.1' 53s
NAME CHART VERSION SOURCE KIND SOURCE NAME AGE READY STATUS
podinfo podinfo 5.* HelmRepository podinfo 53s True pulled 'podinfo' chart with version '5.2.1'
```

3. Run `kubectl describe helmchart podinfo` to see the [Artifact](#artifact) and
Expand Down
8 changes: 4 additions & 4 deletions docs/spec/v1beta2/helmrepositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ You can run this example by saving the manifest into `helmrepository.yaml`.
2. Run `kubectl get helmrepository` to see the HelmRepository:

```console
NAME URL READY STATUS AGE
podinfo https://stefanprodan.github.io/podinfo True stored artifact for revision '83a3c595163a6ff0333e0154c790383b5be441b9db632cb36da11db1c4ece111' 4s
NAME URL AGE READY STATUS
podinfo https://stefanprodan.github.io/podinfo 4s True stored artifact for revision '83a3c595163a6ff0333e0154c790383b5be441b9db632cb36da11db1c4ece111'
```

3. Run `kubectl describe helmrepository podinfo` to see the [Artifact](#artifact)
Expand All @@ -74,7 +74,7 @@ You can run this example by saving the manifest into `helmrepository.yaml`.
Events:
Type Reason Age From Message
---- ------ ---- ---- -------
Normal NewArtifact 1m source-controller stored artifact for revision '83a3c595163a6ff0333e0154c790383b5be441b9db632cb36da11db1c4ece111'
Normal NewArtifact 1m source-controller fetched index of size 30.88kB from 'https://stefanprodan.github.io/podinfo'
```

## Writing a HelmRepository spec
Expand Down Expand Up @@ -361,7 +361,7 @@ 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> stored artifact for revision '83a3c595163a6ff0333e0154c790383b5be441b9db632cb36da11db1c4ece111'
7s Normal NewArtifact helmrepository/<repository-name> fetched index of size 30.88kB from 'https://stefanprodan.github.io/podinfo'
```

Besides being reported in Events, the reconciliation errors are also logged by
Expand Down

0 comments on commit 132e118

Please sign in to comment.