# grml-live
X-Git-Url: https://git.grml.org/?a=blobdiff_plain;ds=inline;f=grml-live%2Findex.html;h=3ab29e6e335896b0fae306d1bb2f56bc0100c001;hb=54cba19557f3cc75145261d9a0d893510bc464da;hp=4659291c03bd1ecacd9669c8bdb6fd3f392c837b;hpb=c39f079208e4a8e8a354e19e17d34ee43699e908;p=grml.org.git diff --git a/grml-live/index.html b/grml-live/index.html index 4659291..3ab29e6 100644 --- a/grml-live/index.html +++ b/grml-live/index.html @@ -3,29 +3,26 @@
- +grml-live - build framework based on FAI for generating a grml and Debian based +
grml-live - build framework based on FAI for generating a Grml and Debian based Linux Live system (CD/ISO)
grml-live [-a <architecture>] [-c <classe[s]>] [-C <configfile>] [-g <grml_name>] [-i <iso_name> ] [-o <output_directory>] [-r <release_name>] [-s -<suite>] [-t <template_directory>] [-v <version_number>] [-bBFhquVz]
- - | -Please check out the Current state of grml-live with squashfs-tools and kernel section for details about current state of involved -tools before starting with grml-live or if you encounter any problems. | -
grml-live provides the build system for creating a grml and Debian based Linux +
grml-live provides the build system for creating a Grml and Debian based Linux Live-CD. The build system is based on FAI (Fully Automatic Installation). grml-live uses the "fai dirinstall" feature to generate a chroot @@ -582,8 +778,8 @@ details of a build process.
+Clean up output directories before attempting the build. Packs the chroot +into a tar archive, and removes chroot and ISO build directories before exiting. +
+Build the ISO without touching the chroot at all. This option is useful if -you modified anything that FAI or grml-live might adjust via grml’s FAI +you modified anything that FAI or grml-live might adjust via Grml’s FAI scripts. It’s like the -b option but even more advanced. Use only if you really know that you do not want to update the chroot.
@@ -649,12 +853,13 @@ really know that you do not want to update the chroot.Specify the CLASSES to be used for building the ISO via FAI. By default only -the classes GRMLBASE, GRML_MEDIUM and I386 are assumed, resulting in a small base -system (being about ~180MB total ISO size). If using a non-I386 system (like -AMD64) you should specify the appropriate architecture as well. Additionally you -can specify a class providing a grml-kernel (see -the CLASSES section in this document for details about available classes). -So instead of GRML_MEDIUM you can also use GRML_SMALL and GRML_FULL. +the classes GRMLBASE, GRML_FULL and I386/AMD64 (depending on system +architecture) are assumed, resulting in a base system of about 350MB +total ISO size. If using a non-I386 system (like AMD64) you should specify the +appropriate architecture as well. Additionally you can specify a class providing +a grml-kernel (see the CLASSES section in this document for +details about available classes). So instead of GRML_FULL you can also use +GRML_SMALL and GRML_FULL.
+The specified directory is used as configuration directory for grml-live and its +FAI. By default /etc/grml/fai is used as default configuration directory. If +you want to have different configuration scripts, package definitions, etc. with +without messing with the global configuration under /etc/grml/fai provided by +grml-live this option provides you the option to use your own configuration +throughout this documentation. +
++Bootstrap the chroot without building bootloader, squashfs, or finalizing the +ISO. Use this option if installation of some packages fails, you want to run +custom commands or similar. +The main use of this option is to save time by skipping stages which aren’t +necessary for bootstrapping the chroot and which would get executed more than +once when iterating through the initial bootstrapping. +Alternatively, use this option as a test run of grml-live. Once you are +satisfied with the state of your grml_chroot, use grml-live -u to build the +remaining stages and finalize the ISO. +
++Build the ISO without generating a netboot package. +
++Unpack chroot tar archive before starting. Most useful in combination with +-A and -b or -u. +
++Sets ownership of all build output files to specified username before exiting. +
+To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live +
To get a Debian-stable and Grml-based Live-CD using /grml/grml-live as build and output directory just run:
# grml-live
To get a small Debian-unstable and grml-small based Live-CD using -/home/mika/grml-live as build and output directory just use:
# grml-live -s sid -c GRMLBASE,GRML_SMALL,I386 -o /home/mika/grml-live-
To get a medium sized, Debian-unstable and grml-based Live-CD for i386 -architecture using /grml/grml-live as build and output directory just run:
To get a 64bit Debian-testing and grml-small based Live-CD using /srv/grml-live +as build and output directory use the following command line on your amd64 +system:
# grml-live -s sid -a i386 -c GRMLBASE,GRML_MEDIUM,I386-
To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and -output directory and use grml_0.0-3.iso as ISO name (placed inside -/tmp/grml_isos) just invoke:
# grml-live -o /tmp -c GRMLBASE,GRML_SMALL,I386 -s sid -i grml_0.0-3.iso+
# grml-live -s testing -c GRMLBASE,GRML_SMALL,AMD64 -o /srv/grml-live
- | If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually -you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm" -and use /dev/shm as build and output directory - resulting in very fast build -process. But please be aware of the fact that rebooting your system will result -in an empty /dev/shm, so please use another directory for $CHROOT_OUTPUT, + | If you have enough free space inside /dev/shm (being a tmpfs, usually you should +have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm" and use +/dev/shm as build and output directory - resulting in very fast build process. +But please be aware of the fact that rebooting your system will result in an +empty /dev/shm, so please use another directory for $CHROOT_OUTPUT, $BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :) |
-create a grml-/Debian-based Linux Live-CD with one single command +create a Grml-/Debian-based Linux Live-CD with one single command
-multi-arch support (work in progress) -
-/etc/grml/fai/config/scripts/GRMLBASE/ -/etc/grml/fai/config/debconf/GRMLBASE -/etc/grml/fai/config/class/GRMLBASE.var -/etc/grml/fai/config/hooks/instsoft.GRMLBASE -/etc/grml/fai/config/package_config/GRMLBASE+
${GRML_FAI_CONFIG}/config/scripts/GRMLBASE/ +${GRML_FAI_CONFIG}/config/debconf/GRMLBASE +${GRML_FAI_CONFIG}/config/class/GRMLBASE.var +${GRML_FAI_CONFIG}/config/hooks/instsoft.GRMLBASE +${GRML_FAI_CONFIG}/config/package_config/GRMLBASE
Take a look at the next section for information about the concept of those files/directories.
If you want to use your own configuration, extend an existing configuration and/or add additional packages to your ISO just invent a new class (or extend an existing one). For example if you want to use your own class named "FOOBAR" just -set CLASSES="GRMLBASE,GRML_SMALL,I386,FOOBAR" inside /etc/grml/grml-live.local +set CLASSES="GRMLBASE,GRML_SMALL,AMD64,FOOBAR" inside /etc/grml/grml-live.local or invoke grml-live using the classes option: "grml-live -c -GRMLBASE,GRML_SMALL,I386,FOOBAR …".
More details regarding the class concept can be found in the documentation of FAI itself (being available at /usr/share/doc/fai-doc/).
The package selection part of the classes can be found in -/etc/grml/fai/config/package_config whereas some further classes are defined for -example in /etc/grml/fai/config/scripts/ so specific feature sets can be selected. The following classes are predefined:
-DEBORPHAN: get rid of all packages listed in output of Deborphan +DEBORPHAN: get rid of all packages listed in output of deborphan
GRMLBASE: the main class responsible for getting a minimal subset of what’s -defining a grml system. Important parts of the buildprocess are specified in +defining a Grml system. Important parts of the buildprocess are specified in this class as well, so unless you have a really good reason you should always use this class.
-GRML_FULL: full featured grml, also known as the "normal", full grml. +GRML_FULL: full featured Grml, also known as the "normal", full grml as +introduced in December 2011 (~350MB ISO size).
-GRML_MEDIUM: medium sized grml version, known as grml-medium +GRML_MEDIUM: medium sized Grml version, used to be known as grml-medium +until December 2011 (~220MB ISO size).
-GRML_POWERPC: grml for PowerPC architecture, not supported yet (still work in -progress) +GRML_SMALL: minimum sized Grml version, known as grml-small (~110MB ISO +size).
-GRML_SMALL: minimum sized grml version, known as grml-small +GRML_XL: large size Grml version, used to be known as "full grml" until +December 2011 (~700MB ISO size).
+SOURCES: retrieve Debian source packages after installation. Files will be +placed in the output directory under grml_sources. +
+XORG: providing important packages for use with a base grml-featured X.org setup
@@ -1050,7 +1296,6 @@ setupNotice that grml-live ships FAI configuration files that do not use the same namespace as the FAI packages itself. This ensures that grml-live does not clash with your usual FAI configuration, so instead of /etc/fai/fai.conf (package -fai-client) grml uses /etc/grml/fai/fai.conf instead. For more details see below. To get an idea how another configuration or example files could look like check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html @@ -1078,82 +1323,71 @@ from /etc/grml/grml-live.local as well you have to specify them on the grml-live commandline.
/etc/grml/fai/fai.conf+
${GRML_FAI_CONFIG}/fai.conf
Main configuration file for FAI which specifies where all the configuration files and scripts for FAI/grml-live can be found. By default the configuration variables are FAI_CONFIG_SRC=file:///etc/grml/fai/config and -FAI_CONFIGDIR=/etc/grml/fai/config - both pointing to a directory shipped by +GRML_FAI_CONFIG=/etc/grml/fai/config - both pointing to a directory shipped by grml-live out-of-the-box so you shouldn’t have to configure anything in this file.
/etc/grml/fai/make-fai-nfsroot.conf+
${GRML_FAI_CONFIG}/make-fai-nfsroot.conf
This file is used by make-fai-nfsroot(8) only. Usually you don’t have to change anything inside this file. If you want to modify NFSROOT though you can adjust it there.
/etc/grml/fai/NFSROOT+
${GRML_FAI_CONFIG}/NFSROOT
This file specifies the package list for creating the NFSROOT.
/etc/grml/fai/apt/sources.list-
This file specifies which mirrors should be considered for retrieving the Debian -packages when creating the main chroot (including all the software you would -like to see included). Important: this file should not be adjusted manually! -Instead use the GRML_LIVE_SOURCES variable inside /etc/grml/grml-live.conf or -/etc/grml/grml-live.local which modifies /etc/grml/fai/apt/sources.list -on-the-fly via grml-live then. If you want to generally adjust apt configuration -use FAI’s fcopy command with /etc/grml/fai/config/files instead.
/etc/grml/fai/config/+
${GRML_FAI_CONFIG}/config/
The main directory for configuration of FAI/grml-live. More details below.
/etc/grml/fai/config/class/+
${GRML_FAI_CONFIG}/config/class/
This directory contains files which specify main configuration variables for the FAI classes.
/etc/grml/fai/config/debconf/+
${GRML_FAI_CONFIG}/config/debconf/
This directory provides the files for preseeding/configuration of debconf through files.
/etc/grml/fai/config/hooks/+
${GRML_FAI_CONFIG}/config/hooks/
This directory provides files for customising the build process through hooks. Hooks are user defined programs or scripts, which are called during the installation process.
/etc/grml/fai/config/package_config/+
${GRML_FAI_CONFIG}/config/package_config/
Directory with lists of software packages to be installed or removed. The different classes describe what should find its way to your ISO. When running -"grml-live -c GRMLBASE,GRML_SMALL,I386 …" only the configuration of GRMLBASE, -GRML_SMALL and and I386 will be taken. If you use grml-live -c -GRMLBASE,GRML_SMALL,I386,FOOBAR … then the files of GRMLBASE, GRML_SMALL, -I386 plus the files from FOOBAR will be taken. So just create a new class to +"grml-live -c GRMLBASE,GRML_SMALL,AMD64 …" only the configuration of GRMLBASE, +GRML_SMALL and and AMD64 will be taken. If you use grml-live -c +GRMLBASE,GRML_SMALL,AMD64,FOOBAR … then the files of GRMLBASE, GRML_SMALL, +AMD64 plus the files from FOOBAR will be taken. So just create a new class to adjust the package selection according to your needs. Please notice that the directory GRMLBASE contains a package list defining a minimum but still reasonable package configuration.
/etc/grml/fai/config/scripts/+
${GRML_FAI_CONFIG}/config/scripts/
Scripts for customising the ISO within the build process.
/etc/grml/fai/live-initramfs/+
${GRML_FAI_CONFIG}/live-initramfs/
This directory provides the files used for building the initramfs/initrd via live-initramfs(8).
grml-live itself logs to /var/log/grml-live.log. Unless you set PRESERVE_LOGFILE -in your grml-live configuration the file is cleared on each new invocation of -grml-live.
The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the -default being /var/log/fai/grml/.
If you are using the grml-live buildd you will find the logs of the grml-live -run at /var/log/grml-buildd.stdout and /var/log/grml-buildd.stderr.
If you want to store build information in a database just install the -grml-live-db Debian package. Further details available in the grml-live-db -manpage.
Starting with grml-live version 0.17.0 you should find log files in a directory +named grml_logs in the output directory (next to grml_isos, grml_chroot,…).
grml-live versions before 0.17.0 used to log into /var/log/grml-live.log +and /var/log/fai/grml.
any Debian based system should be sufficient (if it doesn’t work it’s a bug, -please send us a bug report then) [a usual -grml2hd harddisk installation (using grml or -grml-medium) ships all you need]. Check out How do I deploy grml-live on a plain Debian installation for details how to set up grml-live +please send us a bug report then). Check out How do I deploy grml-live on a plain Debian installation for details how to set up grml-live on a plain, original Debian system.
Use squashfs-tools >=4.2-1 (available from Grml repositories as well as from -Debian/unstable) to build Grml (based) ISOs featuring kernel version -2.6.38-grml[64].
The easiest way to get a running grml-live setup is to install Grml or -grml-medium using grml2hd (for example inside KVM, Virtualbox, VMware,… if you -don’t want to run it on a physical system). Of course using grml-live on a -plain, original Debian installation is supported as well. So there we go.
What we have: plain, original Debian Lenny (5.0).
What we want: build a grml-medium ISO based on Debian/squeeze for the i386 -architecture using grml-live.
- - | -If you encounter any problems while booting the resulting ISO please be aware of -the current state of grml-live with squashfs-tools and kernel section. | -
The easiest way to get a running grml-live setup is to just use Grml. +Of course using grml-live on a plain, original Debian installation is supported +as well. So there we go.
What we have: plain, original Debian squeeze (6.0).
What we want: build a Grml ISO based on Debian/wheezy for the amd64 architecture +using grml-live.
# just optional(!) - upgrade FAI to latest available version: cat >> /etc/apt/sources.list << EOF # fai: - deb http://fai-project.org/download lenny koeln + deb http://fai-project.org/download squeeze koeln EOF
wget http://fai-project.org/download/etch/fai-client_3.2.8_all.deb \ - http://fai-project.org/download/etch/fai-server_3.2.8_all.deb \ - http://fai-project.org/download/etch/fai-doc_3.2.8_all.deb -dpkg -i fai-client_3.2.8_all.deb fai-server_3.2.8_all.deb fai-doc_3.2.8_all.deb-
or check out the FAI-homepage for -further details.
The variable $GRML_FAI_CONFIG is pointing to the directory /etc/grml/fai by +default. To provide you a maximum of flexibility you can set up your own +configuration directory (e.g. based on /etc/grml/fai) and use this directory +running grml-live with the -D <config_dir> option. Now $GRML_FAI_CONFIG +points to the specified directory instead of using /etc/grml/fai and all the +configuration files, scripts and hooks will be taken from your +$GRML_FAI_CONFIG directory.
Check out the logs inside /var/log/fai/… If you think it’s a bug in grml-live -send a copy of your config, logs and the commandline with a short problem -description to <mika@grml.org>:
# history | grep grml-live > /etc/grml/grml_live.cmdline -# tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \ - /etc/grml/grml_live.cmdline /etc/grml/grml-buildd.conf \ - /var/log/fai /etc/grml/fai --> finally mail grml_live_problem.tar.gz to <mika@grml.org>-
Check out the logs inside the directory grml_logs next to your grml_chroot, +grml_isos,… directories.
If you need help with grml-live or would like to see new features as part of grml-live you can get commercial support via Grml Solutions.
ISO size (bs = blocksize):
ISO |
-LZMA (256kB bs) |
-ZLIB |
-
grml_sid |
-666M |
-771M |
-
grml_squeeze |
-659M |
-761M |
-
grml_lenny |
-624M |
-723M |
-
grml64_sid |
-677M |
-791M |
-
grml64_squeeze |
-671M |
-785M |
-
grml64_lenny |
-639M |
-745M |
-
grml-medium_sid |
-208M |
-236M |
-
grml-medium_squeeze |
-206M |
-234M |
-
grml-medium_lenny |
-193M |
-220M |
-
grml64-medium_sid |
-213M |
-245M |
-
grml64-medium_squeeze |
-213M |
-244M |
-
grml64-medium_lenny |
-201M |
-231M |
-
grml-small_sid |
-102M |
-118M |
-
grml-small_squeeze |
-101M |
-117M |
-
grml-small_lenny |
-97M |
-112M |
-
grml64-small_sid |
-103M |
-120M |
-
grml64-small_squeeze |
-103M |
-120M |
-
grml64-small_lenny |
-99M |
-116M |
-
Build time of grml-medium’s squashfs file (depends on your system, though just -to get the ratio between the different options):
-10 minutes and 4 seconds with LZMA default blocksize (128k) -
--7 minutes 27 seconds with LZMA and blocksize 256k -
--6 minutes and 8 seconds with LZMA blocksize 512k -
--1 minute and 40 seconds with ZLIB -
-Just point the configuration variable CHROOT_INSTALL to the directory which provides the files you would like to install. Note that the files are installed under / in the chroot - so you have to create the rootfs structure on your @@ -1520,25 +1583,21 @@ grml-live ...
Sure. Just adjust the variables GRML_LIVE_SOURCES and FAI_DEBOOTSTRAP (if not -already using NFSROOT’s base.tgz) inside /etc/grml/grml-live.conf according to -your needs. Please don’t forget that you should use the grml servers as well -(see default configuration) so all the grml packages can be downloaded as well.
If you want to use a local (for example NFS mount) mirror additionally, just -adjust MIRROR_DIRECTORY and MIRROR_SOURCES inside /etc/grml/grml-live.conf as -well.
Unless you specify GRML_LIVE_SOURCES and/or FAI_DEBOOTSTRAP the default from -/etc/grml/fai/apt/sources.list and /etc/grml/fai/make-fai-nfsroot.conf will be -taken. If you customise the variables in /etc/grml/grml-live.conf then the two -files will be adjusted during runtime automatically.
If MIRROR_DIRECTORY and MIRROR_SOURCES are specified the local mirror will be -taken as first entry in the generated sources.list so it’s preferred over -non-local mirrors. Using a fallback mirror (via providing several mirrors in -GRML_LIVE_SOURCES as used by default) is a recommended setting.
Yes. Set up an according sources.list configuration as class file in +FAI_DEBOOTSTRAP (if not already using NFSROOT’s base.tgz) inside +/etc/grml/grml-live.conf[.local]. If you’re setting up your own class file don’t +forget to include the class name in the class list (grml-live -c …).
If you want to use a local (for example NFS mount) mirror additionally then +adjust MIRROR_DIRECTORY in /etc/grml/grml-live.conf[.local] as well.
If you want to use a HTTP Proxy (like apt-cacher-ng), set APT_PROXY. Example:
APT_PROXY="http://localhost:3142/"+
Just create a new class (using the package_config directory):
and specify it when invoking grml-live then:
# grml-live -c GRMLBASE,GRML_SMALL,I386,MIKA+
# grml-live -c GRMLBASE,GRML_SMALL,AMD64,MIKA
Notice: this deletes all your grml-live configuration files. If that’s really what you are searching for just run:
rm -rf /etc/grml/fai /etc/grml/grml-live.conf dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb
- - | -If you don’t control your /etc using a version control system (VCS) yet it’s a -good chance to start using it now. Check out -http://michael-prokop.at/blog/2007/03/14/maintain-etc-with-mercurial-on-debian/ -for more details how to maintain /etc using the mercurial VCS. | -
First of all build the chroot system:
Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and +
Make sure /etc/grml/grml-live.local provides according APT_PROXY and FAI_DEBOOTSTRAP:
# cat /etc/grml/grml-live.conf +# cat /etc/grml/grml-live.local [...] -GRML_LIVE_SOURCES=" -deb http://localhost:3142/deb.grml.org grml-stable main -deb http://localhost:3142/deb.grml.org grml-testing main -deb http://localhost:3142/cdn.debian.net/debian squeeze main contrib non-free -" +APT_PROXY="http://localhost:3142/" [...] FAI_DEBOOTSTRAP="squeeze http://localhost:3142/cdn.debian.net/debian squeeze main contrib non-free"
Make sure apt-cacher / apt-cacher-ng is running (/etc/init.d/apt-cacher -restart or /etc/init.d/apt-cacher-ng restart). That’s it. All downloaded -files will be cached in /var/cache/apt-cacher/ or /var/cache/apt-cacher-ng then.
Make sure apt-cacher-ng is running (/etc/init.d/apt-cacher-ng restart). +That’s it. All downloaded files will be cached in /var/cache/apt-cacher-ng then.
Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and -FAI_DEBOOTSTRAP:
# cat /etc/grml/grml-live.conf -[...] -GRML_LIVE_SOURCES=" -deb http://localhost:9999/grml grml-stable main -deb http://localhost:9999/grml grml-testing main -deb http://localhost:9999/debian squeeze main contrib non-free -" -FAI_DEBOOTSTRAP="squeeze http://localhost:9999/debian"-
Configure approx:
# cat /etc/approx/approx.conf -[...] -debian http://ftp.at.debian.org/debian -grml http://deb.grml.org/-
Don’t forget to restart approx (/etc/init.d/approx restart). That’s it. -All downloaded files will be cached in /var/cache/approx now.
The so called manifold feature Grml ISOs use by default allows to use the same +
The so called manifold feature Grml ISOs use by default allows one to use the same ISO for CD boot and USB boot. If you notice any problems when booting just revert the manifold feature running:
Execute the following commands (requires root):
If you want to set up a system like daily.grml.org the Debian package grml-live-buildd provides all you need to start. Start with figuring out the cron job script /usr/share/grml-live/buildd/cronjob.sh.
Don’t hesitate to contact the author: <mika@grml.org>
The source of grml-live is available at -http://git.grml.org/?p=grml-live.git
Check out the TODO file.
Please report feedback, bugreports and wishes -to the grml-team!
The most recent grml-live documentation is available online at http://grml.org/grml-live/ and for offline reading also available @@ -1818,7 +1825,7 @@ in different formats:
Michael Prokop <mika@grml.org>