enhance descriptions of LVM configuration options
[pve-docs.git] / pve-installation.adoc
1 Installing Proxmox VE
2 =====================
3 ifndef::manvolnum[]
4 :pve-toplevel:
5 endif::manvolnum[]
6 ifdef::wiki[]
7 :title: Installation
8 endif::wiki[]
9
10 {pve} is based on Debian and comes with an installation CD-ROM 
11 which includes a complete Debian ("jessie" for Proxmox VE 4.x) system as 
12 well as all necessary Proxmox VE packages. The
13 installer just asks you a few questions, then partitions the local
14 disk(s), installs all required packages, and configures the system
15 including a basic network setup. You can get a fully functional system
16 within a few minutes. This is the preferred and recommended installation method.
17
18 Alternatively, Proxmox VE can be installed on top of an existing Debian system. 
19 This option is only recommended for advanced users since detail knowledge about 
20 Proxmox VE is necessary.
21
22 ifndef::wiki[]
23
24 include::pve-system-requirements.adoc[]
25
26 endif::wiki[]
27
28
29 Using the {pve} Installation CD-ROM
30 -----------------------------------
31
32 Includes the following:
33
34 * Complete operating system (Debian Linux, 64-bit)
35
36 * Partitioning of the hard drive(s) containing the operating system
37   with ext4, ext3, xfs or ZFS
38
39 * {pve} kernel with LXC and KVM support
40
41 * Complete toolset for administering virtual machines, containers and
42   all necessary resources
43
44 * Web based management interface for using the toolset
45
46
47 NOTE: By default, the complete server is used and all existing data is
48 removed.
49
50 Please insert the installation CD-ROM, then boot from that
51 drive. Immediately afterwards you can choose the following menu
52 options:
53
54 Install Proxmox VE::
55
56 Start normal installation.
57
58 Install Proxmox VE (Debug mode)::
59
60 Start installation in debug mode. It opens a shell console at several
61 installation steps, so that you can debug things if something goes
62 wrong. Please press `CTRL-D` to exit those debug consoles and continue
63 installation. This option is mostly for developers and not meant for
64 general use.
65
66 Rescue Boot::
67
68 This option allows you to boot an existing installation. It searches
69 all attached hard disks and, if it finds an existing installation,
70 boots directly into that disk using the existing Linux kernel. This
71 can be useful if there are problems with the boot block (grub), or the
72 BIOS is unable to read the boot block from the disk.
73
74 Test Memory::
75
76 Runs `memtest86+`. This is useful to check if your memory is
77 functional and error free.
78
79 You normally select *Install Proxmox VE* to start the installation.
80 After that you get prompted to select the target hard disk(s). The
81 `Options` button lets you select the target file system, which
82 defaults to `ext4`. The installer uses LVM if you select `ext3`,
83 `ext4` or `xfs` as file system, and offers additional option to
84 restrict LVM space (see <<advanced_lvm_options,below>>)
85
86 If you have more than one disk, you can also use ZFS as file system.
87 ZFS supports several software RAID levels, so this is specially useful
88 if you do not have a hardware RAID controller. The `Options` button
89 lets you select the ZFS RAID level, and you can choose disks there.
90
91 The next pages just ask for basic configuration options like time
92 zone and keyboard layout. You also need to specify your email address
93 and superuser (root) password (must have at least 5 characters).
94
95 The last step is the network configuration. Please note that you can
96 use either IPv4 or IPv6 here, but not both. If you want to configure a
97 dual stack node, you can easily do that after installation.
98
99 If you press `Next` now, installation starts to format disks, and
100 copies packages to the target. Please wait until that is finished,
101 then reboot the server.
102
103 Further configuration is done via the Proxmox web interface. Just
104 point your browser to the IP address given during installation
105 (https://youripaddress:8006).
106
107 NOTE: Default login is "root" (realm 'PAM') and the root password is
108 defined during the installation process.
109
110
111 [[advanced_lvm_options]]
112 Advanced LVM Configuration Options
113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114
115 The installer creates a Volume Group (VG) called `pve`, and additional
116 Logical Volumes (LVs) called `root`, `data` and `swap`. The size of
117 those volumes can be controlled with:
118
119 `hdsize`::
120
121 Defines the total HD size to be used. This way you can save free
122 space on the HD for further partitioning (i.e. for an additional PV
123 and VG on the same hard disk that can be used for LVM storage).
124
125 `swapsize`::
126
127 Defines the size of the `swap` volume. The default is the size of the
128 installed memory, minimum 4 GB and maximum 8 GB. The resulting value cannot
129 be greater than `hdsize/8`.
130
131 `maxroot`::
132
133 Defines the maximum size of the `root` volume, which stores the operation
134 system. The maximum limit of the `root` volume size is `hdsize/4`.
135
136 `maxvz`::
137
138 Defines the maximum size of the `data` volume. The actual size of the `data`
139 volume is:
140 +
141 `datasize = hdsize - rootsize - swapsize - minfree`
142 +
143 Where `datasize` cannot be bigger than `maxvz`.
144
145 `minfree`::
146
147 Defines the amount of free space left in LVM volume group `pve`.
148 With more than 128GB storage available the default is 16GB, else `hdsize/8`
149 will be used.
150 +
151 NOTE: LVM requires free space in the VG for snapshot creation (not
152 required for lvmthin snapshots).
153
154
155 ZFS Performance Tips
156 ~~~~~~~~~~~~~~~~~~~~
157
158 ZFS uses a lot of memory, so it is best to add additional RAM if you
159 want to use ZFS. A good calculation is 4GB plus 1GB RAM for each TB
160 RAW disk space.
161
162 ZFS also provides the feature to use a fast SSD drive as write cache. The
163 write cache is called the ZFS Intent Log (ZIL). You can add that after
164 installation using the following command:
165
166  zpool add <pool-name> log </dev/path_to_fast_ssd>
167
168
169 ifdef::wiki[]
170
171 link:/wiki/Install_Proxmox_VE_on_Debian_Jessie[Install Proxmox VE on Debian Jessie]
172 -----------------------------------------------------------------------------------
173
174 link:/wiki/Install_from_USB_Stick[Install from USB Stick]
175 ---------------------------------------------------------
176
177 endif::wiki[]
178
179 ifndef::wiki[]
180
181 Install {pve} on Debian
182 -----------------------
183
184 {pve} ships as a set of Debian packages, so you can install it
185 on top of a normal Debian installation. After configuring the
186 repositories, you need to run:
187
188 [source,bash]
189 ----
190 apt-get update
191 apt-get install proxmox-ve
192 ----
193
194 Installing on top of an existing Debian installation looks easy, but
195 it presumes that you have correctly installed the base system, and you
196 know how you want to configure and use the local storage. Network
197 configuration is also completely up to you.
198
199 In general, this is not trivial, especially when you use LVM or
200 ZFS.
201
202 You can find a detailed step by step howto on the
203 {webwiki-url}Install_Proxmox_VE_on_Debian_Jessie[wiki].
204
205 include::pve-usbstick.adoc[]
206
207 endif::wiki[]
208
209 ifdef::wiki[]
210
211 Video Tutorials
212 ---------------
213
214 * List of all official tutorials on our
215   http://www.youtube.com/proxmoxve[Proxmox VE YouTube Channel]
216
217 * Tutorials in Spanish language on
218   http://www.youtube.com/playlist?list=PLUULBIhA5QDBdNf1pcTZ5UXhek63Fij8z[ITexperts.es
219   YouTube Play List]
220
221
222 See Also
223 --------
224
225 * link:/wiki/System_Requirements[System Requirements]
226
227 * link:/wiki/Package_Repositories[Package Repositories]
228
229 * link:/wiki/Host_System_Administration[Host System Administration]
230
231 * link:/wiki/Network_Configuration[Network Configuration]
232
233 * link:/wiki/Installation:_Tips_and_Tricks[Installation: Tips and Tricks]
234
235 endif::wiki[]