]>
Commit | Line | Data |
---|---|---|
0fe09789 DM |
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 | |
de5c87d9 | 12 | many nodes. All management tasks can be done using our web-based |
0fe09789 DM |
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 | ||
5eba0743 | 26 | Unique Multi-Master Design:: |
0fe09789 DM |
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, | |
5eba0743 | 32 | complex, and pricey management server. |
0fe09789 | 33 | |
98d7e09a | 34 | Proxmox Cluster File System (pmxcfs):: |
0fe09789 | 35 | |
755949f1 | 36 | {pve} uses the unique Proxmox Cluster file system (pmxcfs), a |
0fe09789 DM |
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 | |
a22d7c24 | 42 | in RAM which provides a maximum storage size of 30MB - more than |
0fe09789 | 43 | enough for thousands of VMs. |
98d7e09a | 44 | + |
755949f1 | 45 | {pve} is the only virtualization platform using this unique |
0fe09789 DM |
46 | cluster file system. |
47 | ||
98d7e09a | 48 | Web-based Management Interface:: |
0fe09789 | 49 | |
755949f1 | 50 | {pve} is simple to use. Management tasks can be done via the |
5eba0743 | 51 | included web based management interface - there is no need to install a |
0fe09789 DM |
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 | ||
98d7e09a | 60 | Command Line:: |
0fe09789 DM |
61 | |
62 | For advanced users who are used to the comfort of the Unix shell or | |
755949f1 | 63 | Windows Powershell, {pve} provides a command line interface to |
0fe09789 DM |
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 | ||
98d7e09a | 68 | REST API:: |
0fe09789 | 69 | |
755949f1 | 70 | {pve} uses a RESTful API. We choose JSON as primary data format, |
0fe09789 DM |
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 | ||
98d7e09a | 75 | Role-based Administration:: |
0fe09789 | 76 | |
5eba0743 | 77 | You can define granular access for all objects (like VMs, storages, |
0fe09789 DM |
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 | ||
98d7e09a | 84 | Authentication Realms:: |
0fe09789 | 85 | |
755949f1 | 86 | {pve} supports multiple authentication sources like Microsoft |
0fe09789 | 87 | Active Directory, LDAP, Linux PAM standard authentication or the |
755949f1 | 88 | built-in {pve} authentication server. |
0fe09789 DM |
89 | |
90 | ||
5eba0743 | 91 | Flexible Storage |
0fe09789 DM |
92 | ---------------- |
93 | ||
755949f1 | 94 | The {pve} storage model is very flexible. Virtual machine images |
0fe09789 DM |
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 | |
de14ebff | 109 | * CIFS Share |
0fe09789 DM |
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 | ||
5eba0743 | 120 | |
0fe09789 DM |
121 | Integrated Backup and Restore |
122 | ----------------------------- | |
123 | ||
8c1189b6 | 124 | The integrated backup tool (`vzdump`) creates consistent snapshots of |
0fe09789 DM |
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 | |
e4fefc2c CE |
129 | NFS, CIFS, iSCSI LUN, Ceph RBD. The new backup format is optimized for storing |
130 | VM backups fast and effective (sparse files, out of order data, minimized I/O). | |
0fe09789 | 131 | |
5eba0743 | 132 | |
0fe09789 DM |
133 | High Availability Cluster |
134 | ------------------------- | |
135 | ||
755949f1 TL |
136 | A multi-node {pve} HA Cluster enables the definition of highly |
137 | available virtual servers. The {pve} HA Cluster is based on | |
0fe09789 DM |
138 | proven Linux HA technologies, providing stable and reliable HA |
139 | services. | |
140 | ||
5eba0743 | 141 | |
0fe09789 DM |
142 | Flexible Networking |
143 | ------------------- | |
144 | ||
755949f1 | 145 | {pve} uses a bridged networking model. All VMs can share one |
0fe09789 DM |
146 | bridge as if virtual network cables from each guest were all plugged |
147 | into the same switch. For connecting VMs to the outside world, bridges | |
a22d7c24 | 148 | are attached to physical network cards and assigned a TCP/IP |
0fe09789 DM |
149 | configuration. |
150 | ||
151 | For further flexibility, VLANs (IEEE 802.1q) and network | |
152 | bonding/aggregation are possible. In this way it is possible to build | |
755949f1 | 153 | complex, flexible virtual networks for the {pve} hosts, |
0fe09789 DM |
154 | leveraging the full power of the Linux network stack. |
155 | ||
8c1189b6 | 156 | |
0fe09789 DM |
157 | Integrated Firewall |
158 | ------------------- | |
159 | ||
5eba0743 | 160 | The integrated firewall allows you to filter network packets on |
8c1189b6 FG |
161 | any VM or Container interface. Common sets of firewall rules can |
162 | be grouped into ``security groups''. | |
163 | ||
4360c00f TM |
164 | include::hyper-converged-infrastructure.adoc[] |
165 | ||
0fe09789 DM |
166 | |
167 | Why Open Source | |
168 | --------------- | |
169 | ||
755949f1 TL |
170 | {pve} uses a Linux kernel and is based on the Debian GNU/Linux |
171 | Distribution. The source code of {pve} is released under the | |
a55d30db | 172 | https://www.gnu.org/licenses/agpl-3.0.html[GNU Affero General Public |
0fe09789 DM |
173 | License, version 3]. This means that you are free to inspect the |
174 | source code at any time or contribute to the project yourself. | |
175 | ||
176 | At Proxmox we are committed to use open source software whenever | |
177 | possible. Using open source software guarantees full access to all | |
178 | functionalities - as well as high security and reliability. We think | |
179 | that everybody should have the right to access the source code of a | |
180 | software to run it, build on it, or submit changes back to the | |
181 | project. Everybody is encouraged to contribute while Proxmox ensures | |
182 | the product always meets professional quality criteria. | |
183 | ||
184 | Open source software also helps to keep your costs low and makes your | |
185 | core infrastructure independent from a single vendor. | |
186 | ||
5eba0743 | 187 | |
a22d7c24 | 188 | Your benefits with {pve} |
424214c1 | 189 | ------------------------ |
0fe09789 DM |
190 | |
191 | * Open source software | |
192 | * No vendor lock-in | |
193 | * Linux kernel | |
194 | * Fast installation and easy-to-use | |
195 | * Web-based management interface | |
196 | * REST API | |
197 | * Huge active community | |
198 | * Low administration costs and simple deployment | |
199 | ||
fe907b65 EK |
200 | include::getting-help.adoc[] |
201 | ||
5eba0743 | 202 | |
0fe09789 DM |
203 | Project History |
204 | --------------- | |
205 | ||
206 | The project started in 2007, followed by a first stable version in | |
5eba0743 | 207 | 2008. At the time we used OpenVZ for containers, and KVM for virtual |
0fe09789 DM |
208 | machines. The clustering features were limited, and the user interface |
209 | was simple (server generated web page). | |
210 | ||
211 | But we quickly developed new features using the | |
a55d30db | 212 | https://corosync.github.io/corosync/[Corosync] cluster stack, and the |
0fe09789 DM |
213 | introduction of the new Proxmox cluster file system (pmxcfs) was a big |
214 | step forward, because it completely hides the cluster complexity from | |
215 | the user. Managing a cluster of 16 nodes is as simple as managing a | |
216 | single node. | |
217 | ||
218 | We also introduced a new REST API, with a complete declarative | |
5eba0743 FG |
219 | specification written in JSON-Schema. This enabled other people to |
220 | integrate {pve} into their infrastructure, and made it easy to provide | |
0fe09789 DM |
221 | additional services. |
222 | ||
223 | Also, the new REST API made it possible to replace the original user | |
224 | interface with a modern HTML5 application using JavaScript. We also | |
225 | replaced the old Java based VNC console code with | |
226 | https://kanaka.github.io/noVNC/[noVNC]. So you only need a web browser | |
227 | to manage your VMs. | |
228 | ||
229 | The support for various storage types is another big task. Notably, | |
230 | {pve} was the first distribution to ship ZFS on Linux by default in | |
231 | 2014. Another milestone was the ability to run and manage | |
a55d30db | 232 | https://ceph.com/[Ceph] storage on the hypervisor nodes. Such setups |
0fe09789 DM |
233 | are extremely cost effective. |
234 | ||
235 | When we started we were among the first companies providing | |
236 | commercial support for KVM. The KVM project itself continuously | |
5eba0743 | 237 | evolved, and is now a widely used hypervisor. New features arrive |
0fe09789 DM |
238 | with each release. We developed the KVM live backup feature, which |
239 | makes it possible to create snapshot backups on any storage type. | |
240 | ||
241 | The most notable change with version 4.0 was the move from OpenVZ to | |
242 | https://linuxcontainers.org/[LXC]. Containers are now deeply | |
243 | integrated, and they can use the same storage and network features | |
244 | as virtual machines. | |
abafd0a3 | 245 | |
3ef512ec | 246 | include::howto-improve-pve-docs.adoc[] |
8d7b6807 | 247 | include::translation.adoc[] |
3ef512ec | 248 |