Merge pull request #1545 from ktock/ssdoc

mikebrow · web-flow · commit c209d013cbc5 · 2020-07-29T11:48:30.000-05:00
Add description about `disable_snapshot_annotations` to configuration doc
diff --git a/docs/config.md b/docs/config.md
@@ -106,6 +106,11 @@ version = 2
     # This only works for runtime type "io.containerd.runtime.v1.linux".
     no_pivot = false
 
+    # disable_snapshot_annotations disables to pass additional annotations (image
+    # related information) to snapshotters. These annotations are required by
+    # stargz snapshotter (https://github.com/containerd/stargz-snapshotter)
+    disable_snapshot_annotations = false
+
     # discard_unpacked_layers allows GC to remove layers from the content store after
     # successfully unpacking these layers to the snapshotter.
     discard_unpacked_layers = false
