[pve-devel] [PATCH docs 1/3] Rewrite Installation

Mon Jun 17 15:02:34 CEST 2019

Polished phrasing, added mentions of the EULA and summary page in the
installer, unified style of cli commands.

Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
---
 pve-installation.adoc | 251 ++++++++++++++++++++++--------------------
 1 file changed, 129 insertions(+), 122 deletions(-)

diff --git a/pve-installation.adoc b/pve-installation.adoc
index 691d236..07b5b2c 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -1,5 +1,5 @@
-Installing Proxmox VE
-=====================
+Installing {pve}
+================
 ifndef::manvolnum[]
 :pve-toplevel:
 endif::manvolnum[]
@@ -7,19 +7,20 @@ ifdef::wiki[]
 :title: Installation
 endif::wiki[]
 
-{pve} is based on Debian, therefore the disk image (ISO file) provided
-by us includes a complete Debian system ("stretch" for version 5.x) as
-well as all necessary {pve} packages.
+{pve} is based on Debian. This is why the install disk images (ISO
+files) provided by Proxmox include a complete Debian system (Debian 9
+"stretch" for {pve} version 5.x) as well as all necessary {pve}
+packages.
 
-Using the installer will guide you through the setup, allowing
-you to partition the local disk(s), apply basic system configurations
-(e.g. timezone, language, network) and install all required packages.
-Using the provided ISO will get you started in just a few minutes,
-that's why we recommend this method for new and existing users.
+The installer will guide through the setup, allowing you to partition
+the local disk(s), apply basic system configurations (e.g. timezone,
+language, network) and install all required packages. This process
+should not take more than a few minutes. Installing with the provided
+ISO is the recommended method for new and existing users.
 
 Alternatively, {pve} can be installed on top of an existing Debian
-system. This option is only recommended for advanced users since
-detailed knowledge about {pve} is necessary.
+system. This option is only recommended for advanced users as
+detailed knowledge about {pve} is required.
 
 ifndef::wiki[]
 
@@ -31,7 +32,7 @@ endif::wiki[]
 Using the {pve} Installer
 -------------------------
 
-You can download the ISO from {website}en/downloads.
+The installer ISO file can be downloaded from {website}en/downloads.
 It includes the following:
 
 * Complete operating system (Debian Linux, 64-bit)
@@ -41,115 +42,118 @@ It includes the following:
 
 * {pve} kernel (Linux) with LXC and KVM support
 
-* Complete toolset for administering virtual machines, containers and
+* Complete tool set for administering virtual machines, containers and
   all necessary resources
 
-* Web based management interface for using the toolset
+* Web based management interface
 
-NOTE: During the installation process, the complete server
-is used by default and all existing data is removed.
+NOTE: The installation will, by default, remove all data on the
+selected disk(s).
 
-Please insert the installation media (e.g. USB stick, CD-ROM) and boot
-from it.
+Please insert the installation media (e.g. USB flash drive, CD-ROM)
+and boot from it.
 
 [thumbnail="screenshot/pve-grub-menu.png"]
 
 After choosing the correct entry (e.g. Boot from USB) the {pve} menu
-will be displayed, you can now select one of the following options:
+will be displayed and one of the following options can be selected:
 
-Install Proxmox VE::
+Install {pve}::
 
-Start normal installation.
+Starts the normal installation.
 
-TIP: It is possible to only use the keyboard to progress through the
-installation wizard. Buttons can be pressed by pressing down the `ALT`
-key, combined with the underlined character from the respective Button.
-For example, `ALT + N` to press a `Next` button.
+TIP: It is possible to only use the keyboard. 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 Proxmox VE (Debug mode)::
+Install {pve} (Debug mode)::
 
-Start installation in debug mode. It opens a shell console at several
-installation steps, so that you can debug things if something goes
-wrong. Please press `CTRL-D` to exit those debug consoles and continue
-installation. This option is mostly for developers and not meant for
-general use.
+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. Please press `CTRL-D` to exit those debug
+consoles and continue the installation. This option is primarily for
+developers and not meant for general use.
 
 Rescue Boot::
 
-This option allows you to boot an existing installation. It searches
+This option allows to boot an existing installation. It searches
 all attached hard disks and, if it finds an existing installation,
