]> git.ipfire.org Git - thirdparty/dracut.git/blobdiff - dracut.cmdline.7.asc
livenet: Enable OverlayFS overlay in sysroot.mount generator.
[thirdparty/dracut.git] / dracut.cmdline.7.asc
index 36d5656106b21a58e654e43c4239042df61ce5f4..df633e5d1f0ea310968a07a2ad685127b2a037ee 100644 (file)
@@ -311,6 +311,11 @@ crypto LUKS
 **rd.luks.crypttab=0**::
     do not check, if LUKS partition is in _/etc/crypttab_
 
+**rd.luks.timeout=**__<seconds>__::
+    specify how long dracut should wait when waiting for the user to enter the
+    password. This avoid blocking the boot if no password is entered. It does
+    not apply to luks key. The default is '0', which means 'forever'.
+
 crypto LUKS - key on removable device support
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 **rd.luks.key=**__<keypath>__:__<keydev>__:__<luksdev>__::
@@ -480,7 +485,7 @@ USB Android phone::
 * enp0s29u1u2
 =====================
 
-**ip=**__{dhcp|on|any|dhcp6|auto6}__::
+**ip=**__{dhcp|on|any|dhcp6|auto6|either6}__::
     dhcp|on|any::: get ip from dhcp server from all interfaces. If root=dhcp,
     loop sequentially through all interfaces (eth0, eth1, ...) and use the first
     with a valid DHCP root-path.
@@ -489,6 +494,8 @@ USB Android phone::
 
     dhcp6::: IPv6 DHCP
 
+    either6::: if auto6 fails, then dhcp6
+
 **ip=**__<interface>__:__{dhcp|on|any|dhcp6|auto6}__[:[__<mtu>__][:__<macaddr>__]]::
     This parameter can be specified multiple times.
 +
@@ -569,13 +576,14 @@ interface name. Better name it "bootnet" or "bluesocket".
     VLAN_PLUS_VID_NO_PAD (vlan5), DEV_PLUS_VID (eth0.0005),
     DEV_PLUS_VID_NO_PAD (eth0.5)
 
-**bond=**__<bondname>__[:__<bondslaves>__:[:__<options>__]]::
+**bond=**__<bondname>__[:__<bondslaves>__:[:__<options>__[:<mtu>]]]::
     Setup bonding device <bondname> on top of <bondslaves>.
     <bondslaves> is a comma-separated list of physical (ethernet) interfaces.
     <options> is a comma-separated list on bonding options (modinfo bonding for
     details) in format compatible with initscripts. If <options> includes
     multi-valued arp_ip_target option, then its values should be separated by
-    semicolon. Bond without parameters assumes
+    semicolon. if the mtu is specified, it will be set on the bond master.
+    Bond without parameters assumes
     bond=bond0:eth0,eth1:mode=balance-rr
 
 **team=**__<teammaster>__:__<teamslaves>__::
@@ -726,6 +734,9 @@ You may want to use rd.iscsi.firmware.
 **root=**_???_ **netroot=**iscsi **rd.iscsi.firmware=1**::
  will read the iscsi parameter from the BIOS firmware
 
+**rd.iscsi.login_retry_max=**__<num>__::
+    maximum number of login retries
+
 **rd.iscsi.param=**__<param>__::
     <param> will be passed as "--param <param>" to iscsistart.
     This parameter can be specified multiple times.
@@ -754,10 +765,12 @@ iscsistart -b --param node.session.timeo.replacement_timeout=30
 
 FCoE
 ~~~~
-**fcoe=**__<edd|interface|MAC>__:__{dcb|nodcb}__::
+**fcoe=**__<edd|interface|MAC>__:__{dcb|nodcb}__:__{fabric|vn2vn}__::
     Try to connect to a FCoE SAN through the NIC specified by _<interface>_ or
-    _<MAC>_ or EDD settings. For the second argument, currently only nodcb is
-    supported. This parameter can be specified multiple times.
+    _<MAC>_ or EDD settings. The second argument specifies if DCB
+    should be used. The optional third argument specifies whether
+    fabric or VN2VN mode should be used.
+    This parameter can be specified multiple times.
 +
 NOTE: letters in the MAC-address must be lowercase!
 
@@ -787,12 +800,19 @@ DASD
 ZFCP
 ~~~~
 **rd.zfcp=**__<zfcp adaptor device bus ID>__,__<WWPN>__,__<FCPLUN>__::
