[lxc-devel] [distrobuilder/master] Add documentation around VMs

[monstermunchkin on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 310 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20200525/c004bafa/attachment.bin>
-------------- next part --------------
From e77a5d7143e65d1fe6214b45262a4f298bbab6b7 Mon Sep 17 00:00:00 2001
From: Thomas Hipp <thomas.hipp at canonical.com>
Date: Mon, 25 May 2020 13:00:29 +0200
Subject: [PATCH 1/2] doc/building: Document --vm flag

Signed-off-by: Thomas Hipp <thomas.hipp at canonical.com>
---
 doc/building.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/doc/building.md b/doc/building.md
index 4e8637b..d09df08 100644
--- a/doc/building.md
+++ b/doc/building.md
@@ -69,6 +69,7 @@ Flags:
       --compression   Type of compression to use (default "xz")
   -h, --help          help for build-lxd
       --type          Type of tarball to create (default "split")
+      --vm            Create a qcow2 image for VMs
 
 Global Flags:
       --cache-dir   Cache directory
@@ -78,8 +79,10 @@ Global Flags:
 ```
 
 Running the `build-lxd` subcommand creates a LXD image.
-If `--type=split`, it outputs two files `lxd.tar.xz` and `rootfs.squashfs`.
-This is the default.
+If `--type=split`, it outputs two files.
+The metadata tarball will always be named `lxd.tar.xz`.
+When creating a container image, the second file will be `rootfs.squashfs`.
+When creating a VM image, the second file will be `disk.qcow2`.
 If `--type=unified`, a unified tarball named `<image.name>.tar.xz` is created.
 See the [image section](image.md) for more on the image name.
 

From 74487fcad9c994d6b5abacf58f60a41dd620ec19 Mon Sep 17 00:00:00 2001
From: Thomas Hipp <thomas.hipp at canonical.com>
Date: Mon, 25 May 2020 13:15:26 +0200
Subject: [PATCH 2/2] doc/generators: Add fstab

Signed-off-by: Thomas Hipp <thomas.hipp at canonical.com>
---
 doc/generators.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/doc/generators.md b/doc/generators.md
index 0580772..39dd56a 100644
--- a/doc/generators.md
+++ b/doc/generators.md
@@ -11,6 +11,7 @@ Available generators are
 * [template](#template)
 * [upstart_tty](#upstart_tty)
 * [lxd-agent](#lxd-agent)
+* [fstab](#fstab)
 
 In the image definition yaml, they are listed under `files`.
 
@@ -101,3 +102,17 @@ The job script is written to `path`.
 ## lxd-agent
 
 This generator creates the systemd unit files which are needed to start the lxd-agent in LXD VMs.
+
+## fstab
+
+This generator creates an /etc/fstab file which is used for VMs.
+Its content is:
+
+```
+LABEL=rootfs  /         <fs>  <options>  0 0
+LABEL=UEFI    /boot/efi vfat  defaults   0 0
+```
+
+The filesystem is taken from the LXD target (see [targets](targets.md)) which defaults to `ext4`.
+The options are generated depending on the filesystem.
+They cannot be overriden.