-boots directly into that disk using the existing Linux kernel. This
-can be useful if there are problems with the boot block (grub), or the
-BIOS is unable to read the boot block from the disk.
+boots directly into that disk using the Linux kernel from the ISO.
+This can be useful if there are problems with the boot block (grub) or
+the BIOS is unable to read the boot block from the disk.
 
 Test Memory::
 
-Runs `memtest86+`. This is useful to check if your memory is
-functional and error free.
+Runs `memtest86+`. This is useful to check if the memory is
+functional and free of errors.
 
 [thumbnail="screenshot/pve-select-target-disk.png"]
 
-You normally select *Install Proxmox VE* to start the installation.
-After that you get prompted to select the target hard disk(s). The
-`Options` button lets you select the target file system, which
-defaults to `ext4`. The installer uses LVM if you select `ext3`,
-`ext4` or `xfs` as file system, and offers additional option to
-restrict LVM space (see <<advanced_lvm_options,below>>)
+After selecting *Install {pve}* and accepting the EULA the prompt
+to select the target dist(s) will appear.
+The `Options` button opens the dialog to select the target file
+system.
 
-You can also use ZFS as file system. ZFS supports several software RAID
-levels, so this is specially useful if you do not have a hardware RAID
-controller. The `Options` button lets you select the ZFS RAID level, and
-you can choose disks there. Additionally you can set additional options (see
-<<advanced_zfs_options,below>>).
+The default file system is `ext4`. LVM is used when `ext3`, `ext4` or
+`xfs` ist selected. Additional options to restrict LVM space can be set
+(see <<advanced_lvm_options,below>>).
+
+{pve} can be installed on ZFS. The file system drop down offers
+different ZFS RAID levels to choose from. The target disks must be
+selected in the `Options` dialog. More ZFS specific settings can be
+changed under `Advanced Options` (see <<advanced_zfs_options,below>>).
 
 [thumbnail="screenshot/pve-select-location.png", float="left"]
 
-The next page just asks for basic configuration options like your
+The next page asks for basic configuration options like the
 location, the time zone and keyboard layout. The location is used to
-select a download server near you to speed up updates. The installer is
-usually able to auto detect those settings, so you only need to change
-them in rare situations when auto detection fails, or when you want to
-use some special keyboard layout not commonly used in your country.
+select a download server close by to speed up updates. The installer
+usually auto-detects these settings and they only need to be changed
+in the rare case that auto detection fails or a different keyboard
+layout should be used.
 
 [thumbnail="screenshot/pve-set-password.png"]
 
-You then need to specify an email address and the superuser (root)
-password. The password must have at least 5 characters, but we highly
-recommend to use stronger passwords - here are some guidelines:
+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 is highly recommended to use a stronger password. Some guidelines
+are:
 
 - Use a minimum password length of 12 to 14 characters.
 
-- Include lowercase and uppercase alphabetic characters, numbers and symbols.
+- Include lowercase and uppercase alphabetic characters, numbers and
+  symbols.
 
