buildsys: don't use rm -r on so many globs
[pve-docs.git] / pve-gui.adoc
1 [[chapter_gui]]
2 Graphical User Interface
3 ========================
4 ifndef::manvolnum[]
5 :pve-toplevel:
6 endif::manvolnum[]
7
8 {pve} is simple. There is no need to install a separate management
9 tool, and everything can be done through your web browser (Latest
10 Firefox or Google Chrome is preferred). A built-in HTML5 console is
11 used to access the guest console. As an alternative,
12 https://www.spice-space.org/[SPICE] can be used.
13
14 Because we use the Proxmox cluster file system (pmxcfs), you can
15 connect to any node to manage the entire cluster. Each node can manage
16 the entire cluster. There is no need for a dedicated manager node.
17
18 You can use the web-based administration interface with any modern
19 browser. When {pve} detects that you are connecting from a mobile
20 device, you are redirected to a simpler, touch-based user interface.
21
22 The web interface can be reached via https://youripaddress:8006
23 (default login is: 'root', and the password is specified during the
24 installation process).
25
26
27 Features
28 --------
29
30 * Seamless integration and management of {pve} clusters
31
32 * AJAX technologies for dynamic updates of resources
33
34 * Secure access to all Virtual Machines and Containers via SSL
35   encryption (https)
36
37 * Fast search-driven interface, capable of handling hundreds and
38   probably thousands of VMs
39
40 * Secure HTML5 console or SPICE
41
42 * Role based permission management for all objects (VMs, storages,
43   nodes, etc.)
44
45 * Support for multiple authentication sources (e.g. local, MS ADS,
46   LDAP, ...)
47
48 * Two-Factor Authentication (OATH, Yubikey)
49
50 * Based on ExtJS 6.x JavaScript framework
51
52
53 Login
54 -----
55
56 [thumbnail="gui-login-window.png"]
57
58 When you connect to the server, you will first see the longin window.
59 {pve} supports various authentication backends ('Realm'), and
60 you can select the langauage here. The GUI is translated to more
61 than 20 languages.
62
63 NOTE: You can save the user name on the client side by selection the
64 checkbox at the bottom. This saves some typing when you login next
65 time.
66
67
68 GUI Overview
69 ------------
70
71 [thumbnail="gui-datacenter-summary.png"]
72
73 The {pve} user interface consists of four regions.
74
75 [horizontal]
76
77 Header:: On top. Shows status information and contains buttons for
78 most important actions.
79
80 Resource Tree:: At the left side. A navigation tree where you can select
81 specific objects.
82
83 Content Panel:: Center region. Selected objects displays configuration
84 options and status here.
85
86 Log Panel:: At the bottom. Displays log entries for recent tasks. You
87 can double-click on those log entries to get more details, or to abort
88 a running task.
89
90 NOTE: You can shrink and expand the size of the resource tree and log
91 panel, or completely hide the log panel. This can be helpful when you
92 work on small displays and want more space to view other content.
93
94
95 Header
96 ~~~~~~
97
98 On the top left side, the first thing you see is the Proxmox
99 logo. Next to it is the current running version of {pve}. In the
100 search bar nearside you can search for specific objects (VMs,
101 containers, nodes, ...). This is sometimes faster than selecting an
102 object in the resource tree.
103
104 [thumbnail="gui-my-settings.png"]
105
106 To the right of the search bar we see the identity (login name). The
107 gear symbol is a button opening the 'My Settings' dialog. There you
108 can customize some client side user interface setting (reset the saved
109 login name, reset saved layout).
110
111 The rightmost part of the header contains four buttons:
112
113 [horizontal]
114 Help :: Opens a new browser window showing the reference documenation.
115
116 Create VM :: Opens the virtual machine creation wizard.
117
118 Create CT :: Open the container creation wizard.
119
120 Logout :: Logout, and show the login dialog again.
121
122
123 Resource Tree
124 ~~~~~~~~~~~~~
125
126 This is the main navigation tree. On top of the tree you can select
127 some predefined views, which changes the structure of the tree
128 below. The default view is *Server View*, and it shows the following
129 object types:
130
131 [horizontal]
132 Datacenter:: Contains cluster wide setting (relevant for all nodes).
133
134 Node:: Represents the hosts inside a cluster, where the guests runs.
135
136 Guest:: VMs, Containers and Templates.
137
138 Storage:: Data Storage.
139
140 Pool:: It is possible to group guests using a pool to simplify
141 management.
142
143
144 The following view types are available:
145
146 [horizontal]
147 Server View:: Shows all kind of objects, grouped by nodes.
148
149 Folder View:: Shows all kind of objects, grouped by object type.
150
151 Storage View:: Only show storage objects, grouped by nodes.
152
153 Pool View:: Show VMs and Containers, grouped by pool.
154
155
156 Log Panel
157 ~~~~~~~~~
158
159 The main purpose of the log panel is to show you what is currently
160 going on in your cluster. Actions like creating an new VM are executed
161 in background, and we call such background job a 'task'.
162
163 Any output from such task is saved into a separate log file. You can
164 view that log by simply double-click a task log entry. It is also
165 possible to abort a running task there.
166
167 Please note that we display most recent tasks from all cluster nodes
168 here. So you can see when somebody else is working on another cluster
169 node in real-time.
170
171 NOTE: We remove older and finished task from the log panel to keep
172 that list short. But you can still find those tasks in the 'Task
173 History' within the node panel.
174
175 Some short running actions simply sends logs to all cluster
176 members. You can see those messages in the 'Cluster log' panel.
177
178
179 Content Panels
180 --------------
181
182 When you select something in the resource tree, the correnponding
183 object displays configuration and status information in the content
184 panel. The following sections gives a brief overview of the
185 functionality. Please refer to the individual chapters inside the
186 reference documentatin to get more detailed information.
187
188
189 Datacenter
190 ~~~~~~~~~~
191
192 [thumbnail="gui-datacenter-search.png"]
193
194 On the datacenter level you can access cluster wide settings and information.
195
196 * *Search:* it is possible to search anything in cluster
197 ,this can be a node, VM, Container, Storage or a pool.
198
199 * *Summary:* gives a brief overview over the cluster health.
200
201 * *Options:* can show and set defaults, which apply cluster wide.
202
203 * *Storage:* is the place where a storage will add/managed/removed.
204
205 * *Backup:* has the capability to schedule Backups. This is
206    cluster wide, so you do not care about where the VM/Container are on
207    your cluster at schedule time.
208
209 * *Permissions:* will manage user and group permission, LDAP,
210    MS-AD and Two-Factor authentication can be setup here.
211
212 * *HA:* will manage the {pve} High-Availability
213
214 * *Firewall:* on this level the Proxmox Firewall works cluster wide and
215    makes templates which are cluster wide available.
216
217 * *Support:* here you get all information about your support subscription.
218
219 If you like to have more information about this see the corresponding chapter.
220
221
222 Nodes
223 ~~~~~
224
225 [thumbnail="gui-node-summary.png"]
226
227 All belongs of a node can be managed at this level.
228
229 * *Search:* it is possible to search anything on the node,
230  this can be a VM, Container, Storage or a pool.
231
232 * *Summary:* gives a brief overview over the resource usage.
233
234 * *Shell:* log you in the shell of the node.
235
236 * *System:* is for configuring the network, dns and time, and also shows your syslog.
237
238 * *Updates:* will upgrade the system and informs you about new packets.
239
240 * *Firewall:* on this level is only for this node.
241
242 * *Disk:* gives you an brief overview about you physical hard drives and
243    how they are used.
244
245 * *Ceph:* is only used if you have installed a Ceph sever on you
246    host. Then you can manage your Ceph cluster and see the status
247    of it here.
248
249 * *Task History:* here all past task are shown.
250
251 * *Subscription:* here you can upload you subscription key and get a
252    system overview in case of a support case.
253
254
255 Guests
256 ~~~~~~
257
258 [thumbnail="gui-qemu-summary.png"]
259
260 There are two differed kinds of VM types and both types can be converted to a template.
261 One of them are Kernel-based Virtual Machine (KVM) and the other one are Linux Containers (LXC).
262 General the navigation are the same only some option are different.
263
264 In the main management center the VM navigation begin if a VM is selected in the left tree.
265
266 The top header contains important VM operation commands like 'Start', 'Shutdown', 'Rest',
267 'Remove', 'Migrate', 'Console' and 'Help'.
268 Two of them have hidden buttons like 'Shutdown' has 'Stop' and
269 'Console' contains the different consolen typs 'SPICE' or 'noVNC'.
270
271 On the right side the content switch white the focus of the option.
272
273 On the left side.
274 All available options are listed one below the other.
275
276 * *Summary:* gives a brief overview over the VM activity.
277
278 * *Console:* an interactive console to your VM.
279
280 * *(KVM)Hardware:* shows and set the Hardware of the KVM VM.
281
282 * *(LXC)Resources:* defines the LXC Hardware opportunities.
283
284 * *(LXC)Network:* the LXC Network settings.
285
286 * *(LXC)DNS:* the LXC DNS settings.
287
288 * *Options:* all VM options can be set here, this distinguishes between KVM and LXC.
289
290 * *Task History:* here all previous task from this VM will be shown.
291
292 * *(KVM) Monitor:* is the interactive communication interface to the KVM process.
293
294 * *Backup:* shows the available backups from this VM and also create a backupset.
295
296 * *Snapshots:* manage VM snapshots.
297
298 * *Firewall:* manage the firewall on VM level.
299
300 * *Permissions:* manage the user permission for this VM.
301
302
303 Storage
304 ~~~~~~~
305
306 [thumbnail="gui-storage-summary-local.png"]
307
308 In this view we have a two partition split view.
309 On the left side we have the storage options
310 and on the right side the content of the selected option will shown.
311
312 * *Summary:* show you important information about your storage like
313 'Usage', 'Type', 'Content', 'Active' and 'Enabled'.
314
315 * *Content:* Here all contend will listed grouped by content.
316
317 * *Permissions:* manage the user permission for this storage.
318
319
320 Pools
321 ~~~~~
322
323 [thumbnail="gui-pool-summary-development.png"]
324
325 In this view we have a two partition split view.
326 On the left side we have the logical pool options
327 and on the right side the content of the selected option will shown.
328
329 * *Summary:* show the description of the pool.
330
331 * *Members:* Here all members of this pool will listed and can be managed.
332
333 * *Permissions:* manage the user permission for this pool.
334
335
336 ifdef::wiki[]
337
338 See Also
339 --------
340
341 * link:/wiki/Central_Web-based_Management
342
343 endif::wiki[]
344
345 ////
346 TODO:
347
348 VM, CT, Storage, Pool section
349
350 ////