-    rd.zfcp can be specified multiple times on the kernel command line.
+    rd.zfcp can be specified multiple times on the kernel command
+    line.
+
+**rd.zfcp=**__<zfcp adaptor device bus ID>__::
+    If NPIV is enabled and the 'allow_lun_scan' parameter to the zfcp
+    module is set to 'Y' then the zfcp adaptor will be initiating a
+    scan internally and the <WWPN> and <FCPLUN> parameters can be omitted.
 +
 [listing]
 .Example
 --
 rd.zfcp=0.0.4000,0x5005076300C213e9,0x5022000000000000
+rd.zfcp=0.0.4000
 --
 
 **rd.zfcp.conf=0**::
@@ -801,6 +821,9 @@ rd.zfcp=0.0.4000,0x5005076300C213e9,0x5022000000000000
 ZNET
 ~~~~
 **rd.znet=**__<nettype>__,__<subchannels>__,__<options>__::
+    The whole parameter is appended to /etc/ccw.conf, which is used on
+    RHEL/Fedora with ccw_init, which is called from udev for certain
+    devices on z-series.
     rd.znet can be specified multiple times on the kernel command line.
 +
 [listing]
@@ -820,10 +843,12 @@ only filesystem from the SquashFS and apply a writable device-mapper snapshot
 over the read only filesystem.  Using this method ensures a relatively fast
 boot and lower RAM usage. Users **must be careful** to avoid writing too many
 blocks to the snapshot volume.  Once the blocks of the snapshot overlay are
-exhausted, the root filesystem becomes unusable and requires a reboot.  A
-persistent overlay is marked Invalid, and requires a difficult recovery.
-Non-persistent overlays default to 512 MiB in RAM, but the size can be adjusted
-with the **rd.live.overlay.size=** kernel command line option.
+exhausted, the root filesystem becomes read only and may cause application
+failures.  The overlay file is marked 'Overflow', and a difficult recovery is
+required to repair and enlarge the overlay offline.  Non-persistent overlays
+are sparse files in RAM that only consume content space as required blocks are
+allocated.  They default to an apparent size of 32 GiB in RAM.  The size can be
+adjusted with the **rd.live.overlay.size=** kernel command line option.
 +
 The filesystem structure is expected to be:
 +
@@ -832,7 +857,7 @@ The filesystem structure is expected to be:
 squashfs.img          |  Squashfs from LiveCD .iso downloaded via network
    !(mount)
    /LiveOS
-       |- ext3fs.img  |  Filesystem image to mount read-only
+       |- rootfs.img  |  Filesystem image to mount read-only
             !(mount)
             /bin      |  Live filesystem
             /boot     |
@@ -854,7 +879,7 @@ of the root filesystem.
 Uncompressed live filesystem image:::
 When the live system was installed with the '--skipcompress' option of the
 __livecd-iso-to-disk__ installation script for Live USB devices, the root
-filesystem image, `ext3fs.img`, is expanded on installation and no SquashFS
+filesystem image, `rootfs.img`, is expanded on installation and no SquashFS
 is involved during boot.
 +
 - If **rd.live.ram=1** is used in this situation, the full, uncompressed
@@ -905,7 +930,8 @@ NOTE: There must be enough free RAM available to hold the complete image.
 This method is very suitable for diskless boots.
 
 **root=**live:__<url>__::
-Boots a live image retrieved from __<url>__.  Valid handlers: __http, https, ftp, torrent, tftp__.
+Boots a live image retrieved from __<url>__.  Requires dracut 'livenet' module.
+Valid handlers: __http, https, ftp, torrent, tftp__.
 +
 [listing]
 .Example
@@ -919,8 +945,8 @@ root=live:torrent://example.com/liveboot.img.torrent
 Enables debug output from the live boot process.
 
 **rd.live.dir=**__<path>__::
-Specifies the directory within the squashfs where the ext3fs.img or rootfs.img
-can be found.  By default, this is __LiveOS__.
+Specifies the directory within the boot device where the squashfs.img or
+rootfs.img can be found.  By default, this is __LiveOS__.
 
 **rd.live.squashimg=**__<filename of SquashFS image>__::
 Specifies the filename for a SquashFS image of the root filesystem.
@@ -930,7 +956,7 @@ By default, this is __squashfs.img__.
 Copy the complete image to RAM and use this for booting. This is useful
 when the image resides on, i.e., a DVD which needs to be ejected later on.
 
