change mkfs as default flag for convertor

Signed-off-by: liulanzheng <[email protected]>
containerd · Oct 12, 2023 · 385b560 · 385b560
1 parent 8eac81a
commit 385b560
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/cmd/convertor/main.go b/cmd/convertor/main.go
@@ -140,7 +140,7 @@ func init() {
 	rootCmd.Flags().StringVarP(&tagOutput, "output-tag", "o", "", "tag for image converting to")
 	rootCmd.Flags().StringVarP(&dir, "dir", "d", "tmp_conv", "directory used for temporary data")
 	rootCmd.Flags().BoolVarP(&oci, "oci", "", false, "export image with oci spec")
-	rootCmd.Flags().BoolVarP(&mkfs, "mkfs", "", false, "make ext4 fs in bottom layer")
+	rootCmd.Flags().BoolVarP(&mkfs, "mkfs", "", true, "make ext4 fs in bottom layer")
 	rootCmd.Flags().StringVar(&fastoci, "fastoci", "", "build 'Overlaybd-Turbo OCIv1' format (old name of turboOCIv1. deprecated)")
 
 	rootCmd.Flags().StringVar(&turboOCI, "turboOCI", "", "build 'Overlaybd-Turbo OCIv1' format")

diff --git a/docs/QUICKSTART.md b/docs/QUICKSTART.md
@@ -199,7 +199,7 @@ There are several methods.
 
     ```bash
     # use rpull to pull image without layer downloading
-    sudo /opt/overlaybd/snapshotter/ctr -u {user}:{pass} rpull registry.hub.docker.com/overlaybd/redis:6.2.1_obd
+    sudo /opt/overlaybd/snapshotter/ctr rpull -u {user}:{pass} registry.hub.docker.com/overlaybd/redis:6.2.1_obd
 
     # run by ctr run
     sudo ctr run --net-host --snapshotter=overlaybd --rm -t registry.hub.docker.com/overlaybd/redis:6.2.1_obd demo

diff --git a/docs/USERSPACE_CONVERTOR.md b/docs/USERSPACE_CONVERTOR.md
@@ -18,7 +18,7 @@ Only several tools are required:
 
 - baselayer
 
-  stored at `/opt/overlaybd/baselayers/ext4_64` after installing [overlaybd](https://github.com/containerd/overlaybd). This is required if flag `--mkfs` is not provided.
+  stored at `/opt/overlaybd/baselayers/ext4_64` after installing [overlaybd](https://github.com/containerd/overlaybd). This is required if flag `--mkfs` is false.
 
 Overall, the requirements are `/opt/overlaybd/bin/{overlaybd-create,overlaybd-commit,overlaybd-apply}` and `/opt/overlaybd/baselayers/ext4_64`(optional).
 
@@ -42,7 +42,7 @@ Flags:
   -o, --output-tag string   tag for image converting to
   -d, --dir string          directory used for temporary data (default "tmp_conv")
       --oci                 export image with oci spec
-      --mkfs                make ext4 fs in bottom layer
+      --mkfs                make ext4 fs in bottom layer (default true)
       --fastoci string      build 'Overlaybd-Turbo OCIv1' format (old name of turboOCIv1. deprecated)
       --turboOCI string     build 'Overlaybd-Turbo OCIv1' format
       --overlaybd string    build overlaybd format
@@ -52,7 +52,6 @@ Flags:
 
 # examples
 $ bin/convertor -r docker.io/overlaybd/redis -u user:pass -i 6.2.6 -o 6.2.6_obd
-$ bin/convertor --mkfs -r docker.io/overlaybd/redis -u user:pass -i 6.2.6 --overlaybd 6.2.6_obd
 $ bin/convertor -r docker.io/overlaybd/redis -u user:pass -i 6.2.6 --overlaybd 6.2.6_obd --fastoci 6.2.6_foci
 
 ```