external metrics server: extend docs to explain http api

[pve-docs.git] / system-booting.adoc

diff --git a/system-booting.adoc b/system-booting.adoc
index 2bd32a60435281ec99556ee7435c2e2a7bb214e7..24ceb7ee91df8ed7b2809ea0763193bad64d9d48 100644 (file)
--- a/system-booting.adoc
+++ b/system-booting.adoc
@@ -12,8 +12,9 @@ For EFI Systems installed with ZFS as the root filesystem `systemd-boot` is
 used. All other deployments use the standard `grub` bootloader (this usually
 also applies to systems which are installed on top of Debian).
 
 used. All other deployments use the standard `grub` bootloader (this usually
 also applies to systems which are installed on top of Debian).
 

+

 [[sysboot_installer_part_scheme]]
 [[sysboot_installer_part_scheme]]

-Partitioning scheme used by the installer
+Partitioning Scheme Used by the Installer

 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The {pve} installer creates 3 partitions on the bootable disks selected for
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The {pve} installer creates 3 partitions on the bootable disks selected for


@@ -39,6 +40,45 @@ The created partitions are:
 Partition of all bootable disks for supporting older systems.
 
 
 Partition of all bootable disks for supporting older systems.
 
 

+[[sysboot_determine_bootloader_used]]
+Determine which Bootloader is Used
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+[thumbnail="screenshot/boot-grub.png", float="left"]
+
+The simplest and most reliable way to determine which bootloader is used, is to
+watch the boot process of the {pve} node.
+
+You will either see the blue box of `grub` or the simple black on white
+`systemd-boot`.
+
+[thumbnail="screenshot/boot-systemdboot.png"]
+
+Determining the bootloader from a running system might not be 100% accurate. The
+safest way is to run the following command:
+
+
+----
+# efibootmgr -v
+----
+
+If it returns a message that EFI variables are not supported, `grub` is used in
+BIOS/Legacy mode.
+
+If the output contains a line that looks similar to the following, `grub` is
+used in UEFI mode.
+
+----
+Boot0005* proxmox      [...] File(\EFI\proxmox\grubx64.efi)
+----
+
+If the output contains a line similar to the following, `systemd-bood` is used.
+
+----
+Boot0006* Linux Boot Manager   [...] File(\EFI\systemd\systemd-bootx64.efi)
+----
+
+

 [[sysboot_grub]]
 Grub
 ~~~~
 [[sysboot_grub]]
 Grub
 ~~~~


@@ -120,7 +160,7 @@ initrd   /EFI/proxmox/5.0.15-1-pve/initrd.img-5.0.15-1-pve
 .Manually keeping a kernel bootable
 
 Should you wish to add a certain kernel and initrd image to the list of
 .Manually keeping a kernel bootable
 
 Should you wish to add a certain kernel and initrd image to the list of

-bootable kernel use `pve-efiboot-tool kernel add`.
+bootable kernels use `pve-efiboot-tool kernel add`.

 
 For example run the following to add the kernel with ABI version `5.0.15-1-pve`
 to the list of kernels to keep installed and synced to all ESPs:
 
 For example run the following to add the kernel with ABI version `5.0.15-1-pve`
 to the list of kernels to keep installed and synced to all ESPs:


@@ -149,6 +189,8 @@ selected kernels, for example:
 pve-efiboot-tool kernel remove 5.0.15-1-pve
 ----
 
 pve-efiboot-tool kernel remove 5.0.15-1-pve
 ----
 

+NOTE: It's required to run `pve-efiboot-tool refresh` to update all EFI System
+Partitions (ESPs) after a manual kernel addition or removal from above.

 
 [[sysboot_systemd_boot_setup]]
 .Setting up a new partition for use as synced ESP
 
 [[sysboot_systemd_boot_setup]]
 .Setting up a new partition for use as synced ESP


@@ -181,19 +223,26 @@ trigger a refresh of all configured ESPs.
 .Updating the configuration on all ESPs
 
 To copy and configure all bootable kernels and keep all ESPs listed in
 .Updating the configuration on all ESPs
 
 To copy and configure all bootable kernels and keep all ESPs listed in

-`/etc/kernel/pve-efiboot-uuids` in sync you just need to run `pve-efiboot-tool
-refresh`.
-(The equivalent to running `update-grub` on Systems being booted with `grub`).
+`/etc/kernel/pve-efiboot-uuids` in sync you just need to run:
+
+----
+ pve-efiboot-tool refresh
+----
+(The equivalent to running `update-grub` on systems being booted with `grub`).

 
 This is necessary should you make changes to the kernel commandline, or want to
 
 This is necessary should you make changes to the kernel commandline, or want to

-sync all kernels and initrds after regenerating the latter.
+sync all kernels and initrds.
+
+NOTE: Both `update-initramfs` and `apt` (when necessary) will automatically
+trigger a refresh.
+

 
 [[sysboot_edit_kernel_cmdline]]
 
 [[sysboot_edit_kernel_cmdline]]

-Editing the kernel commandline
+Editing the Kernel Commandline

 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can modify the kernel commandline in the following places, depending on the
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can modify the kernel commandline in the following places, depending on the

-bootloarder used:
+bootloader used:

 
 .Grub
 
 
 .Grub
 


@@ -204,6 +253,6 @@ The kernel commandline needs to be placed in the variable
 
 .Systemd-boot
 
 
 .Systemd-boot
 

-The kernel commandline needs to be placed as line in `/etc/kernel/cmdline`
-Running `/etc/kernel/postinst.d/zz-pve-efiboot` sets it as `option` line for
-all config files in `loader/entries/proxmox-*.conf`.
+The kernel commandline needs to be placed as one line in `/etc/kernel/cmdline`.
+To apply your changes, run `pve-efiboot-tool refresh`, which sets it as the
+`option` line for all config files in `loader/entries/proxmox-*.conf`.