-- Avoid character repetition, keyboard patterns, dictionary words,
-  letter or number sequences, usernames, relative or pet names,
+- 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 (e.g.,
   ID numbers, ancestors' names or dates).
 
-It is sometimes necessary to send notifications to the system
-administrator, for example:
+The email address is used to send notifications to the systems
+administrator like:
 
 - Information about available package updates.
 
 - Error messages from periodic CRON jobs.
 
-All those notification mails will be sent to the specified email
-address.
-
 [thumbnail="screenshot/pve-setup-network.png"]
 
-The last step is the network configuration. Please note that you can
-use either IPv4 or IPv6 here, but not both. If you want to configure a
-dual stack node, you can easily do that after installation.
+The last step is the network configuration. Please note that during
+installation either a IPv4 or IPv6 address can be used here, but not
+both. Additional IP addresses can be configured after the successful
+installation.
 
 [thumbnail="screenshot/pve-installation.png", float="left"]
 
-If you press `Next` now, installation starts to format disks, and
-copies packages to the target. Please wait until that is finished,
-then remove the installation media and restart your system.
+The next step will show a summary of the previously selected
+options. After acknowledging this by pressing `Next` the installation
+will start to format disks, and copy packages to the target. Please
+wait until it is finished, then remove the installation medium and
+restart your system.
 
-Further configuration is done via the Proxmox web interface. Just
-point your browser to the IP address given during installation
+Further configuration is done via the Proxmox web interface. Point
+your browser to the IP address given during installation
 (https://youripaddress:8006).
 
 NOTE: Default login is "root" (realm 'PAM') and the root password is
@@ -162,47 +166,49 @@ Advanced LVM Configuration Options
 
 The installer creates a Volume Group (VG) called `pve`, and additional
 Logical Volumes (LVs) called `root`, `data` and `swap`. The size of
-those volumes can be controlled with:
+these volumes can be controlled with:
 
 `hdsize`::
 
-Defines the total HD size to be used. This way you can save free
-space on the HD for further partitioning (i.e. for an additional PV
-and VG on the same hard disk that can be used for LVM storage).
+Defines the total hard disk size to be used. This way free space can
+be set aside on the hard disk for further partitioning (i.e. for an
+additional PV and VG on the same hard disk that can be used for
+LVM storage).
 
 `swapsize`::
 
 Defines the size of the `swap` volume. The default is the size of the
-installed memory, minimum 4 GB and maximum 8 GB. The resulting value cannot
-be greater than `hdsize/8`.
+installed memory, minimum 4 GiB and maximum 8 GiB. The resulting value
+cannot be greater than `hdsize/8`.
 +
 NOTE: If set to `0`, no `swap` volume will be created.
 
 `maxroot`::
 
-Defines the maximum size of the `root` volume, which stores the operation
-system. The maximum limit of the `root` volume size is `hdsize/4`.
+Defines the maximum size of the `root` volume, which stores the
+operation system. The maximum limit of the `root` volume size is
+`hdsize/4`.
 
 `maxvz`::
 
-Defines the maximum size of the `data` volume. The actual size of the `data`
-volume is:
+Defines the maximum size of the `data` volume. The actual size of the
+`data` volume is:
 +
 `datasize = hdsize - rootsize - swapsize - minfree`
 +
 Where `datasize` cannot be bigger than `maxvz`.
 +
-NOTE: In case of LVM thin, the `data` pool will only be created if `datasize`
-is bigger than 4GB.
+NOTE: In case of LVM thin, the `data` pool will only be created if
+`datasize` is bigger than 4GB.
 +
 NOTE: If set to `0`, no `data` volume will be created and the storage
 configuration will be adapted accordingly.
 
 `minfree`::
 
-Defines the amount of free space left in LVM volume group `pve`.
-With more than 128GB storage available the default is 16GB, else `hdsize/8`
-will be used.
+Defines the amount of free space left in the LVM volume group `pve`.
+With more than 128GB storage available the default is 16GB, else
+`hdsize/8` will be used.
 +
 NOTE: LVM requires free space in the VG for snapshot creation (not
 required for lvmthin snapshots).
@@ -210,17 +216,18 @@ required for lvmthin snapshots).
 [[advanced_zfs_options]]
 Advanced ZFS Configuration Options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The installer creates a ZFS pool `rpool`. When selecting ZFS, no swap space is
-created by default. You can leave some unpartitioned space for swap or create
-a swap zvol after installation, though the latter can lead to problems
-(see <<zfs_swap,ZFS swap notes>>).
+The installer creates the ZFS pool `rpool`. No swap space is created
+by default when installing to ZFS. Unpartitioned space can be left for
+swap or a swap zvol created after installation, though the latter can
+lead to problems (see <<zfs_swap,ZFS swap notes>>).
 
 `ashift`::
 
 Defines the `ashift` value for the created pool. The `ashift` needs
 to be set at least to the sector-size of the underlying disks (2 to
 the power of `ashift` is the sector-size), or any disk,
-which might be put in the pool (e.g. during replacing a defective disk).
+which might be put in the pool (e.g. during replacing a defective
+disk).
 
 `compress`::
 
@@ -232,27 +239,29 @@ Defines which checksumming algorithm should be used for `rpool`.
 
 `copies`::
 
-Defines the `copies` parameter for `rpool`. Check the `zfs(8)` manpage for the
-semantics, and why this does not replace redundancy on disk-level.
+Defines the `copies` parameter for `rpool`. Check the `zfs(8)` manpage
+for the semantics, and why this does not replace redundancy on
+disk-level.
 
 `hdsize`::
 
-Defines the total HD size to be used. This way you can save free
-space on the HD(s) for further partitioning (e.g. for creating a swap-partition).
-`hdsize` is only honored for bootable disks, i.e., only the first disk or
-mirror for RAID0, RAID1 or RAID10, and all disks in RAID-Z[123].
+Defines the total HD size to be used. Useful to save free space on
+the HD(s) for further partitioning (e.g. for creating a
+swap-partition). `hdsize` is only honored for bootable disks, i.e.,
+only the first disk or mirror for RAID0, RAID1 or RAID10, and all
+disks in RAID-Z[123].
 
 
 ZFS Performance Tips
 ~~~~~~~~~~~~~~~~~~~~
 
-ZFS uses a lot of memory, so it is best to add additional RAM if you
-want to use ZFS. A good calculation is 4GB plus 1GB RAM for each TB
+It is best to add additional RAM if ZFS is used to account for its
+memory usage. A good calculation is 4GiB plus 1GiB RAM for each TiB
 RAW disk space.
 
-ZFS also provides the feature to use a fast SSD drive as write cache. The
-write cache is called the ZFS Intent Log (ZIL). You can add that after
-installation using the following command:
+ZFS can use a fast SSD drive as write cache, called the ZFS Intent
+Log (ZIL). It can be added after installation with the following
+command:
 
  zpool add <pool-name> log </dev/path_to_fast_ssd>
 
@@ -262,8 +271,8 @@ ifdef::wiki[]
 link:/wiki/Install_from_USB_Stick[Install from USB Stick]
 ---------------------------------------------------------
 
-link:/wiki/Install_Proxmox_VE_on_Debian_Stretch[Install Proxmox VE on Debian Stretch]
--------------------------------------------------------------------------------------
+link:/wiki/Install_Proxmox_VE_on_Debian_Stretch[Install {pve} on Debian Stretch]
+--------------------------------------------------------------------------------
 
 endif::wiki[]
 
@@ -271,29 +280,27 @@ ifndef::wiki[]
 
 include::pve-usbstick.adoc[]
 
-Install {pve} on Debian
------------------------
+Install {pve} on top of Debian
+------------------------------
 
-{pve} ships as a set of Debian packages, so you can install it
-on top of a standard Debian installation.
-xref:sysadmin_package_repositories[After configuring the repositories], you
-need to run:
+{pve} ships as a set of Debian packages and can be installed on top
+of a standard Debian installation.
+xref:sysadmin_package_repositories[After configuring the repositories]
+the following commands need to be run:
 
-[source,bash]
 ----
-apt-get update
-apt-get install proxmox-ve
+# apt-get update
+# apt-get install proxmox-ve
 ----
 
 Installing on top of an existing Debian installation looks easy, but
-it presumes that you have correctly installed the base system, and you
-know how you want to configure and use the local storage. Network
-configuration is also completely up to you.
+it presumes that the base system has been installed correctly and that
+you know how you want to configure and use the local storage. The
+Network configuration needs be handled manually as well.
 
-In general, this is not trivial, especially when you use LVM or
-ZFS.
+In general, this is not trivial, especially when LVM or ZFS is used.
 
-You can find a detailed step by step how-to guide on the
+A detailed step by step how-to can be found on the
 {webwiki-url}Install_Proxmox_VE_on_Debian_Stretch[wiki].
 
 
@@ -305,7 +312,7 @@ Video Tutorials
 ---------------
 
 * List of all official tutorials on our
-  http://www.youtube.com/proxmoxve[Proxmox VE YouTube Channel]
+  http://www.youtube.com/proxmoxve[{pve} YouTube Channel]
 
 * Tutorials in Spanish language on
   http://www.youtube.com/playlist?list=PLUULBIhA5QDBdNf1pcTZ5UXhek63Fij8z[ITexperts.es
-- 
2.20.1



