From 03c03402b9954b859247af9572281b1c728221bc Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Thu, 21 Dec 2017 12:28:27 +0100 Subject: [PATCH] add pmg-installation.adoc --- pmg-admin-guide.adoc | 2 + pmg-installation.adoc | 184 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 186 insertions(+) create mode 100644 pmg-installation.adoc diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc index bdad9ac..f7a7a15 100644 --- a/pmg-admin-guide.adoc +++ b/pmg-admin-guide.adoc @@ -25,6 +25,8 @@ include::pmg-quick-start.adoc[] include::pmg-planning-deployment.adoc[] +include::pmg-installation.adoc[] + include::pmgconfig.adoc[] // Return to normal title levels. diff --git a/pmg-installation.adoc b/pmg-installation.adoc new file mode 100644 index 0000000..dc5b19f --- /dev/null +++ b/pmg-installation.adoc @@ -0,0 +1,184 @@ +Installation +============ + +{pmg} is based on Debian and comes with an installation CD-ROM +which includes a complete Debian ("stretch" for version 5.x) system as +well as all necessary {pmg} packages. + +The installer just asks you a few questions, then partitions the local +disk(s), installs all required packages, and configures the system +including a basic network setup. You can get a fully functional system +within a few minutes. This is the preferred and recommended +installation method. + +Alternatively, {pmg} can be installed on top of an existing Debian +system. This option is only recommended for advanced users since +it requires more detailed knowledge about {pmg} and Debian. + +Using the {pmg} Installation CD-ROM +----------------------------------- + +Includes the following: + +* Complete operating system (Debian Linux, 64-bit) + +* Partitioning of the hard drive(s) containing the operating system + with ext4, ext3, xfs or ZFS + +* Linux kernel + +* Postfix MTA, ClamAV, Spamassassin and the {pmg} toolset + +* Web based management interface for using the toolset + +Please insert the installation CD-ROM, then boot from that +drive. Immediately afterwards you can choose the following menu +options: + +image::images/installer/pmg-grub-menu.png[] + +Install {pmg}:: + +Start normal installation. + +Install {pmg} (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. + +Rescue Boot:: + +This option allows you 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. + +Test Memory:: + +Runs `memtest86+`. This is useful to check if your memory is +functional and error free. + +You normally select *Install {pmg}* to start the installation. First +step ist to read our EULA (End User License Agreement). + +image::images/installer/pmg-license-agreement.png[] + +After that you get prompted to select the target hard disk(s). + +NOTE: By default, the complete server is used and all existing data is +removed. + +image::images/installer/pmg-select-target-disk.png[] + +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 <>) + +If you have more than one disk, 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. + +The next pages just ask for basic configuration options like time +zone and keyboard layout. You also need to specify your email address +and superuser (root) password (must have at least 5 characters). + +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. + +If you press `Next` now, installation starts to format disks, and +copies packages to the target. Please wait until that is finished, +then reboot the server. + +Further configuration is done via the Proxmox web interface. Just +point your browser to the IP address given during installation +(https://youripaddress:8006). + +NOTE: Default login is "root" and the root password is +defined during the installation process. + + +[[advanced_lvm_options]] +Advanced LVM Configuration Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The installer creates a Volume Group (VG) called `pmg`, and additional +Logical Volumes (LVs) called `root` and `swap`. The size of +those 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). + +`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`. + +`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`. + +`maxvz`:: + +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`. + +`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. ++ +NOTE: LVM requires free space in the VG for snapshot creation (not +required for lvmthin snapshots). + + +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 +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: + + zpool add log + + +Install {pmg} on Debian +----------------------- + +{pmg} ships as a set of Debian packages, so you can install it +on top of a normal Debian installation. After configuring the +repositories, you need to run: + +[source,bash] +---- +apt-get update +apt-get install proxmox-mailgateway +---- + +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. + +NOTE: In general, this is not trivial, especially when you use LVM or +ZFS.