add option --preallocate to virtnbdrestore

Changelog

@@ -1,3 +1,8 @@
+Version 2.14
+---------
+ * virtnbdrestore: Add option -A (--preallocate) to create thick, full
+ pre-allocated target images during restore.
+
 Version 2.13
 ---------
  * virtnbdbackup: If libvirt daemon is unreachable, it would fail with an

README.md

@@ -665,6 +665,10 @@ in the output directory `/tmp/restore`
 > target directory, but won't alter its contents. You have to adjust the config
 > file for the new paths and/or excluded disks to be able to define and run it.
 
+`Note`:
+> Created disk images will be thin provisioned by default, you can change this
+> behavior using option `--preallocate` to create thick provisioned images.
+
 ## Process only specific disks during restore
 
 A single disk can be restored by using the option `-d`, the disk name has

libvirtnbdbackup/__init__.py

@@ -15,4 +15,4 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-__version__ = "2.13"
+__version__ = "2.14"

libvirtnbdbackup/qemu/util.py

@@ -56,7 +56,8 @@ def map(cType) -> str:
         return json.loads(extentMap.stdout)
 
     @staticmethod
-    def create(
+    def create(  # pylint: disable=R0913: disable=R0913
+        args: Namespace,
         targetFile: str,
         fileSize: int,
         diskFormat: str,
@@ -74,6 +75,10 @@ def create(
             f"size={fileSize}",
         ]
 
+        if args.preallocate:
+            cmd.append("-o")
+            cmd.append("preallocation=full")
+
         if qcowOptions:
             cmd = cmd + qcowOptions
 

libvirtnbdbackup/restore/image.py

@@ -81,11 +81,12 @@ def getConfig(args: Namespace, meta: Dict[str, str]) -> List[str]:
 def create(args: Namespace, meta: Dict[str, str], targetFile: str, sshClient):
     """Create target image file"""
     logging.info(
-        "Create virtual disk [%s] format: [%s] size: [%s] based on: [%s]",
+        "Create virtual disk [%s] format: [%s] size: [%s] based on: [%s] preallocated: [%s]",
         targetFile,
         meta["diskFormat"],
         meta["virtualSize"],
         meta["checkpointName"],
+        args.preallocate,
     )
 
     options = getConfig(args, meta)
@@ -96,7 +97,12 @@ def create(args: Namespace, meta: Dict[str, str], targetFile: str, sshClient):
     qFh = qemu.util(meta["diskName"])
     try:
         qFh.create(
-            targetFile, int(meta["virtualSize"]), meta["diskFormat"], options, sshClient
+            args,
+            targetFile,
+            int(meta["virtualSize"]),
+            meta["diskFormat"],
+            options,
+            sshClient,
         )
     except (ProcessError, sshError) as e:
         logging.error("Failed to create restore target: [%s]", e)

man/virtnbdbackup.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
-.TH VIRTNBDBACKUP "1" "August 2024" "virtnbdbackup 2.13" "User Commands"
+.TH VIRTNBDBACKUP "1" "August 2024" "virtnbdbackup 2.14" "User Commands"
 .SH NAME
 virtnbdbackup \- backup utility for libvirt
 .SH DESCRIPTION
@@ -52,7 +52,7 @@ Backup only disk with target dev name (\fB\-i\fR vda)
 Exclude disk(s) with target dev name (\fB\-x\fR vda,vdb)
 .TP
 \fB\-f\fR SOCKETFILE, \fB\-\-socketfile\fR SOCKETFILE
-Use specified file for NBD Server socket (default: \fI\,/var/tmp/virtnbdbackup.16504\/\fP)
+Use specified file for NBD Server socket (default: \fI\,/var/tmp/virtnbdbackup.9548\/\fP)
 .TP
 \fB\-n\fR, \fB\-\-noprogress\fR
 Disable progress bar

man/virtnbdmap.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
-.TH VIRTNBDMAP "1" "August 2024" "virtnbdmap 2.13" "User Commands"
+.TH VIRTNBDMAP "1" "August 2024" "virtnbdmap 2.14" "User Commands"
 .SH NAME
 virtnbdmap \- map virtnbdbackup image files to nbd devices
 .SH DESCRIPTION

man/virtnbdrestore.1

@@ -1,13 +1,13 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
-.TH VIRTNBDRESTORE "1" "August 2024" "virtnbdrestore 2.13" "User Commands"
+.TH VIRTNBDRESTORE "1" "August 2024" "virtnbdrestore 2.14" "User Commands"
 .SH NAME
 virtnbdrestore \- restore utility for libvirt
 .SH DESCRIPTION
 usage: virtnbdrestore [\-h] [\-a {dump,restore,verify}] \fB\-i\fR INPUT \fB\-o\fR OUTPUT
 .TP
 [\-u UNTIL] [\-s SEQUENCE] [\-d DISK] [\-n] [\-f SOCKETFILE]
 [\-r] [\-c] [\-D] [\-C CONFIG_FILE] [\-N NAME] [\-B BUFFSIZE]
-[\-U URI] [\-\-user USER] [\-\-ssh\-user SSH_USER]
+[\-A] [\-U URI] [\-\-user USER] [\-\-ssh\-user SSH_USER]
 [\-\-ssh\-port SSH_PORT] [\-\-password PASSWORD]
 [\-P NBD_PORT] [\-I NBD_IP] [\-\-tls] [\-\-tls\-cert TLS_CERT]
 [\-L LOGFILE] [\-\-nocolor] [\-v] [\-V]
@@ -41,7 +41,7 @@ Process only disk matching target dev name. (default: None)
 Disable progress bar
 .TP
 \fB\-f\fR SOCKETFILE, \fB\-\-socketfile\fR SOCKETFILE
-Use specified file for NBD Server socket (default: \fI\,/var/tmp/virtnbdbackup.16509\/\fP)
+Use specified file for NBD Server socket (default: \fI\,/var/tmp/virtnbdbackup.9553\/\fP)
 .TP
 \fB\-r\fR, \fB\-\-raw\fR
 Copy raw images as is during restore. (default: False)
@@ -60,6 +60,9 @@ Define restored domain with specified name
 .TP
 \fB\-B\fR BUFFSIZE, \fB\-\-buffsize\fR BUFFSIZE
 Buffer size to use during verify (default: 8192)
+.TP
+\fB\-A\fR, \fB\-\-preallocate\fR
+Preallocate restored qcow images. (default: False)
 .SS "Remote Restore options:"
 .TP
 \fB\-U\fR URI, \fB\-\-uri\fR URI

virtnbdrestore

@@ -168,6 +168,14 @@ def main() -> None:
         type=int,
         help="Buffer size to use during verify (default: %(default)s)",
     )
+    opt.add_argument(
+        "-A",
+        "--preallocate",
+        default=False,
+        action="store_true",
+        help="Preallocate restored qcow images. (default: %(default)s)",
+    )
+
     remopt = parser.add_argument_group("Remote Restore options")
     argopt.addRemoteArgs(remopt)
     logopt = parser.add_argument_group("Logging options")