Add node level subchapter
[pve-docs.git] / pve-webgui.adoc
1 Proxmox WebGUI
2 --------------
3 include::attributes.txt[]
4
5 {pve} is simple. There is no need to install a separate
6 management tool, everything can be done via your web browser (Latest
7 Firefox and Google Chrome is preferred). To access
8 VM/CT console, a built in HTML5 console is used. As alternative, SPICE
9 can be used.
10
11 As we use Proxmox Cluster file system (pmxcfs),you can connect to any
12 node to manage the whole cluster.
13
14 To use the Central Web-based Management, you need a modern browser,
15 this includes:
16
17 * Firefox, a release from the current year, or the latest Enterprise
18 * Support Release Chrome, a release from the current year
19 * Microsoft currently supported versions of Edge Browser
20 * Apple currently supported versions of Safari
21
22 If {pve} detect you're connecting from a mobile device, you will
23 redirected to a light weight touch based UI.
24
25 The web interface can be reached via https://youripaddress:8006
26 (default login is: root, the password is specified during the
27 installation).
28
29
30 Features:
31 ^^^^^^^^^
32
33 * Seamless integration and management of Proxmox VE 4.x Cluster
34 * AJAX technologies for dynamic updates of resources
35 * Secure access to all Virtual Machines and Containers via SSL encryption (https)
36 * Fast search-driven interface, capable of handling hundreds and probably thousands of VMs
37 * Secure HTML5 console or SPICE
38 * Role based permission management for all objects (VMs, storages, nodes, etc.)
39 * Support for multiple authentication sources (e.g. local, MS ADS, LDAP, ...)
40 * Two-Factor Authentication
41 * Proxmox VE Firewall
42 * Based on Ext JS 6.x JavaScript framework
43
44
45 Web Gui overview:
46 ~~~~~~~~~~~~~~~~~
47
48 image::pve_gui.png[]
49
50 The GUI has 3 sectors:
51
52 * On the left side is the navigation bar. The navigation bar is
53   structured into 4 different types. It has 4 different views,
54   which can be selected on the top.
55 ** Datacenter: contains all the settings belonging to all machines.
56 ** Nodes: represent the host where the VM/CT runs on. It is named like
57    the hostname. Normally the name was set by the installation.
58 ** Entity: can be a VM, container or a storage.
59 ** Logical pools: it is possible to group entities to a group for easy management.
60 * On the right side is the main management center, where all content
61   of the selected entity form the navigation bar is shown.
62 * On the bottom is the task log section, where all tasks are shown.
63
64
65 Dataceter level
66 ^^^^^^^^^^^^^^
67
68 image::pve_gui_datacenter.png[]
69
70 On the datacenter level you can manage cluster wide settings and get
71 information about this cluster.
72
73 * *Search:* it is possible to search anything in cluster
74 ,this can be a node, VM, Container, Storage or a pool.
75
76 * *Summery:* gives a brief overview over the cluster health.
77
78 * *Options:* can show and set defaults, which apply cluster wide.
79
80 * *Storage:* is the place where a storage will add/managed/removed.
81
82 * *Backup:* has the capability to schedule Backups. This is
83    cluster wide, so you do not care about where the VM/Container are on
84    your cluster at schedule time.
85
86 * *Permissions:* will manage user and group permission, LDAP,
87    MS-AD and Two-Factor authentication can be setup here.
88
89 * *HA:* will manage the {pve} High-Availability
90
91 * *Firewall:* on this level the Proxmox Firewall works cluster wide and
92    makes templates which are cluster wide available.
93
94 * *Support:* here you get all information about your support subscription.
95
96 If you like to have more information about this see the corresponding chapter.
97
98
99 Node level
100 ^^^^^^^^^^
101
102 image::pve_gui_node.png[]
103
104 All belongs of a node can be managed at this level.
105
106 * *Search:* it is possible to search anything on the node,
107  this can be a VM, Container, Storage or a pool.
108
109 * *Summery:* gives a brief overview over the resource usage.
110
111 * *Shell:* log you in the shell of the node.
112
113 * *System:* is for configuration like network, time and shows your syslog.
114
115 * *Updates:* will upgrade the system and inform you about new packets.
116
117 * *Firewall:* on this level is only for this node.
118
119 * *Disk:* gives you an brief overview about you physical hard drives and
120    how do you use them.
121
122 * *Ceph:* is only used if you have installed a Ceph sever on you
123    host. Then you can here manage your Ceph cluster and see the status
124    of it.
125
126 * *Task History:* here all past task are shown.
127
128 * *Subscription:* here you can upload you subscription key and get a
129    system overview in case of a support case.
130
131 ifdef::wiki[]
132
133 See Also
134 ~~~~~~~~
135
136 * link:/wiki/Central_Web-based_Management
137
138 endif::wiki[]
139 ////
140 TODO:
141
142 VM, CT, Storage section
143
144 ////