Skip to content

Commit 8b39c7f

Browse files
authored
chore: add an example for check command
1 parent cfe1982 commit 8b39c7f

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,31 @@ inspect cluster [--namespace mynamespace]
9999
inspect diff-namespace staging production
100100
```
101101

102+
### To check that an image contains all recommended labels
103+
104+
```
105+
inspect check <image>
106+
```
107+
108+
e.g.
109+
110+
```
111+
inspect check garethjevans/inspect:0.0.9
112+
+-----------------------------------+---------+---------------------------------------------------------------------+
113+
| LABEL | OK | RECOMMENDATION |
114+
+-----------------------------------+---------+---------------------------------------------------------------------+
115+
| org.opencontainers.image.created | OK | |
116+
| org.opencontainers.image.revision | OK | |
117+
| org.opencontainers.image.source | OK | |
118+
| org.opencontainers.image.url | OK | |
119+
| org.label-schema.build-date | OK | |
120+
| org.label-schema.vcs-ref | OK | |
121+
| org.label-schema.vcs-url | OK | |
122+
| org.label-schema.url | OK | |
123+
| inspect.tree.state | Missing | test -z "$(git status --porcelain)" && echo "clean" || echo "dirty" |
124+
+-----------------------------------+---------+---------------------------------------------------------------------+
125+
```
126+
102127
## Documentation
103128

104129
More indepth documentaion can be found [here](./docs/inspect.md)

0 commit comments

Comments
 (0)