[PATCH] Improve fai-cd docs

Ian Kelling ian at iankelling.org
Thu Apr 13 11:38:44 CEST 2017


---

Notes:
    Each diff context separates an independent change, except for the 2 in
    fai-guide mentioning -M. I'm assuming you are fine reviewing it as one
    patch.

 doc/fai-guide.txt | 12 +++++++-----
 man/fai-cd.8      | 22 ++++++++++++++--------
 2 files changed, 21 insertions(+), 13 deletions(-)

diff --git a/doc/fai-guide.txt b/doc/fai-guide.txt
index a8da8847..f0e87c75 100644
--- a/doc/fai-guide.txt
+++ b/doc/fai-guide.txt
@@ -1752,23 +1752,25 @@ demohost# rwmount /target/home
 === [[nonfs]]FAI without NFS
 
 To boot into FAI and begin the installation sequence
-without using the NFS protocol. You boot the client machine using PXE as
+without using the NFS protocol, you boot the client machine using PXE as
 usual and then retrieve an image containing the nfsroot via http.
 
-To create an image, use fai-cd's -S argument
+To create an image, use fai-cd's -S argument and -M to avoid setting up
+a partial mirror within the image.
 
 ----
-faiserver# fai-cd -S squash.img
+faiserver# fai-cd -M -S squash.img
 ----
 
 Move this image to a directory from which it can be requested via http
 (usually a directory served by the webserver)
 
 To now request the squashfs image, add the following to your kernel
-command line, e.g. in your pxelinux configuration file for the client.
+command line, e.g. in your pxelinux configuration file for the client
+with fai-chboot.
 
 ----
-root=live:http://faiserver/cskoeln/squash.img
+root=live:http://faiserver/cskoeln/squash.img FAI_CONFIG_SRC=file:///var/lib/fai/config
 ----
 
 Replace faiserver with the domain name or IP of the machine your
diff --git a/man/fai-cd.8 b/man/fai-cd.8
index de03c524..88d65850 100644
--- a/man/fai-cd.8
+++ b/man/fai-cd.8
@@ -53,7 +53,7 @@ fai-cd \- make a bootable CD-ROM or USB stick that performs an FAI
 This command creates a bootable ISO CD-ROM image that performs the
 fully automatic installation from CD-ROM without an install server. The
 ISO image will be written to FILE. To create the image, the
-command needs the NFSROOT, the configuration space and a partial
+command needs the NFSROOT, the configuration space and optionally a partial
 mirror, which is created by fai-mirror. The ISO image will contain a compressed
 squashfs filesystem. This hybrid CD image can also
 be written to an USB stick using dd(1).
@@ -82,10 +82,12 @@ Use CFDIR as the configuration directory. Default is /etc/fai. You can
 also set the environment variable FAI_ETC_DIR.
 .TP
 .BI "\-d " URL
-Set the location of the config space to URL (this sets
-FAI_CONFIG_SRC). Set it to "" to create an ISO image without a config space. If not set, the
-value of FAI_CONFIGDIR will be used. Currently no file: is allowed
-here, instead set FAI_CONFIGDIR in fai.conf(5).
+Do not include the config space in the image and set the location of the
+config space to URL. This sets FAI_CONFIG_SRC in the grub config, which
+is obtained from the FAI configuration dir (see -C). Set it to "" to not
+set FAI_CONFIG_SRC. If not set, the config space is taken from
+FAI_CONFIGDIR and copied to /var/lib/fai/config in the image. Currently
+no file: is allowed here, instead set FAI_CONFIGDIR in fai.conf(5).
 .TP
 .BI \-e
 Exclude the directory /var/tmp from the nfsroot. You may put the
@@ -113,15 +115,19 @@ and locales are hidden and will not be put onto the CD or the USB stick.
 Use xz compression when calling mksquashfs. Default is gzip.
 .TP
 .BI "\-M "
-Do not add the package mirror to the CD.
+Do not add the package mirror to the CD. Packages that would be fetched
+from the mirror are obtained from the normal sources configured
+elsewhere, usually remote repositories.
 .TP
 .BI "\-m " DIRECTORY
 Use DIRECTORY as partial FAI mirror. This option is mandatory, unless
 you use -M or -B.
 .TP
 .BI \-S
-Create a squashfs image file, instead of a complete iso. This image
-file can be used to fetch the nfsroot through various ways over the network.
+Create a squashfs image file instead of a complete iso. The image
+contains the nfsroot and can be fetched through various ways over the
+network. For an example, see the section "FAI without NFS" in the FAI
+Guide.
 .SH EXAMPLES
 .br
 After you've created a mirror with fai-mirror in /media/mirror, you
-- 
2.11.0



More information about the linux-fai-devel mailing list