[pve-devel] [PATCH docs 2/2] Refer to the bootloader chapter in remaining docs

[Fabian Grünbichler]

On Fri, Jul 05, 2019 at 06:31:40PM +0200, Stoiko Ivanov wrote:
> Editing the kernel commandline is described centrally in the bootloaders
> chapter. Refer to it where appropriate (qm-pci-passthrough.adoc).
> 
> Additionally update the documentation on ZFS as rpool to the inclusion of
> `systemd-boot`
> 
> Signed-off-by: Stoiko Ivanov <s.ivanov at proxmox.com>
> ---
>  local-zfs.adoc          | 20 ++++++++++----------
>  qm-pci-passthrough.adoc | 26 +++++++++++---------------
>  2 files changed, 21 insertions(+), 25 deletions(-)
> 
> diff --git a/local-zfs.adoc b/local-zfs.adoc
> index 13f6050..aae89e0 100644
> --- a/local-zfs.adoc
> +++ b/local-zfs.adoc
> @@ -154,15 +154,9 @@ rpool/swap        4.25G  7.69T    64K  -
>  Bootloader
>  ~~~~~~~~~~
>  
> -The default ZFS disk partitioning scheme does not use the first 2048
> -sectors. This gives enough room to install a GRUB boot partition. The
> -{pve} installer automatically allocates that space, and installs the
> -GRUB boot loader there. If you use a redundant RAID setup, it installs
> -the boot loader on all disk required for booting. So you can boot
> -even if some disks fail.
> -
> -NOTE: It is not possible to use ZFS as root file system with UEFI
> -boot.
> +Depending on whether the system is booted in EFI or legacy BIOS mode the
> +{pve} installer sets up either `grub` or `systemd-boot` as main bootloader.
> +See the chapter on  xref:system_booting[bootladers] for details.
>  
>  
>  ZFS Administration
> @@ -255,7 +249,13 @@ can be used as cache.
>  
>  .Changing a failed device
>  
> - zpool replace -f <pool> <old device> <new-device>
> + zpool replace -f <pool> <old device> <new device>
> +
> +.Changing a failed bootable device when using systemd-boot
> +
> + sgdisk <healthy bootable device> -R <new device>
> + sgdisk -G <new device>
> + zpool replace -f <pool> <old zfs partition> <new zfs partition>

this is incomplete insofar as the new device is no longer actually
bootable ;) there is a more extensive wiki page[1], maybe we could pull
some of that in and update it for systemd-boot, then drop the wiki
page/section?

1:
https://pve.proxmox.com/wiki/ZFS:_Tips_and_Tricks#Replacing_a_failed_disk_in_the_root_pool

>  
>  
>  Activate E-Mail Notification
> diff --git a/qm-pci-passthrough.adoc b/qm-pci-passthrough.adoc
> index 3895df4..a661848 100644
> --- a/qm-pci-passthrough.adoc
> +++ b/qm-pci-passthrough.adoc
> @@ -45,9 +45,10 @@ some configuration to enable PCI(e) passthrough.
>  
>  .IOMMU
>  
> -The IOMMU has to be activated on the kernel commandline. The easiest way is to
> -enable trough grub. Edit `'/etc/default/grub'' and add the following to the
> -'GRUB_CMDLINE_LINUX_DEFAULT' variable:
> +The IOMMU has to be activated on the
> +xref:edit_kernel_cmdline[kernel commandline].
> +
> +The command line parameters are:
>  
>  * for Intel CPUs:
>  +
> @@ -60,12 +61,6 @@ enable trough grub. Edit `'/etc/default/grub'' and add the following to the
>   amd_iommu=on
>  ----
>  
> -[[qm_pci_passthrough_update_grub]]
> -To bring this change in effect, make sure you run:
> -
> -----
> -# update-grub
> -----
>  
>  .Kernel Modules
>  
> @@ -87,6 +82,9 @@ After changing anything modules related, you need to refresh your
>  # update-initramfs -u -k all
>  ----
>  
> +If you are using `systemd-boot` for booting you additionally need to
> +xref:systemd-boot-refresh[sync the new initramfs to the bootable partitions].
> +
>  .Finish Configuration
>  
>  Finally reboot to bring the changes into effect and check that it is indeed
> @@ -316,10 +314,9 @@ Intels drivers for GVT-g are integrated in the Kernel and should work
>  with 5th, 6th and 7th generation Intel Core Processors, as well as E3 v4, E3
>  v5 and E3 v6 Xeon Processors.
>  
> -To enable it for Intel Graphcs, you have to make sure to load the module
> -'kvmgt' (for example via `/etc/modules`) and to enable it on the Kernel
> -commandline. For this you can edit `'/etc/default/grub'' and add the following
> -to the 'GRUB_CMDLINE_LINUX_DEFAULT' variable:
> +To enable it for Intel Graphics, you have to make sure to load the module
> +'kvmgt' (for example via `/etc/modules`) and to enable it on the
> +xref:edit_kernel_cmdline[Kernel commandline] and add the following parameter:
>  
>  ----
>   i915.enable_gvt=1
> @@ -327,8 +324,7 @@ to the 'GRUB_CMDLINE_LINUX_DEFAULT' variable:
>  
>  After that remember to
>  xref:qm_pci_passthrough_update_initramfs[update the `initramfs`],
> -xref:qm_pci_passthrough_update_grub[update grub] and
> -reboot your host.
> +and reboot your host.
>  
>  VM Configuration
>  ^^^^^^^^^^^^^^^^
> -- 
> 2.20.1
> 
> 
> _______________________________________________
> pve-devel mailing list
> pve-devel at pve.proxmox.com
> https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel