[lxc-devel] [distrobuilder/master] Update index.md - separate LXD and LXC examples

[muir on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 366 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20200119/8bd8c115/attachment.bin>
-------------- next part --------------
From ed3a69441e9c1852796e774c77b081c4d82c65e3 Mon Sep 17 00:00:00 2001
From: David Sharnoff <github at dave.sharnoff.org>
Date: Sun, 19 Jan 2020 20:09:54 -0800
Subject: [PATCH] Update index.md - separate LXD and LXC examples

Signed-off-by: David Sharnoff <github at dave.sharnoff.org>
---
 doc/index.md | 50 +++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 37 insertions(+), 13 deletions(-)

diff --git a/doc/index.md b/doc/index.md
index a06a57d..6c9ce7b 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -86,6 +86,8 @@ Then, copy one of the example yaml configuration files for container images into
 cp $HOME/go/src/github.com/lxc/distrobuilder/doc/examples/ubuntu.yaml ubuntu.yaml
 ```
 
+### Build the container image for LXD
+
 Finally, run `distrobuilder` to create the container image. We are using the `build-lxd` option to create a container image for LXD.
 
 ```
@@ -95,20 +97,12 @@ sudo $HOME/go/bin/distrobuilder build-lxd ubuntu.yaml
 If the command is successful, you will get an output similar to the following. The `lxd.tar.xz` file is the description of the container image. The `rootfs.squasfs` file is the root filesystem (rootfs) of the container image. The set of these two files is the _container image_.
 
 ```bash
-multipass at dazzling-termite:~/ContainerImages/ubuntu$ ls -l
+$ ls -l
 total 121032
 -rw-r--r-- 1 root      root            560 Oct  3 13:28 lxd.tar.xz
 -rw-r--r-- 1 root      root      123928576 Oct  3 13:28 rootfs.squashfs
 -rw-rw-r-- 1 multipass multipass      3317 Oct  3 13:19 ubuntu.yaml
-multipass at dazzling-termite:~/ContainerImages/ubuntu$
-```
-
-### Adding the container image to LXC
-
-To add the container image to a LXC installation, use the `lxc-create` command as follows.
-
-```bash
-$ lxc-create -n myContainerImage -t local -- --metadata meta.tar.xz --fstree rootfs.tar.xz
+$
 ```
 
 ### Adding the container image to LXD
@@ -116,7 +110,7 @@ $ lxc-create -n myContainerImage -t local -- --metadata meta.tar.xz --fstree roo
 To add the container image to a LXD installation, use the `lxc image import` command as follows.
 
 ```bash
-multipass at dazzling-termite:~/ContainerImages/ubuntu$ lxc image import lxd.tar.xz rootfs.squashfs --alias mycontainerimage
+$ lxc image import lxd.tar.xz rootfs.squashfs --alias mycontainerimage 
 Image imported with fingerprint: ae81c04327b5b115383a4f90b969c97f5ef417e02d4210d40cbb17a038729a27
 ```
 
@@ -131,16 +125,46 @@ $ lxc image list mycontainerimage
 +------------------+--------------+--------+---------------+--------+----------+------------------------------+
 ```
 
-### Launching a container from the container image
+### Launching a LXD container from the container image
 
 To launch a container from the freshly created container image, use `lxc launch` as follows. Note that you do not specify a repository of container images (like `ubuntu:` or `images:`) because the image is located locally.
 
-```
+```bash
 $ lxc launch mycontainerimage c1
 Creating c1
 Starting c1
 ```
 
+### Build a LXC container image
+
+Using LXC containers instead of LXD may require the installation of `lxc-utils`.
+Having both LXC and LXD installed on the same system will probably cause confusion.
+Use of raw LXC is generally discouraged due to the lack of automatic Apparmor
+protection.
+
+For LXC, instead use:
+```bash
+$ sudo $HOME/go/bin/distrobuilder build-lxc ubuntu.yaml
+$ ls -l
+total 87340
+-rw-r--r-- 1 root root      740 Jan 19 03:15 meta.tar.xz
+-rw-r--r-- 1 root root 89421136 Jan 19 03:15 rootfs.tar.xz
+-rw-r--r-- 1 root root     4798 Jan 19 02:42 ubuntu.yaml
+```
+
+### Adding the container image to LXC
+
+To add the container image to a LXC installation, use the `lxc-create` command as follows.
+
+```bash
+lxc-create -n myContainerImage -t local -- --metadata meta.tar.xz --fstree rootfs.tar.xz
+```
+
+Then start the container with
+```bash
+lxc-start -n myContainerImage
+```
+
 ### Examples
 
 Examples of yaml files for various distributions can be found in the [examples directory](./doc/examples) and in the [lxc-ci repository](https://github.com/lxc/lxc-ci/tree/master/images).