X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pve-gui.adoc;h=3fee2e0ab63bb359d0ca28282c83463a667047a0;hb=a85e5276163234ded6d2c561e2686e0a8155279e;hp=88faa43f7fdb152ccdaa3e018b500651106578d6;hpb=bc22b69baaadba7734e464611a4c8176c45b14cd;p=pve-docs.git diff --git a/pve-gui.adoc b/pve-gui.adoc index 88faa43..3fee2e0 100644 --- a/pve-gui.adoc +++ b/pve-gui.adoc @@ -53,14 +53,14 @@ 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 +NOTE: You can save the user name on the client side by selecting the checkbox at the bottom. This saves some typing when you login next time. @@ -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. @@ -80,7 +80,7 @@ most important actions. Resource Tree:: At the left side. A navigation tree where you can select specific objects. -Content Panel:: Center region. Selected objects displays configuration +Content Panel:: Center region. Selected objects display configuration options and status here. Log Panel:: At the bottom. Displays log entries for recent tasks. You @@ -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,20 +118,49 @@ 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 ~~~~~~~~~~~~~ This is the main navigation tree. On top of the tree you can select -some predefined views, which changes the structure of the tree -below. The default view is *Server View*, and it shows the following +some predefined views, which change the structure of the tree +below. The default view is the *Server View*, and it shows the following object types: [horizontal] -Datacenter:: Contains cluster wide setting (relevant for all nodes). +Datacenter:: Contains cluster-wide settings (relevant for all nodes). -Node:: Represents the hosts inside a cluster, where the guests runs. +Node:: Represents the hosts inside a cluster, where the guests run. -Guest:: VMs, Containers and Templates. +Guest:: VMs, containers and templates. Storage:: Data Storage. @@ -144,13 +171,13 @@ management. The following view types are available: [horizontal] -Server View:: Shows all kind of objects, grouped by nodes. +Server View:: Shows all kinds of objects, grouped by nodes. -Folder View:: Shows all kind of objects, grouped by object type. +Folder View:: Shows all kinds of objects, grouped by object type. -Storage View:: Only show storage objects, grouped by nodes. +Storage View:: Only shows storage objects, grouped by nodes. -Pool View:: Show VMs and Containers, grouped by pool. +Pool View:: Show VMs and containers, grouped by pool. Log Panel @@ -158,179 +185,200 @@ Log Panel The main purpose of the log panel is to show you what is currently going on in your cluster. Actions like creating an new VM are executed -in background, and we call such background job a 'task'. +in the background, and we call such a background job a 'task'. -Any output from such task is saved into a separate log file. You can +Any output from such a task is saved into a separate log file. You can view that log by simply double-click a task log entry. It is also possible to abort a running task there. -Please note that we display most recent tasks from all cluster nodes +Please note that we display the most recent tasks from all cluster nodes here. So you can see when somebody else is working on another cluster node in real-time. NOTE: We remove older and finished task from the log panel to keep -that list short. But you can still find those tasks in the 'Task -History' within the node panel. +that list short. But you can still find those tasks within the node panel in the +'Task History'. -Some short running actions simply sends logs to all cluster +Some short-running actions simply send logs to all cluster members. You can see those messages in the 'Cluster log' panel. Content Panels -------------- -When you select something in the resource tree, the corresponding +When you select an item from 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. +panel. The following sections provide a brief overview of this +functionality. Please refer to the corresponding chapters in the +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. + +* *Search:* perform a cluster-wide search for nodes, VMs, containers, storage + devices, and pools. -On the datacenter level you can access cluster wide settings and information. +* *Summary:* gives a brief overview of the cluster's health and resource usage. -* *Search:* it is possible to search anything in cluster -,this can be a node, VM, Container, Storage or a pool. +* *Cluster:* provides the functionality and information necessary to create or + join a cluster. -* *Summary:* gives a brief overview over the cluster health. +* *Options:* view and manage cluster-wide default settings. -* *Options:* can show and set defaults, which apply cluster wide. +* *Storage:* provides an interface for managing cluster storage. -* *Storage:* is the place where a storage will add/managed/removed. +* *Backup:* schedule backup jobs. This operates cluster wide, so it doesn't + matter where the VMs/containers are on your cluster when scheduling. -* *Backup:* has the capability to schedule Backups. This is - cluster wide, so you do not care about where the VM/Container are on - your cluster at schedule time. +* *Replication:* view and manage replication jobs. -* *Permissions:* will manage user and group permission, LDAP, - MS-AD and Two-Factor authentication can be setup here. +* *Permissions:* manage user, group, and API token permissions, and LDAP, + MS-AD and Two-Factor authentication. -* *HA:* will manage the {pve} High-Availability +* *HA:* manage {pve} High Availability. -* *Firewall:* on this level the Proxmox Firewall works cluster wide and - makes templates which are cluster wide available. +* *ACME:* set up ACME (Let's Encrypt) certificates for server nodes. -* *Support:* here you get all information about your support subscription. +* *Firewall:* configure and make templates for the Proxmox Firewall cluster wide. -If you like to have more information about this see the corresponding chapter. +* *Metric Server:* define external metric servers for {pve}. + +* *Support:* display information about your support subscription. Nodes ~~~~~ -[thumbnail="gui-node-summary.png"] +[thumbnail="screenshot/gui-node-summary.png"] + +Nodes in your cluster can be managed individually 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'. -All belongs of a node can be managed at this level. +* *Search:* search a node for VMs, containers, storage devices, and pools. -* *Search:* it is possible to search anything on the node, - this can be a VM, Container, Storage or a pool. +* *Summary:* display a brief overview of the node's resource usage. -* *Summary:* gives a brief overview over the resource usage. +* *Notes:* write custom comments in xref:markdown_basics[Markdown syntax]. -* *Shell:* log you in the shell of the node. +* *Shell:* access to a shell interface for the node. -* *System:* is for configuring the network, dns and time, and also shows your syslog. +* *System:* configure network, DNS and time settings, and access the syslog. -* *Updates:* will upgrade the system and informs you about new packets. +* *Updates:* upgrade the system and see the available new packages. -* *Firewall:* on this level is only for this node. +* *Firewall:* manage the Proxmox Firewall for a specific node. -* *Disk:* gives you an brief overview about you physical hard drives and - how they are used. +* *Disks:* get an overview of the attached disks, and manage how they are used. -* *Ceph:* is only used if you have installed a Ceph sever on you - host. Then you can manage your Ceph cluster and see the status +* *Ceph:* is only used if you have installed a Ceph server on your + host. In this case, you can manage your Ceph cluster and see the status of it here. -* *Task History:* here all past task are shown. +* *Replication:* view and manage replication jobs. -* *Subscription:* here you can upload you subscription key and get a - system overview in case of a support case. +* *Task History:* see a list of past tasks. + +* *Subscription:* upload a subscription key, and generate a system report for + use in support cases. Guests ~~~~~~ -[thumbnail="gui-qemu-summary.png"] +[thumbnail="screenshot/gui-qemu-summary.png"] + +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 is a Linux Container (LXC). +Navigation for these are mostly the same; only some options are different. -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. +To access the various guest management interfaces, select a VM or container from +the menu on the left. -In the main management center the VM navigation begin if a VM is selected in the left tree. +The header contains commands for items such as power management, migration, +console access and type, cloning, HA, and help. +Some of these buttons contain drop-down menus, for example, 'Shutdown' also contains +other power options, and 'Console' contains the different console types: +'SPICE', 'noVNC' and 'xterm.js'. -The top header contains important VM operation commands like 'Start', 'Shutdown', 'Rest', -'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'. +The panel on the right contains an interface for whatever item is selected from +the menu on the left. -On the right side the content switch white the focus of the option. +The available interfaces are as follows. -On the left side. -All available options are listed one below the other. +* *Summary:* provides a brief overview of the VM's activity and a `Notes` field + for xref:markdown_basics[Markdown syntax] comments. -* *Summary:* gives a brief overview over the VM activity. +* *Console:* access to an interactive console for the VM/container. -* *Console:* an interactive console to your VM. +* *(KVM)Hardware:* define the hardware available to the KVM VM. -* *(KVM)Hardware:* shows and set the Hardware of the KVM VM. +* *(LXC)Resources:* define the system resources available to the LXC. -* *(LXC)Resources:* defines the LXC Hardware opportunities. +* *(LXC)Network:* configure a container's network settings. -* *(LXC)Network:* the LXC Network settings. +* *(LXC)DNS:* configure a container's DNS settings. -* *(LXC)DNS:* the LXC DNS settings. +* *Options:* manage guest options. -* *Options:* all VM options can be set here, this distinguishes between KVM and LXC. +* *Task History:* view all previous tasks related to the selected guest. -* *Task History:* here all previous task from this VM will be shown. +* *(KVM) Monitor:* an interactive communication interface to the KVM process. -* *(KVM) Monitor:* is the interactive communication interface to the KVM process. +* *Backup:* create and restore system backups. -* *Backup:* shows the available backups from this VM and also create a backupset. +* *Replication:* view and manage the replication jobs for the selected guest. -* *Snapshots:* manage VM snapshots. +* *Snapshots:* create and restore VM snapshots. -* *Firewall:* manage the firewall on VM level. +* *Firewall:* configure the firewall on the VM level. -* *Permissions:* manage the user permission for this VM. +* *Permissions:* manage permissions for the selected guest. Storage ~~~~~~~ -[thumbnail="gui-storage-summary-local.png"] +[thumbnail="screenshot/gui-storage-summary-local.png"] + +As with the guest interface, the interface for storage consists of a menu on the +left for certain storage elements and an interface on the right to manage +these elements. -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 -'Usage', 'Type', 'Content', 'Active' and 'Enabled'. +* *Summary:* shows important information about the storage, such as the type, + usage, and content which it stores. -* *Content:* Here all contend will listed grouped by content. +* *Content:* a menu item for each content type which the storage + stores, for example, Backups, ISO Images, CT Templates. -* *Permissions:* manage the user permission for this storage. +* *Permissions:* manage permissions for the storage. 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. +Again, the pools view comprises two partitions: a menu on the left, +and the corresponding interfaces for each menu item on the right. -* *Summary:* show the description of the pool. +* *Summary:* shows a description of the pool. -* *Members:* Here all members of this pool will listed and can be managed. +* *Members:* display and manage pool members (guests and storage). -* *Permissions:* manage the user permission for this pool. +* *Permissions:* manage the permissions for the pool. ifdef::wiki[] @@ -342,9 +390,3 @@ See Also endif::wiki[] -//// -TODO: - -VM, CT, Storage, Pool section - -////