]>
Commit | Line | Data |
---|---|---|
4736f1bc | 1 | [[chapter_gui]] |
813e4036 DM |
2 | Graphical User Interface |
3 | ======================== | |
4736f1bc DM |
4 | ifndef::manvolnum[] |
5 | :pve-toplevel: | |
6 | endif::manvolnum[] | |
c5eadcbd | 7 | |
813e4036 DM |
8 | {pve} is simple. There is no need to install a separate management |
9 | tool, everything can be done via your web browser (Latest Firefox and | |
10 | Google Chrome is preferred). To access VM/CT console, a built in HTML5 | |
11 | console is used. As alternative, SPICE can be used. | |
c5eadcbd WL |
12 | |
13 | As we use Proxmox Cluster file system (pmxcfs),you can connect to any | |
14 | node to manage the whole cluster. | |
15 | ||
16 | To use the Central Web-based Management, you need a modern browser, | |
17 | this includes: | |
18 | ||
19 | * Firefox, a release from the current year, or the latest Enterprise | |
20 | * Support Release Chrome, a release from the current year | |
21 | * Microsoft currently supported versions of Edge Browser | |
22 | * Apple currently supported versions of Safari | |
23 | ||
24 | If {pve} detect you're connecting from a mobile device, you will | |
25 | redirected to a light weight touch based UI. | |
26 | ||
27 | The web interface can be reached via https://youripaddress:8006 | |
28 | (default login is: root, the password is specified during the | |
29 | installation). | |
30 | ||
31 | ||
813e4036 | 32 | Features |
4736f1bc | 33 | -------- |
c5eadcbd WL |
34 | |
35 | * Seamless integration and management of Proxmox VE 4.x Cluster | |
36 | * AJAX technologies for dynamic updates of resources | |
37 | * Secure access to all Virtual Machines and Containers via SSL encryption (https) | |
38 | * Fast search-driven interface, capable of handling hundreds and probably thousands of VMs | |
39 | * Secure HTML5 console or SPICE | |
40 | * Role based permission management for all objects (VMs, storages, nodes, etc.) | |
41 | * Support for multiple authentication sources (e.g. local, MS ADS, LDAP, ...) | |
42 | * Two-Factor Authentication | |
43 | * Proxmox VE Firewall | |
44 | * Based on Ext JS 6.x JavaScript framework | |
45 | ||
46 | ||
813e4036 DM |
47 | GUI Overview |
48 | ------------ | |
c5eadcbd | 49 | |
f9c4114c | 50 | [thumbnail="gui-datacenter-summary.png"] |
c5eadcbd | 51 | |
98c2ef68 WL |
52 | Lets start with the header. |
53 | We start on the left side, where the first thing you see is the Proxmox Logo. | |
54 | Next to it is the current running version of Proxmox VE. | |
55 | In the search bar it is possible to search for item which the datacenter contains. | |
56 | After the search-bar the identity is shown (login name). | |
57 | ||
58 | [thumbnail="gui-my-settings.png"] | |
59 | ||
60 | The 'my settings' button (Gear Symble) contains dashbord customization, | |
61 | reset the saved login name or rest the saved layout. | |
62 | At least four buttons come, started with 'Help', 'Create VM', 'Create CT' and 'Logout'. | |
63 | ||
64 | The Body has 3 sections: | |
c5eadcbd | 65 | |
6db8976c DC |
66 | * On the left side is the navigation bar. On the top, you can select one of 4 |
67 | views. Those views change the structure of the tree below. The default | |
68 | selection is *Server View* and it has the following 4 types of elements. | |
c5eadcbd WL |
69 | ** Datacenter: contains all the settings belonging to all machines. |
70 | ** Nodes: represent the host where the VM/CT runs on. It is named like | |
71 | the hostname. Normally the name was set by the installation. | |
6db8976c | 72 | ** Entity: can be a VM, container, a template or a storage. |
c5eadcbd WL |
73 | ** Logical pools: it is possible to group entities to a group for easy management. |
74 | * On the right side is the main management center, where all content | |
75 | of the selected entity form the navigation bar is shown. | |
76 | * On the bottom is the task log section, where all tasks are shown. | |
77 | ||
4736f1bc | 78 | Dataceter Level |
76bb3600 | 79 | --------------- |
1a497fa7 | 80 | |
f9c4114c DM |
81 | [thumbnail="gui-datacenter-search.png"] |
82 | ||
6db8976c | 83 | On the datacenter level you can access cluster wide settings and information. |
1a497fa7 WL |
84 | |
85 | * *Search:* it is possible to search anything in cluster | |
86 | ,this can be a node, VM, Container, Storage or a pool. | |
87 | ||
7ec90af3 | 88 | * *Summary:* gives a brief overview over the cluster health. |
1a497fa7 WL |
89 | |
90 | * *Options:* can show and set defaults, which apply cluster wide. | |
91 | ||
92 | * *Storage:* is the place where a storage will add/managed/removed. | |
93 | ||
94 | * *Backup:* has the capability to schedule Backups. This is | |
95 | cluster wide, so you do not care about where the VM/Container are on | |
96 | your cluster at schedule time. | |
97 | ||
98 | * *Permissions:* will manage user and group permission, LDAP, | |
99 | MS-AD and Two-Factor authentication can be setup here. | |
100 | ||
101 | * *HA:* will manage the {pve} High-Availability | |
102 | ||
103 | * *Firewall:* on this level the Proxmox Firewall works cluster wide and | |
104 | makes templates which are cluster wide available. | |
105 | ||
106 | * *Support:* here you get all information about your support subscription. | |
107 | ||
108 | If you like to have more information about this see the corresponding chapter. | |
109 | ||
c8a14dea | 110 | |
4736f1bc | 111 | Node Level |
76bb3600 | 112 | ---------- |
c8a14dea | 113 | |
f9c4114c | 114 | [thumbnail="gui-node-summary.png"] |
c8a14dea WL |
115 | |
116 | All belongs of a node can be managed at this level. | |
117 | ||
118 | * *Search:* it is possible to search anything on the node, | |
119 | this can be a VM, Container, Storage or a pool. | |
120 | ||
7ec90af3 | 121 | * *Summary:* gives a brief overview over the resource usage. |
c8a14dea WL |
122 | |
123 | * *Shell:* log you in the shell of the node. | |
124 | ||
6db8976c | 125 | * *System:* is for configuring the network, dns and time, and also shows your syslog. |
c8a14dea | 126 | |
7ec90af3 | 127 | * *Updates:* will upgrade the system and informs you about new packets. |
c8a14dea WL |
128 | |
129 | * *Firewall:* on this level is only for this node. | |
130 | ||
131 | * *Disk:* gives you an brief overview about you physical hard drives and | |
7ec90af3 | 132 | how they are used. |
c8a14dea WL |
133 | |
134 | * *Ceph:* is only used if you have installed a Ceph sever on you | |
7ec90af3 DC |
135 | host. Then you can manage your Ceph cluster and see the status |
136 | of it here. | |
c8a14dea WL |
137 | |
138 | * *Task History:* here all past task are shown. | |
139 | ||
140 | * *Subscription:* here you can upload you subscription key and get a | |
141 | system overview in case of a support case. | |
142 | ||
34ee078e WL |
143 | VM Level |
144 | -------- | |
145 | ||
146 | [thumbnail="gui-qemu-summary.png"] | |
147 | ||
148 | There are two differed kinds of VM types and both types can be converted to a template. | |
149 | One of them are Kernel-based Virtual Machine (KVM) and the other one are Linux Containers (LXC). | |
150 | General the navigation are the same only some option are different. | |
151 | ||
152 | In the main management center the VM navigation begin if a VM is selected in the left tree. | |
153 | ||
154 | The top header contains important VM operation commands like 'Start', 'Shutdown', 'Rest', | |
155 | 'Remove', 'Migrate', 'Console' and 'Help'. | |
156 | Two of them have hidden buttons like 'Shutdown' has 'Stop' and | |
157 | 'Console' contains the different consolen typs 'SPICE' or 'noVNC'. | |
158 | ||
159 | On the right side the content switch white the focus of the option. | |
160 | ||
161 | On the left side. | |
162 | All available options are listed one below the other. | |
163 | ||
164 | * *Summary:* gives a brief overview over the VM activity. | |
165 | ||
166 | * *Console:* an interactive console to your VM. | |
167 | ||
168 | * *(KVM)Hardware:* shows and set the Hardware of the KVM VM. | |
169 | ||
170 | * *(LXC)Resources:* defines the LXC Hardware opportunities. | |
171 | ||
172 | * *(LXC)Network:* the LXC Network settings. | |
173 | ||
174 | * *(LXC)DNS:* the LXC DNS settings. | |
175 | ||
176 | * *Options:* all VM options can be set here, this distinguishes between KVM and LXC. | |
177 | ||
178 | * *Task History:* here all previous task from this VM will be shown. | |
179 | ||
180 | * *(KVM) Monitor:* is the interactive communication interface to the KVM process. | |
181 | ||
182 | * *Backup:* shows the available backups from this VM and also create a backupset. | |
183 | ||
184 | * *Snapshots:* manage VM snapshots. | |
185 | ||
186 | * *Firewall:* manage the firewall on VM level. | |
187 | ||
188 | * *Permissions:* manage the user permission for this VM. | |
189 | ||
b83fcf1e WL |
190 | Storage Level |
191 | ------------- | |
192 | ||
70919411 | 193 | [thumbnail="gui-storage-summary-local.png"] |
b83fcf1e WL |
194 | |
195 | In this view we have a two partition split view. | |
196 | On the left side we have the storage options | |
197 | and on the right side the content of the selected option will shown. | |
198 | ||
199 | * *Summary:* show you important information about your storage like | |
200 | 'Usage', 'Type', 'Content', 'Active' and 'Enabled'. | |
201 | ||
202 | * *Content:* Here all contend will listed grouped by content. | |
203 | ||
204 | * *Permissions:* manage the user permission for this storage. | |
205 | ||
871feac6 WL |
206 | Logical Pool Level |
207 | ------------------ | |
208 | ||
27edc164 | 209 | [thumbnail="gui-pool-summary-development.png"] |
871feac6 WL |
210 | |
211 | In this view we have a two partition split view. | |
212 | On the left side we have the logical pool options | |
213 | and on the right side the content of the selected option will shown. | |
214 | ||
215 | * *Summary:* show the description of the pool. | |
216 | ||
217 | * *Members:* Here all members of this pool will listed and can be managed. | |
218 | ||
219 | * *Permissions:* manage the user permission for this pool. | |
220 | ||
c5eadcbd WL |
221 | ifdef::wiki[] |
222 | ||
223 | See Also | |
4736f1bc | 224 | -------- |
c5eadcbd WL |
225 | |
226 | * link:/wiki/Central_Web-based_Management | |
227 | ||
228 | endif::wiki[] | |
813e4036 | 229 | |
c5eadcbd WL |
230 | //// |
231 | TODO: | |
232 | ||
813e4036 | 233 | VM, CT, Storage, Pool section |
c5eadcbd WL |
234 | |
235 | //// |