-**rd.live.overlay=**__<devspec>__:__(<pathspec>|auto)__|__none__::
+**rd.live.overlay={**__<devspec>__[:__{<pathspec>|auto}__]|__none__}::
 Allow the usage of a permanent overlay.
 - _<devspec>_ specifies the path to a device with a mountable filesystem.
 - _<pathspec>_ is the path to a file within that filesystem, which shall be
@@ -938,6 +964,8 @@ used to persist the changes made to the device specified by the
 **root=live:__<url>__** option.
 - _none_ specifies no overlay when an uncompressed live root filesystem is
 available.
+If a persistent overlay is detected at the standard LiveOS path, the overlay &
+overlay type detected (whether Device-mapper or OverlayFS) will be used.
 +
 [listing]
 .Example
@@ -946,11 +974,12 @@ rd.live.overlay=/dev/sdb1:persistent-overlay.img
 --
 
 **rd.live.overlay.size=**__<size_MiB>__::
-Specifies a non-persistent overlay size in MiB.  The default is _512_.
+Specifies a non-persistent overlay size in MiB.  The default is _32768_.
 
 **rd.live.overlay.readonly=**1::
 Specifies a non-persistent, writable snapshot overlay to be stacked over a
-read-only snapshot of the root filesystem, `/dev/mapper/live-ro`.
+read-only snapshot of the root filesystem, `/dev/mapper/live-ro`, or a read-
+only loop device of a writable `rootfs.img`.
 
 **rd.live.overlay.reset=**1::
 Specifies that a persistent overlay should be reset on boot.  All root
@@ -963,6 +992,57 @@ blocks that are not claimed by the filesystem. In this use case, this means
 that memory is given back to the kernel when the filesystem does not claim it
 anymore.
 
+**rd.live.overlay.overlayfs=**1::
+Enables the use of the **OverlayFS** kernel module, if available, to provide a
+copy-on-write union directory for the root filesystem.  OverlayFS overlays are
+directories of the files that have changed on the read-only base (lower)
+filesystem.  The root filesystem is provided through a special overlay type
+mount that merges the lower and upper directories.  If an OverlayFS upper
+directory is not present on the boot device, a tmpfs directory will be created
+at /run/overlayfs to provide temporary storage.  Persistent storage can be
+provided on vfat or msdos formatted devices by supplying the OverlayFS upper
+directory within an embedded filesystem that supports the creation of trusted.*
+extended attributes and provides a valid d_type in readdir responses, such as
+with ext4 and xfs.  On non-vfat-formatted devices, a persistent OverlayFS
+overlay can extend the available root filesystem storage up to the capacity of
+the LiveOS device.
++
+If a persistent overlay is detected at the standard LiveOS path, the overlay &
+overlay type detected (whether OverlayFS or Device-mapper) will be used.
++
+The **rd.live.overlay.readonly** option, which allows a persistent overlayfs to
+be mounted read only through a higher level transient overlay directory, has
+been implemented through the multiple lower layers feature of OverlayFS.
+
+
+ZIPL
+~~~~
+**rd.zipl=**__<path to blockdevice>__::
+    Update the dracut commandline with the values found in the
+    _dracut-cmdline.conf_ file on the given device.
+    The values are merged into the existing commandline values
+    and the udev events are regenerated.
++
+[listing]
+.Example
+--
+rd.zipl=UUID=0fb28157-99e3-4395-adef-da3f7d44835a
+--
+
+CIO_IGNORE
+~~~~~~~~~~
+**rd.cio_accept=**__<device-ids>__::
+    Remove the devices listed in <device-ids> from the default
+    cio_ignore kernel command-line settings.
+    <device-ids> is a list of comma-separated CCW device ids.
+    The default for this value is taken from the
+    _/boot/zipl/active_devices.txt_ file.
++
+[listing]
+.Example
+--
+rd.cio_accept=0.0.0180,0.0.0800,0.0.0801,0.0.0802
+--
 
 Plymouth Boot Splash
 ~~~~~~~~~~~~~~~~~~~~
@@ -1017,7 +1097,8 @@ their new replacement.
 
 rdbreak:: rd.break
 
-rd_CCW:: rd.ccw
+rd.ccw:: rd.znet
+rd_CCW:: rd.znet
 
 rd_DASD_MOD:: rd.dasd