Add awesome example (#24)

Signed-off-by: Jacob Tomlinson <[email protected]>

Author: jacobtomlinson

README.md

@@ -7,11 +7,11 @@
 A little bird to validate your container images.
 
 ```console
-$ canary validate --file somespec.yaml foo/bar:latest
-Validating foo/bar:latest against somespec
- 📦 Required packages are installed                  [true]
- 🤖 Expected services are running                    [true]
- 🎉 Your container is awesome                        [true]
+$ canary validate --file examples/awesome.yaml your/container:latest
+Validating your/container:latest against awesome
+ 📦 Required packages are installed                  [passed]
+ 🤖 Expected services are running                    [passed]
+ 🎉 Your container is awesome                        [passed]
 validation passed
 ```
 

examples/awesome.yaml

@@ -0,0 +1,35 @@
+apiVersion: container-canary.nvidia.com/v1
+kind: Validator
+name: awesome
+description: A dummy example to show all containers are awesome
+command:
+- "sleep"
+- "30"
+checks:
+  - name: packages
+    description: 📦 Required packages are installed
+    probe:
+      exec:
+        command:
+          - /bin/sh
+          - -c
+          - "true"
+      initialDelaySeconds: 1
+  - name: services
+    description: 🤖 Expected services are running
+    probe:
+      exec:
+        command:
+          - /bin/sh
+          - -c
+          - "true"
+      initialDelaySeconds: 2
+  - name: awesome
+    description: 🎉 Your container is awesome
+    probe:
+      exec:
+        command:
+          - /bin/sh
+          - -c
+          - "true"
+      initialDelaySeconds: 3