pveceph: add pg_num for easier search
[pve-docs.git] / pve-intro.adoc
1 Introduction
2 ============
3
4 {pve} is a platform to run virtual machines and containers. It is
5 based on Debian Linux, and completely open source. For maximum
6 flexibility, we implemented two virtualization technologies -
7 Kernel-based Virtual Machine (KVM) and container-based virtualization
8 (LXC).
9
10 One main design goal was to make administration as easy as
11 possible. You can use {pve} on a single node, or assemble a cluster of
12 many nodes. All management tasks can be done using our web-based
13 management interface, and even a novice user can setup and install
14 {pve} within minutes.
15
16 image::images/pve-software-stack.svg["Proxmox Software Stack",align="center"]
17
18
19 Central Management
20 ------------------
21
22 While many people start with a single node, {pve} can scale out to a
23 large set of clustered nodes. The cluster stack is fully integrated
24 and ships with the default installation.
25
26 Unique Multi-Master Design::
27
28 The integrated web-based management interface gives you a clean
29 overview of all your KVM guests and Linux containers and even of your
30 whole cluster. You can easily manage your VMs and containers, storage
31 or cluster from the GUI. There is no need to install a separate,
32 complex, and pricey management server.
33
34 Proxmox Cluster File System (pmxcfs)::
35
36 Proxmox VE uses the unique Proxmox Cluster file system (pmxcfs), a
37 database-driven file system for storing configuration files. This
38 enables you to store the configuration of thousands of virtual
39 machines. By using corosync, these files are replicated in real time
40 on all cluster nodes. The file system stores all data inside a
41 persistent database on disk, nonetheless, a copy of the data resides
42 in RAM which provides a maximum storage size is 30MB - more than
43 enough for thousands of VMs.
44 +
45 Proxmox VE is the only virtualization platform using this unique
46 cluster file system.
47
48 Web-based Management Interface::
49
50 Proxmox VE is simple to use. Management tasks can be done via the
51 included web based management interface - there is no need to install a
52 separate management tool or any additional management node with huge
53 databases. The multi-master tool allows you to manage your whole
54 cluster from any node of your cluster. The central web-based
55 management - based on the JavaScript Framework (ExtJS) - empowers
56 you to control all functionalities from the GUI and overview history
57 and syslogs of each single node. This includes running backup or
58 restore jobs, live-migration or HA triggered activities.
59
60 Command Line::
61
62 For advanced users who are used to the comfort of the Unix shell or
63 Windows Powershell, Proxmox VE provides a command line interface to
64 manage all the components of your virtual environment. This command
65 line interface has intelligent tab completion and full documentation
66 in the form of UNIX man pages.
67
68 REST API::
69
70 Proxmox VE uses a RESTful API. We choose JSON as primary data format,
71 and the whole API is formally defined using JSON Schema. This enables
72 fast and easy integration for third party management tools like custom
73 hosting environments.
74
75 Role-based Administration::
76
77 You can define granular access for all objects (like VMs, storages,
78 nodes, etc.) by using the role based user- and permission
79 management. This allows you to define privileges and helps you to
80 control access to objects. This concept is also known as access
81 control lists: Each permission specifies a subject (a user or group)
82 and a role (set of privileges) on a specific path.
83
84 Authentication Realms::
85
86 Proxmox VE supports multiple authentication sources like Microsoft
87 Active Directory, LDAP, Linux PAM standard authentication or the
88 built-in Proxmox VE authentication server.
89
90
91 Flexible Storage
92 ----------------
93
94 The Proxmox VE storage model is very flexible. Virtual machine images
95 can either be stored on one or several local storages or on shared
96 storage like NFS and on SAN. There are no limits, you may configure as
97 many storage definitions as you like. You can use all storage
98 technologies available for Debian Linux.
99
100 One major benefit of storing VMs on shared storage is the ability to
101 live-migrate running machines without any downtime, as all nodes in
102 the cluster have direct access to VM disk images.
103
104 We currently support the following Network storage types:
105
106 * LVM Group (network backing with iSCSI targets)
107 * iSCSI target
108 * NFS Share
109 * CIFS Share
110 * Ceph RBD
111 * Directly use iSCSI LUNs
112 * GlusterFS
113
114 Local storage types supported are:
115
116 * LVM Group (local backing devices like block devices, FC devices, DRBD, etc.)
117 * Directory (storage on existing filesystem)
118 * ZFS
119
120
121 Integrated Backup and Restore
122 -----------------------------
123
124 The integrated backup tool (`vzdump`) creates consistent snapshots of
125 running Containers and KVM guests. It basically creates an archive of
126 the VM or CT data which includes the VM/CT configuration files.
127
128 KVM live backup works for all storage types including VM images on
129 NFS, CIFS, iSCSI LUN, Ceph RBD or Sheepdog. The new backup format is
130 optimized for storing VM backups fast and effective (sparse files, out
131 of order data, minimized I/O).
132
133
134 High Availability Cluster
135 -------------------------
136
137 A multi-node Proxmox VE HA Cluster enables the definition of highly
138 available virtual servers. The Proxmox VE HA Cluster is based on
139 proven Linux HA technologies, providing stable and reliable HA
140 services.
141
142
143 Flexible Networking
144 -------------------
145
146 Proxmox VE uses a bridged networking model. All VMs can share one
147 bridge as if virtual network cables from each guest were all plugged
148 into the same switch. For connecting VMs to the outside world, bridges
149 are attached to physical network cards assigned a TCP/IP
150 configuration.
151
152 For further flexibility, VLANs (IEEE 802.1q) and network
153 bonding/aggregation are possible. In this way it is possible to build
154 complex, flexible virtual networks for the Proxmox VE hosts,
155 leveraging the full power of the Linux network stack.
156
157
158 Integrated Firewall
159 -------------------
160
161 The integrated firewall allows you to filter network packets on
162 any VM or Container interface. Common sets of firewall rules can
163 be grouped into ``security groups''.
164
165
166 Why Open Source
167 ---------------
168
169 Proxmox VE uses a Linux kernel and is based on the Debian GNU/Linux
170 Distribution. The source code of Proxmox VE is released under the
171 http://www.gnu.org/licenses/agpl-3.0.html[GNU Affero General Public
172 License, version 3]. This means that you are free to inspect the
173 source code at any time or contribute to the project yourself.
174
175 At Proxmox we are committed to use open source software whenever
176 possible. Using open source software guarantees full access to all
177 functionalities - as well as high security and reliability. We think
178 that everybody should have the right to access the source code of a
179 software to run it, build on it, or submit changes back to the
180 project. Everybody is encouraged to contribute while Proxmox ensures
181 the product always meets professional quality criteria.
182
183 Open source software also helps to keep your costs low and makes your
184 core infrastructure independent from a single vendor.
185
186
187 Your benefit with {pve}
188 -----------------------
189
190 * Open source software
191 * No vendor lock-in
192 * Linux kernel
193 * Fast installation and easy-to-use
194 * Web-based management interface
195 * REST API
196 * Huge active community
197 * Low administration costs and simple deployment
198
199 include::getting-help.adoc[]
200
201
202 Project History
203 ---------------
204
205 The project started in 2007, followed by a first stable version in
206 2008. At the time we used OpenVZ for containers, and KVM for virtual
207 machines. The clustering features were limited, and the user interface
208 was simple (server generated web page).
209
210 But we quickly developed new features using the
211 http://corosync.github.io/corosync/[Corosync] cluster stack, and the
212 introduction of the new Proxmox cluster file system (pmxcfs) was a big
213 step forward, because it completely hides the cluster complexity from
214 the user. Managing a cluster of 16 nodes is as simple as managing a
215 single node.
216
217 We also introduced a new REST API, with a complete declarative
218 specification written in JSON-Schema. This enabled other people to
219 integrate {pve} into their infrastructure, and made it easy to provide
220 additional services.
221
222 Also, the new REST API made it possible to replace the original user
223 interface with a modern HTML5 application using JavaScript. We also
224 replaced the old Java based VNC console code with
225 https://kanaka.github.io/noVNC/[noVNC]. So you only need a web browser
226 to manage your VMs.
227
228 The support for various storage types is another big task. Notably,
229 {pve} was the first distribution to ship ZFS on Linux by default in
230 2014. Another milestone was the ability to run and manage
231 http://ceph.com/[Ceph] storage on the hypervisor nodes. Such setups
232 are extremely cost effective.
233
234 When we started we were among the first companies providing
235 commercial support for KVM. The KVM project itself continuously
236 evolved, and is now a widely used hypervisor. New features arrive
237 with each release. We developed the KVM live backup feature, which
238 makes it possible to create snapshot backups on any storage type.
239
240 The most notable change with version 4.0 was the move from OpenVZ to
241 https://linuxcontainers.org/[LXC]. Containers are now deeply
242 integrated, and they can use the same storage and network features
243 as virtual machines.
244
245 include::howto-improve-pve-docs.adoc[]
246