X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pve-gui.adoc;h=2d1cd28bcead55aac26d9ffe4b6fa0504acae23f;hp=88faa43f7fdb152ccdaa3e018b500651106578d6;hb=a45c999b4586734621bbc968d67f87390739b270;hpb=bc22b69baaadba7734e464611a4c8176c45b14cd diff --git a/pve-gui.adoc b/pve-gui.adoc index 88faa43..2d1cd28 100644 --- a/pve-gui.adoc +++ b/pve-gui.adoc @@ -53,11 +53,11 @@ Features Login ----- -[thumbnail="gui-login-window.png"] +[thumbnail="screenshot/gui-login-window.png"] -When you connect to the server, you will first see the longin window. +When you connect to the server, you will first see the login window. {pve} supports various authentication backends ('Realm'), and -you can select the langauage here. The GUI is translated to more +you can select the language here. The GUI is translated to more than 20 languages. NOTE: You can save the user name on the client side by selection the @@ -68,7 +68,7 @@ time. GUI Overview ------------ -[thumbnail="gui-datacenter-summary.png"] +[thumbnail="screenshot/gui-datacenter-summary.png"] The {pve} user interface consists of four regions. @@ -101,8 +101,6 @@ search bar nearside you can search for specific objects (VMs, containers, nodes, ...). This is sometimes faster than selecting an object in the resource tree. -[thumbnail="gui-my-settings.png"] - To the right of the search bar we see the identity (login name). The gear symbol is a button opening the 'My Settings' dialog. There you can customize some client side user interface setting (reset the saved @@ -111,7 +109,7 @@ login name, reset saved layout). The rightmost part of the header contains four buttons: [horizontal] -Help :: Opens a new browser window showing the reference documenation. +Help :: Opens a new browser window showing the reference documentation. Create VM :: Opens the virtual machine creation wizard. @@ -120,6 +118,35 @@ Create CT :: Open the container creation wizard. Logout :: Logout, and show the login dialog again. +[[gui_my_settings]] +My Settings +~~~~~~~~~~~ + +[thumbnail="screenshot/gui-my-settings.png"] + +The 'My Settings' window allows you to set locally stored settings. These +include the 'Dashboard Storages' which allow you to enable or disable specific +storages to be counted towards the total amount visible in the datacenter +summary. If no storage is checked the total is the sum of all storages, same +as enabling every single one. + +Below the dashboard settings you find the stored user name and a button to +clear it as well as a button to reset every layout in the GUI to its default. + +On the right side there are 'xterm.js Settings'. These contain the following +options: + +[horizontal] +Font-Family :: The font to be used in xterm.js (e.g. Arial). + +Font-Size :: The preferred font size to be used. + +Letter Spacing :: Increases or decreases spacing between letters in text. + +Line Height :: Specify the absolute height of a line. + + + Resource Tree ~~~~~~~~~~~~~ @@ -183,13 +210,13 @@ When you select something in the resource tree, the corresponding object displays configuration and status information in the content panel. The following sections give a brief overview of the functionality. Please refer to the individual chapters inside the -reference documentatin to get more detailed information. +reference documentation to get more detailed information. Datacenter ~~~~~~~~~~ -[thumbnail="gui-datacenter-search.png"] +[thumbnail="screenshot/gui-datacenter-search.png"] On the datacenter level you can access cluster wide settings and information. @@ -198,6 +225,8 @@ On the datacenter level you can access cluster wide settings and information. * *Summary:* gives a brief overview over the cluster health. +* *Cluster:* allows to create/join cluster and shows join information. + * *Options:* can show and set defaults, which apply cluster wide. * *Storage:* is the place where a storage will add/managed/removed. @@ -206,6 +235,8 @@ On the datacenter level you can access cluster wide settings and information. cluster wide, so you do not care about where the VM/Container are on your cluster at schedule time. +* *Replication:* shows replication jobs and allows to create new ones. + * *Permissions:* will manage user and group permission, LDAP, MS-AD and Two-Factor authentication can be setup here. @@ -222,31 +253,40 @@ If you like to have more information about this see the corresponding chapter. Nodes ~~~~~ -[thumbnail="gui-node-summary.png"] +[thumbnail="screenshot/gui-node-summary.png"] -All belongs of a node can be managed at this level. +Nodes in your cluster can be managed invidiually at this level. + +The top header has useful buttons such as 'Reboot', 'Shutdown', 'Shell', +'Bulk Actions' and 'Help'. +'Shell' has the options 'noVNC', 'SPICE' and 'xterm.js'. +'Bulk Actions' has the options 'Bulk Start', 'Bulk Stop' and 'Bulk Migrate'. * *Search:* it is possible to search anything on the node, this can be a VM, Container, Storage or a pool. * *Summary:* gives a brief overview over the resource usage. -* *Shell:* log you in the shell of the node. +* *Notes:* is where custom notes about a node can be written. + +* *Shell:* logs you into the shell of the node. -* *System:* is for configuring the network, dns and time, and also shows your syslog. +* *System:* is for configuring the network, DNS and time, and also shows your syslog. -* *Updates:* will upgrade the system and informs you about new packets. +* *Updates:* will upgrade the system and inform you about new packages. * *Firewall:* on this level is only for this node. -* *Disk:* gives you an brief overview about you physical hard drives and +* *Disks:* gives you a brief overview about you physical hard drives and how they are used. -* *Ceph:* is only used if you have installed a Ceph sever on you +* *Ceph:* is only used if you have installed a Ceph server on your host. Then you can manage your Ceph cluster and see the status of it here. -* *Task History:* here all past task are shown. +* *Replication:* shows replication jobs and allows to create new ones. + +* *Task History:* here all past tasks are shown. * *Subscription:* here you can upload you subscription key and get a system overview in case of a support case. @@ -255,20 +295,20 @@ All belongs of a node can be managed at this level. Guests ~~~~~~ -[thumbnail="gui-qemu-summary.png"] +[thumbnail="screenshot/gui-qemu-summary.png"] -There are two differed kinds of VM types and both types can be converted to a template. -One of them are Kernel-based Virtual Machine (KVM) and the other one are Linux Containers (LXC). -General the navigation are the same only some option are different. +There are two different kinds of guests and both can be converted to a template. +One of them is a Kernel-based Virtual Machine (KVM) and the other one a Linux Container (LXC). +Generally the navigation is the same, only some options are different. -In the main management center the VM navigation begin if a VM is selected in the left tree. +In the main management center the VM navigation begins if a VM is selected in the left tree. -The top header contains important VM operation commands like 'Start', 'Shutdown', 'Rest', +The top header contains important VM operation commands like 'Start', 'Shutdown', 'Reset', 'Remove', 'Migrate', 'Console' and 'Help'. -Two of them have hidden buttons like 'Shutdown' has 'Stop' and -'Console' contains the different consolen typs 'SPICE' or 'noVNC'. +Some of them have hidden buttons like 'Shutdown' has 'Stop' and +'Console' contains the different console types 'SPICE', 'noVNC' and 'xterm.js'. -On the right side the content switch white the focus of the option. +On the right side the content switches depending on the selected option. On the left side. All available options are listed one below the other. @@ -285,34 +325,36 @@ All available options are listed one below the other. * *(LXC)DNS:* the LXC DNS settings. -* *Options:* all VM options can be set here, this distinguishes between KVM and LXC. +* *Options:* all guest options can be set here. -* *Task History:* here all previous task from this VM will be shown. +* *Task History:* here all previous tasks from the selected guest will be shown. * *(KVM) Monitor:* is the interactive communication interface to the KVM process. -* *Backup:* shows the available backups from this VM and also create a backupset. +* *Backup:* shows the available backups from the selected guest and also create a backupset. + +* *Replication:* shows the replication jobs for the selected guest and allows to create new jobs. * *Snapshots:* manage VM snapshots. * *Firewall:* manage the firewall on VM level. -* *Permissions:* manage the user permission for this VM. +* *Permissions:* manage the user permission for the selected guest. Storage ~~~~~~~ -[thumbnail="gui-storage-summary-local.png"] +[thumbnail="screenshot/gui-storage-summary-local.png"] -In this view we have a two partition split view. +In this view we have a two partition split-view. On the left side we have the storage options -and on the right side the content of the selected option will shown. +and on the right side the content of the selected option will be shown. -* *Summary:* show you important information about your storage like +* *Summary:* shows important information about storages like 'Usage', 'Type', 'Content', 'Active' and 'Enabled'. -* *Content:* Here all contend will listed grouped by content. +* *Content:* Here all content will be listed grouped by content type. * *Permissions:* manage the user permission for this storage. @@ -320,11 +362,11 @@ and on the right side the content of the selected option will shown. Pools ~~~~~ -[thumbnail="gui-pool-summary-development.png"] +[thumbnail="screenshot/gui-pool-summary-development.png"] In this view we have a two partition split view. On the left side we have the logical pool options -and on the right side the content of the selected option will shown. +and on the right side the content of the selected option will be shown. * *Summary:* show the description of the pool.