Update manifests.md (#27)

* updated manifests.md Signed-off-by: Andy Clemenko <[email protected]> * apply suggestions from code review Co-authored-by: Zack Brady <[email protected]> Signed-off-by: Andy Clemenko <[email protected]> * update images.md Signed-off-by: Andy Clemenko <[email protected]> --------- Signed-off-by: Andy Clemenko <[email protected]> Co-authored-by: Zack Brady <[email protected]>
hauler-dev · Aug 25, 2024 · d5cbcd5 · d5cbcd5
1 parent a1afb65
commit d5cbcd5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/guides-references/hauler-content/images.md b/docs/guides-references/hauler-content/images.md
@@ -39,6 +39,9 @@ metadata:
   annotations:
     # global flags for all images in the manifest
     # image flags override global flags
+    # example: key set globally, but not observed if set per image
+    # example: platform set globally, but not observed if set per image
+    # example: registry set globally, but not observed if set per image
     hauler.dev/key: <cosign public key>
     hauler.dev/platform: <platform>
     hauler.dev/registry: <registry>
@@ -59,6 +62,9 @@ metadata:
   annotations:
     # global flags for all images in the manifest
     # image flags override global flags
+    # example: key set globally, but not observed if set per image
+    # example: platform set globally, but not observed if set per image
+    # example: registry set globally, but not observed if set per image
     hauler.dev/key: <cosign public key>
     hauler.dev/platform: <platform>
     hauler.dev/registry: <registry>

diff --git a/docs/guides-references/manifests.md b/docs/guides-references/manifests.md
@@ -16,6 +16,9 @@ metadata:
   annotations:
     # global flags for all images in the manifest
     # image flags override global flags
+    # example: key set globally, but not observed if set per image
+    # example: platform set globally, but not observed if set per image
+    # example: registry set globally, but not observed if set per image
     hauler.dev/key: <cosign public key>
     hauler.dev/platform: <platform>
     hauler.dev/registry: <registry>