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