Merge pull request #154 from BigVan/autoRemove

support auto cleanup overlaybd

Author: liulanzheng

cmd/overlaybd-snapshotter/main.go

@@ -38,22 +38,14 @@ import (
 
 const defaultConfigPath = "/etc/overlaybd-snapshotter/config.json"
 
-type pluginConfig struct {
-	Address  string `json:"address"`
-	Root     string `json:"root"`
-	LogLevel string `json:"verbose"`
-	Mode     string `json:"mode"` // fs, dir or dev
-}
-
-var pconfig pluginConfig
+var pconfig *overlaybd.BootConfig
 
 func parseConfig(fpath string) error {
 	data, err := os.ReadFile(fpath)
 	if err != nil {
 		return errors.Wrapf(err, "failed to read plugin config from %s", fpath)
 	}
-
-	if err := json.Unmarshal(data, &pconfig); err != nil {
+	if err := json.Unmarshal(data, pconfig); err != nil {
 		return errors.Wrapf(err, "failed to parse plugin config from %s", string(data))
 	}
 	return nil
@@ -62,26 +54,23 @@ func parseConfig(fpath string) error {
 // TODO: use github.com/urfave/cli
 func main() {
 
+	pconfig = overlaybd.DefaultBootConfig()
 	if err := parseConfig(defaultConfigPath); err != nil {
 		logrus.Error(err)
 		os.Exit(1)
 	}
-
-	if pconfig.Mode == "" {
-		pconfig.Mode = "fs"
+	if pconfig.LogReportCaller {
+		logrus.SetReportCaller(true)
 	}
-	logrus.Infof("set mode: %s", pconfig.Mode)
+	logrus.Infof("%+v", *pconfig)
 
-	if pconfig.LogLevel == "" {
-		pconfig.LogLevel = "info"
-	}
 	if err := setLogLevel(pconfig.LogLevel); err != nil {
 		logrus.Errorf("failed to set log level: %v", err)
 	} else {
 		logrus.Infof("set log level: %s", pconfig.LogLevel)
 	}
 
-	sn, err := overlaybd.NewSnapshotter(pconfig.Root, pconfig.Mode)
+	sn, err := overlaybd.NewSnapshotter(pconfig)
 	if err != nil {
 		logrus.Errorf("failed to init overlaybd snapshotter: %v", err)
 		os.Exit(1)

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",
+    "rwMode": "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` |
+| `rwMode` | 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