update QUICKSTART.md

Signed-off-by: Yifan Yuan <tuji.yyf@alibaba-inc.com>

Author: BigVan

docs/QUICKSTART.md

@@ -57,11 +57,23 @@ The config file is `/etc/overlaybd-snapshotter/config.json`. Please create the f
 
 ```json
 {
-    "root": "/var/lib/overlaybd/",
-    "address": "/run/overlaybd-snapshotter/overlaybd.sock"
+    "root": "/var/lib/containerd/io.containerd.snapshotter.v1.overlaybd",
+    "address": "/run/overlaybd-snapshotter/overlaybd.sock",
+    "verbose": "info",
+    "mode": "overlayfs",
+    "logReportCaller": false,
+    "autoRemoveDev": false
 }
 ```
-`root` is the root directory to store snapshots, `address` is the socket address used to connect withcontainerd.
+| Field | Description |
+| ----- | ----------- |
+| `root` | the root directory to store snapshots |
+| `address` | the socket address used to connect withcontainerd. |
+| `verbose` | log level, `info` or `debug` |
+| `mode` | rootfs mode about wether to use native writable layer. See [Native Support for Writable](docs/WRITABLE.md) for detail. |
+| `logReportCaller` | enable/disable the calling method |
+| `autoRemoveDev` | enable/disable auto clean-up overlaybd device after container removed |
+
 
 #### Start service
 

pkg/snapshot/overlay.go

@@ -570,7 +570,7 @@ func (o *snapshotter) Prepare(ctx context.Context, key, parent string, opts ...s
 // View returns a readonly view on parent snapshotter.
 func (o *snapshotter) View(ctx context.Context, key, parent string, opts ...snapshots.Opt) (_ []mount.Mount, retErr error) {
 	log.G(ctx).Debugf("View (key: %s, parent: %s)", key, parent)
-
+	defer log.G(ctx).Debugf("return View (key: %s, parent: %s)", key, parent)
 	return o.createMountPoint(ctx, snapshots.KindView, key, parent, opts...)
 }
 
@@ -966,6 +966,9 @@ func (o *snapshotter) normalOverlayMount(s storage.Snapshot) []mount.Mount {
 			fmt.Sprintf("workdir=%s", o.workPath(s.ID)),
 			fmt.Sprintf("upperdir=%s", o.upperPath(s.ID)),
 		)
+		// if o.metacopyOption != "" {
+		// 	options = append(options, o.metacopyOption)
+		// }
 	} else if len(s.ParentIDs) == 1 {
 		return []mount.Mount{
 			{

pkg/snapshot/storage.go

@@ -551,6 +551,8 @@ func (o *snapshotter) constructOverlayBDSpec(ctx context.Context, key string, wr
 			Data:  o.overlaybdWritableDataPath(id),
 		}
 	}
+	configBuffer, _ := json.MarshalIndent(configJSON, "", "  ")
+	log.G(ctx).Infoln(string(configBuffer))
 	return o.atomicWriteOverlaybdTargetConfig(id, &configJSON)
 }
 

script/config.json

@@ -1,4 +1,8 @@
 {
     "root": "/var/lib/containerd/io.containerd.snapshotter.v1.overlaybd",
-    "address": "/run/overlaybd-snapshotter/overlaybd.sock"
+    "address": "/run/overlaybd-snapshotter/overlaybd.sock",
+    "verbose": "info",
+    "mode": "overlayfs",
+    "logReportCaller": false,
+    "autoRemoveDev": false
 }