You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

pve-gui.adoc 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. [[chapter_gui]]
  2. Graphical User Interface
  3. ========================
  4. ifndef::manvolnum[]
  5. :pve-toplevel:
  6. endif::manvolnum[]
  7. {pve} is simple. There is no need to install a separate management
  8. tool, and everything can be done through your web browser (Latest
  9. Firefox or Google Chrome is preferred). A built-in HTML5 console is
  10. used to access the guest console. As an alternative,
  11. https://www.spice-space.org/[SPICE] can be used.
  12. Because we use the Proxmox cluster file system (pmxcfs), you can
  13. connect to any node to manage the entire cluster. Each node can manage
  14. the entire cluster. There is no need for a dedicated manager node.
  15. You can use the web-based administration interface with any modern
  16. browser. When {pve} detects that you are connecting from a mobile
  17. device, you are redirected to a simpler, touch-based user interface.
  18. The web interface can be reached via https://youripaddress:8006
  19. (default login is: 'root', and the password is specified during the
  20. installation process).
  21. Features
  22. --------
  23. * Seamless integration and management of {pve} clusters
  24. * AJAX technologies for dynamic updates of resources
  25. * Secure access to all Virtual Machines and Containers via SSL
  26. encryption (https)
  27. * Fast search-driven interface, capable of handling hundreds and
  28. probably thousands of VMs
  29. * Secure HTML5 console or SPICE
  30. * Role based permission management for all objects (VMs, storages,
  31. nodes, etc.)
  32. * Support for multiple authentication sources (e.g. local, MS ADS,
  33. LDAP, ...)
  34. * Two-Factor Authentication (OATH, Yubikey)
  35. * Based on ExtJS 6.x JavaScript framework
  36. Login
  37. -----
  38. [thumbnail="screenshot/gui-login-window.png"]
  39. When you connect to the server, you will first see the login window.
  40. {pve} supports various authentication backends ('Realm'), and
  41. you can select the language here. The GUI is translated to more
  42. than 20 languages.
  43. NOTE: You can save the user name on the client side by selecting the
  44. checkbox at the bottom. This saves some typing when you login next
  45. time.
  46. GUI Overview
  47. ------------
  48. [thumbnail="screenshot/gui-datacenter-summary.png"]
  49. The {pve} user interface consists of four regions.
  50. [horizontal]
  51. Header:: On top. Shows status information and contains buttons for
  52. most important actions.
  53. Resource Tree:: At the left side. A navigation tree where you can select
  54. specific objects.
  55. Content Panel:: Center region. Selected objects display configuration
  56. options and status here.
  57. Log Panel:: At the bottom. Displays log entries for recent tasks. You
  58. can double-click on those log entries to get more details, or to abort
  59. a running task.
  60. NOTE: You can shrink and expand the size of the resource tree and log
  61. panel, or completely hide the log panel. This can be helpful when you
  62. work on small displays and want more space to view other content.
  63. Header
  64. ~~~~~~
  65. On the top left side, the first thing you see is the Proxmox
  66. logo. Next to it is the current running version of {pve}. In the
  67. search bar nearside you can search for specific objects (VMs,
  68. containers, nodes, ...). This is sometimes faster than selecting an
  69. object in the resource tree.
  70. To the right of the search bar we see the identity (login name). The
  71. gear symbol is a button opening the 'My Settings' dialog. There you
  72. can customize some client side user interface setting (reset the saved
  73. login name, reset saved layout).
  74. The rightmost part of the header contains four buttons:
  75. [horizontal]
  76. Help :: Opens a new browser window showing the reference documentation.
  77. Create VM :: Opens the virtual machine creation wizard.
  78. Create CT :: Open the container creation wizard.
  79. Logout :: Logout, and show the login dialog again.
  80. [[gui_my_settings]]
  81. My Settings
  82. ~~~~~~~~~~~
  83. [thumbnail="screenshot/gui-my-settings.png"]
  84. The 'My Settings' window allows you to set locally stored settings. These
  85. include the 'Dashboard Storages' which allow you to enable or disable specific
  86. storages to be counted towards the total amount visible in the datacenter
  87. summary. If no storage is checked the total is the sum of all storages, same
  88. as enabling every single one.
  89. Below the dashboard settings you find the stored user name and a button to
  90. clear it as well as a button to reset every layout in the GUI to its default.
  91. On the right side there are 'xterm.js Settings'. These contain the following
  92. options:
  93. [horizontal]
  94. Font-Family :: The font to be used in xterm.js (e.g. Arial).
  95. Font-Size :: The preferred font size to be used.
  96. Letter Spacing :: Increases or decreases spacing between letters in text.
  97. Line Height :: Specify the absolute height of a line.
  98. Resource Tree
  99. ~~~~~~~~~~~~~
  100. This is the main navigation tree. On top of the tree you can select
  101. some predefined views, which changes the structure of the tree
  102. below. The default view is *Server View*, and it shows the following
  103. object types:
  104. [horizontal]
  105. Datacenter:: Contains cluster wide setting (relevant for all nodes).
  106. Node:: Represents the hosts inside a cluster, where the guests runs.
  107. Guest:: VMs, Containers and Templates.
  108. Storage:: Data Storage.
  109. Pool:: It is possible to group guests using a pool to simplify
  110. management.
  111. The following view types are available:
  112. [horizontal]
  113. Server View:: Shows all kind of objects, grouped by nodes.
  114. Folder View:: Shows all kind of objects, grouped by object type.
  115. Storage View:: Only show storage objects, grouped by nodes.
  116. Pool View:: Show VMs and Containers, grouped by pool.
  117. Log Panel
  118. ~~~~~~~~~
  119. The main purpose of the log panel is to show you what is currently
  120. going on in your cluster. Actions like creating an new VM are executed
  121. in background, and we call such background job a 'task'.
  122. Any output from such task is saved into a separate log file. You can
  123. view that log by simply double-click a task log entry. It is also
  124. possible to abort a running task there.
  125. Please note that we display most recent tasks from all cluster nodes
  126. here. So you can see when somebody else is working on another cluster
  127. node in real-time.
  128. NOTE: We remove older and finished task from the log panel to keep
  129. that list short. But you can still find those tasks in the 'Task
  130. History' within the node panel.
  131. Some short running actions simply sends logs to all cluster
  132. members. You can see those messages in the 'Cluster log' panel.
  133. Content Panels
  134. --------------
  135. When you select something in the resource tree, the corresponding
  136. object displays configuration and status information in the content
  137. panel. The following sections give a brief overview of the
  138. functionality. Please refer to the individual chapters inside the
  139. reference documentation to get more detailed information.
  140. Datacenter
  141. ~~~~~~~~~~
  142. [thumbnail="screenshot/gui-datacenter-search.png"]
  143. On the datacenter level you can access cluster wide settings and information.
  144. * *Search:* it is possible to search anything in cluster
  145. ,this can be a node, VM, Container, Storage or a pool.
  146. * *Summary:* gives a brief overview over the cluster health.
  147. * *Cluster:* allows to create/join cluster and shows join information.
  148. * *Options:* can show and set defaults, which apply cluster wide.
  149. * *Storage:* is the place where a storage will add/managed/removed.
  150. * *Backup:* has the capability to schedule Backups. This is
  151. cluster wide, so you do not care about where the VM/Container are on
  152. your cluster at schedule time.
  153. * *Replication:* shows replication jobs and allows to create new ones.
  154. * *Permissions:* will manage user and group permission, LDAP,
  155. MS-AD and Two-Factor authentication can be setup here.
  156. * *HA:* will manage the {pve} High-Availability
  157. * *Firewall:* on this level the Proxmox Firewall works cluster wide and
  158. makes templates which are cluster wide available.
  159. * *Support:* here you get all information about your support subscription.
  160. If you like to have more information about this see the corresponding chapter.
  161. Nodes
  162. ~~~~~
  163. [thumbnail="screenshot/gui-node-summary.png"]
  164. Nodes in your cluster can be managed invidiually at this level.
  165. The top header has useful buttons such as 'Reboot', 'Shutdown', 'Shell',
  166. 'Bulk Actions' and 'Help'.
  167. 'Shell' has the options 'noVNC', 'SPICE' and 'xterm.js'.
  168. 'Bulk Actions' has the options 'Bulk Start', 'Bulk Stop' and 'Bulk Migrate'.
  169. * *Search:* it is possible to search anything on the node,
  170. this can be a VM, Container, Storage or a pool.
  171. * *Summary:* gives a brief overview over the resource usage.
  172. * *Notes:* is where custom notes about a node can be written.
  173. * *Shell:* logs you into the shell of the node.
  174. * *System:* is for configuring the network, DNS and time, and also shows your syslog.
  175. * *Updates:* will upgrade the system and inform you about new packages.
  176. * *Firewall:* on this level is only for this node.
  177. * *Disks:* gives you a brief overview about you physical hard drives and
  178. how they are used.
  179. * *Ceph:* is only used if you have installed a Ceph server on your
  180. host. Then you can manage your Ceph cluster and see the status
  181. of it here.
  182. * *Replication:* shows replication jobs and allows to create new ones.
  183. * *Task History:* here all past tasks are shown.
  184. * *Subscription:* here you can upload you subscription key and get a
  185. system overview in case of a support case.
  186. Guests
  187. ~~~~~~
  188. [thumbnail="screenshot/gui-qemu-summary.png"]
  189. There are two different kinds of guests and both can be converted to a template.
  190. One of them is a Kernel-based Virtual Machine (KVM) and the other one a Linux Container (LXC).
  191. Generally the navigation is the same, only some options are different.
  192. In the main management center the VM navigation begins if a VM is selected in the left tree.
  193. The top header contains important VM operation commands like 'Start', 'Shutdown', 'Reset',
  194. 'Remove', 'Migrate', 'Console' and 'Help'.
  195. Some of them have hidden buttons like 'Shutdown' has 'Stop' and
  196. 'Console' contains the different console types 'SPICE', 'noVNC' and 'xterm.js'.
  197. On the right side the content switches depending on the selected option.
  198. On the left side.
  199. All available options are listed one below the other.
  200. * *Summary:* gives a brief overview over the VM activity.
  201. * *Console:* an interactive console to your VM.
  202. * *(KVM)Hardware:* shows and set the Hardware of the KVM VM.
  203. * *(LXC)Resources:* defines the LXC Hardware opportunities.
  204. * *(LXC)Network:* the LXC Network settings.
  205. * *(LXC)DNS:* the LXC DNS settings.
  206. * *Options:* all guest options can be set here.
  207. * *Task History:* here all previous tasks from the selected guest will be shown.
  208. * *(KVM) Monitor:* is the interactive communication interface to the KVM process.
  209. * *Backup:* shows the available backups from the selected guest and also create a backupset.
  210. * *Replication:* shows the replication jobs for the selected guest and allows to create new jobs.
  211. * *Snapshots:* manage VM snapshots.
  212. * *Firewall:* manage the firewall on VM level.
  213. * *Permissions:* manage the user permission for the selected guest.
  214. Storage
  215. ~~~~~~~
  216. [thumbnail="screenshot/gui-storage-summary-local.png"]
  217. In this view we have a two partition split-view.
  218. On the left side we have the storage options
  219. and on the right side the content of the selected option will be shown.
  220. * *Summary:* shows important information about storages like
  221. 'Usage', 'Type', 'Content', 'Active' and 'Enabled'.
  222. * *Content:* Here all content will be listed grouped by content type.
  223. * *Permissions:* manage the user permission for this storage.
  224. Pools
  225. ~~~~~
  226. [thumbnail="screenshot/gui-pool-summary-development.png"]
  227. In this view we have a two partition split view.
  228. On the left side we have the logical pool options
  229. and on the right side the content of the selected option will be shown.
  230. * *Summary:* show the description of the pool.
  231. * *Members:* Here all members of this pool will listed and can be managed.
  232. * *Permissions:* manage the user permission for this pool.
  233. ifdef::wiki[]
  234. See Also
  235. --------
  236. * link:/wiki/Central_Web-based_Management
  237. endif::wiki[]
  238. ////
  239. TODO:
  240. VM, CT, Storage, Pool section
  241. ////