From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id B74C61FF380 for ; Fri, 19 Apr 2024 11:05:58 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id EA74C3426; Fri, 19 Apr 2024 11:05:44 +0200 (CEST) From: Christoph Heiss To: pve-devel@lists.proxmox.com Date: Fri, 19 Apr 2024 11:05:09 +0200 Message-ID: <20240419090519.291775-4-c.heiss@proxmox.com> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240419090519.291775-1-c.heiss@proxmox.com> References: <20240419090519.291775-1-c.heiss@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.001 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [RFC PATCH docs-common 03/13] partials: add installation flow from pve-docs X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Signed-off-by: Christoph Heiss --- partials/installation-flow.adoc | 170 ++++++++++++++++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 partials/installation-flow.adoc diff --git a/partials/installation-flow.adoc b/partials/installation-flow.adoc new file mode 100644 index 0000000..b796676 --- /dev/null +++ b/partials/installation-flow.adoc @@ -0,0 +1,170 @@ +NOTE: All existing data on the selected drives will be removed during the +installation process. The installer does not add boot menu entries for other +operating systems. + +Please insert the xref:installation_prepare_media[prepared installation media] +(for example, USB flash drive or CD-ROM) and boot from it. + +TIP: Make sure that booting from the installation medium (for example, USB) is +enabled in your server's firmware settings. Secure boot needs to be disabled +when booting an installer prior to {pve} version 8.1. + +[thumbnail="screenshot/pve-grub-menu.png"] + +After choosing the correct entry (for example, 'Boot from USB') the {pve} menu +will be displayed, and one of the following options can be selected: + +Install {pve} (Graphical):: + +Starts the normal installation. + +TIP: It's possible to use the installation wizard with a keyboard only. Buttons +can be clicked by pressing the `ALT` key combined with the underlined character +from the respective button. For example, `ALT + N` to press a `Next` button. + +Install {pve} (Terminal UI):: + +Starts the terminal-mode installation wizard. It provides the same overall +installation experience as the graphical installer, but has generally better +compatibility with very old and very new hardware. + +Install {pve} (Terminal UI, Serial Console):: + +Starts the terminal-mode installation wizard, additionally setting up the Linux +kernel to use the (first) serial port of the machine for in- and output. This +can be used if the machine is completely headless and only has a serial console +available. + +[thumbnail="screenshot/pve-tui-installer.png"] + +Both modes use the same code base for the actual installation process to +benefit from more than a decade of bug fixes and ensure feature parity. + +TIP: The 'Terminal UI' option can be used in case the graphical installer does +not work correctly, due to e.g. driver issues. See also +xref:nomodeset_kernel_param[adding the `nomodeset` kernel parameter]. + +Advanced Options: Install {pve} (Graphical, Debug Mode):: + +Starts the installation in debug mode. A console will be opened at several +installation steps. This helps to debug the situation if something goes wrong. +To exit a debug console, press `CTRL-D`. This option can be used to boot a live +system with all basic tools available. You can use it, for example, to +xref:chapter_zfs[repair a degraded ZFS 'rpool'] or fix the +xref:sysboot[bootloader] for an existing {pve} setup. + +Advanced Options: Install {pve} (Terminal UI, Debug Mode):: + +Same as the graphical debug mode, but preparing the system to run the +terminal-based installer instead. + +Advanced Options: Install {pve} (Serial Console Debug Mode):: + +Same the terminal-based debug mode, but additionally sets up the Linux kernel to +use the (first) serial port of the machine for in- and output. + +Advanced Options: Rescue Boot:: + +With this option you can boot an existing installation. It searches all attached +hard disks. If it finds an existing installation, it boots directly into that +disk using the Linux kernel from the ISO. This can be useful if there are +problems with the bootloader (GRUB/`systemd-boot`) or the BIOS/UEFI is unable to +read the boot block from the disk. + +Advanced Options: Test Memory (memtest86+):: + +Runs `memtest86+`. This is useful to check if the memory is functional and free +of errors. Secure Boot must be turned off in the UEFI firmware setup utility to +run this option. + +You normally select *Install {pve} (Graphical)* to start the installation. + +[thumbnail="screenshot/pve-select-target-disk.png"] + +The first step is to read our EULA (End User License Agreement). Following this, +you can select the target hard disk(s) for the installation. + +CAUTION: By default, the whole server is used and all existing data is removed. +Make sure there is no important data on the server before proceeding with the +installation. + +The `Options` button lets you select the target file system, which +defaults to `ext4`. The installer uses LVM if you select +`ext4` or `xfs` as a file system, and offers additional options to +restrict LVM space (see xref:advanced_lvm_options[below]). + +{pve} can also be installed on ZFS. As ZFS offers several software RAID levels, +this is an option for systems that don't have a hardware RAID controller. The +target disks must be selected in the `Options` dialog. More ZFS specific +settings can be changed under xref:advanced_zfs_options[`Advanced Options`]. + +WARNING: ZFS on top of any hardware RAID is not supported and can result in data +loss. + +[thumbnail="screenshot/pve-select-location.png"] + +The next page asks for basic configuration options like your location, time +zone, and keyboard layout. The location is used to select a nearby download +server, in order to increase the speed of updates. The installer is usually able +to auto-detect these settings, so you only need to change them in rare +situations when auto-detection fails, or when you want to use a keyboard layout +not commonly used in your country. + +[thumbnail="screenshot/pve-set-password.png", float="left"] + +Next the password of the superuser (`root`) and an email address needs to be +specified. The password must consist of at least 5 characters. It's highly +recommended to use a stronger password. Some guidelines are: + +- Use a minimum password length of at least 12 characters. + +- Include lowercase and uppercase alphabetic characters, numbers, and symbols. + +- Avoid character repetition, keyboard patterns, common dictionary words, + letter or number sequences, usernames, relative or pet names, romantic links + (current or past), and biographical information (for example ID numbers, + ancestors' names or dates). + +The email address is used to send notifications to the system administrator. +For example: + +- Information about available package updates. + +- Error messages from periodic 'cron' jobs. + +[thumbnail="screenshot/pve-setup-network.png"] + +All those notification mails will be sent to the specified email address. + +The last step is the network configuration. Network interfaces that are 'UP' +show a filled circle in front of their name in the drop down menu. Please note +that during installation you can either specify an IPv4 or IPv6 address, but not +both. To configure a dual stack node, add additional IP addresses after the +installation. + +[thumbnail="screenshot/pve-installation.png", float="left"] + +The next step shows a summary of the previously selected options. Please +re-check every setting and use the `Previous` button if a setting needs to be +changed. + +After clicking `Install`, the installer will begin to format the disks and copy +packages to the target disk(s). Please wait until this step has finished; then +remove the installation medium and restart your system. + +[thumbnail="screenshot/pve-install-summary.png"] + +Copying the packages usually takes several minutes, mostly depending on the +speed of the installation medium and the target disk performance. + +When copying and setting up the packages has finished, you can reboot the +server. This will be done automatically after a few seconds by default. + +.Installation Failure + +If the installation failed, check out specific errors on the second TTY +('CTRL + ALT + F2') and ensure that the systems meets the +xref:install_minimal_requirements[minimum requirements]. + +If the installation is still not working, look at the +xref:getting_help[how to get help chapter]. -- 2.44.0 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel