X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pve-gui.adoc;h=ff95cfbc314262c35aefb773f5a8184424e124ee;hp=b4d7c8d4d79ea5c88a93630af61d39986848aded;hb=HEAD;hpb=6db8976c7c4ce2475e6806ddd0a942eff579465e diff --git a/pve-gui.adoc b/pve-gui.adoc index b4d7c8d..bda370f 100644 --- a/pve-gui.adoc +++ b/pve-gui.adoc @@ -6,128 +6,450 @@ ifndef::manvolnum[] endif::manvolnum[] {pve} is simple. There is no need to install a separate management -tool, everything can be done via your web browser (Latest Firefox and -Google Chrome is preferred). To access VM/CT console, a built in HTML5 -console is used. As alternative, SPICE can be used. +tool, and everything can be done through your web browser (Latest +Firefox or Google Chrome is preferred). A built-in HTML5 console is +used to access the guest console. As an alternative, +https://www.spice-space.org/[SPICE] can be used. -As we use Proxmox Cluster file system (pmxcfs),you can connect to any -node to manage the whole cluster. +Because we use the Proxmox cluster file system (pmxcfs), you can +connect to any node to manage the entire cluster. Each node can manage +the entire cluster. There is no need for a dedicated manager node. -To use the Central Web-based Management, you need a modern browser, -this includes: - -* Firefox, a release from the current year, or the latest Enterprise -* Support Release Chrome, a release from the current year -* Microsoft currently supported versions of Edge Browser -* Apple currently supported versions of Safari - -If {pve} detect you're connecting from a mobile device, you will -redirected to a light weight touch based UI. +You can use the web-based administration interface with any modern +browser. When {pve} detects that you are connecting from a mobile +device, you are redirected to a simpler, touch-based user interface. The web interface can be reached via https://youripaddress:8006 -(default login is: root, the password is specified during the -installation). +(default login is: 'root', and the password is specified during the +installation process). Features -------- -* Seamless integration and management of Proxmox VE 4.x Cluster +* Seamless integration and management of {pve} clusters + * AJAX technologies for dynamic updates of resources -* Secure access to all Virtual Machines and Containers via SSL encryption (https) -* Fast search-driven interface, capable of handling hundreds and probably thousands of VMs + +* Secure access to all Virtual Machines and Containers via SSL + encryption (https) + +* Fast search-driven interface, capable of handling hundreds and + probably thousands of VMs + * Secure HTML5 console or SPICE -* Role based permission management for all objects (VMs, storages, nodes, etc.) -* Support for multiple authentication sources (e.g. local, MS ADS, LDAP, ...) -* Two-Factor Authentication -* Proxmox VE Firewall -* Based on Ext JS 6.x JavaScript framework + +* Role based permission management for all objects (VMs, storages, + nodes, etc.) + +* Support for multiple authentication sources (e.g. local, MS ADS, + LDAP, ...) + +* Two-Factor Authentication (OATH, Yubikey) + +* Based on ExtJS 7.x JavaScript framework + + +Login +----- + +[thumbnail="screenshot/gui-login-window.png"] + +When you connect to the server, you will first see the login window. +{pve} supports various authentication backends ('Realm'), and +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 selecting the +checkbox at the bottom. This saves some typing when you login next +time. GUI Overview ------------ -[thumbnail="gui-datacenter-summary.png"] +[thumbnail="screenshot/gui-datacenter-summary.png"] + +The {pve} user interface consists of four regions. + +[horizontal] + +Header:: On top. Shows status information and contains buttons for +most important actions. + +Resource Tree:: At the left side. A navigation tree where you can select +specific objects. + +Content Panel:: Center region. Selected objects display configuration +options and status here. + +Log Panel:: At the bottom. Displays log entries for recent tasks. You +can double-click on those log entries to get more details, or to abort +a running task. + +NOTE: You can shrink and expand the size of the resource tree and log +panel, or completely hide the log panel. This can be helpful when you +work on small displays and want more space to view other content. + + +Header +~~~~~~ + +On the top left side, the first thing you see is the Proxmox +logo. Next to it is the current running version of {pve}. In the +search bar nearside you can search for specific objects (VMs, +containers, nodes, ...). This is sometimes faster than selecting an +object in the resource tree. + +The right part of the header contains four buttons: + +[horizontal] +Documentation :: Opens a new browser window showing the reference documentation. + +Create VM :: Opens the virtual machine creation wizard. + +Create CT :: Open the container creation wizard. + +User Menu :: Displays the identity of the user you're currently logged in +with, and clicking it opens a menu with user-specific options. ++ +In the user menu, you'll find the 'My Settings' dialog, which provides local UI +settings. Below that, there are shortcuts for 'TFA' (Two-Factor Authentication) +and 'Password' self-service. You'll also find options to change the 'Language' +and the 'Color Theme.' Finally, at the bottom of the menu is the 'Logout' +option. + + +[[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 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 settings (relevant for all nodes). + +Node:: Represents the hosts inside a cluster, where the guests run. + +Guest:: VMs, containers and templates. + +Storage:: Data Storage. + +Pool:: It is possible to group guests using a pool to simplify +management. + + +The following view types are available: + +[horizontal] +Server View:: Shows all kinds of objects, grouped by nodes. + +Folder View:: Shows all kinds of objects, grouped by object type. + +Pool View:: Show VMs and containers, grouped by pool. + + +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 the background, and we call such a background job a 'task'. + +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 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 within the node panel in the +'Task History'. + +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 an item from the resource tree, the corresponding +object displays configuration and status information in the content +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. -The GUI has 3 sections: -* On the left side is the navigation bar. On the top, you can select one of 4 - views. Those views change the structure of the tree below. The default - selection is *Server View* and it has the following 4 types of elements. -** Datacenter: contains all the settings belonging to all machines. -** Nodes: represent the host where the VM/CT runs on. It is named like - the hostname. Normally the name was set by the installation. -** Entity: can be a VM, container, a template or a storage. -** Logical pools: it is possible to group entities to a group for easy management. -* On the right side is the main management center, where all content - of the selected entity form the navigation bar is shown. -* On the bottom is the task log section, where all tasks are shown. +Datacenter +~~~~~~~~~~ +[thumbnail="screenshot/gui-datacenter-search.png"] -Dataceter Level ---------------- +On the datacenter level, you can access cluster-wide settings and information. -[thumbnail="gui-datacenter-search.png"] +* *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}. +* *Notifications:* configurate notification behavior and targets for {pve}. -Node Level ----------- +* *Support:* display information about your support subscription. -[thumbnail="gui-node-summary.png"] -All belongs of a node can be managed at this level. +Nodes +~~~~~ -* *Search:* it is possible to search anything on the node, - this can be a VM, Container, Storage or a pool. +[thumbnail="screenshot/gui-node-summary.png"] -* *Summary:* gives a brief overview over the resource usage. +Nodes in your cluster can be managed individually at this level. -* *Shell:* log you in the shell of the node. +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 Shutdown' and 'Bulk Migrate'. -* *System:* is for configuring the network, dns and time, and also shows your syslog. +* *Search:* search a node for VMs, containers, storage devices, and pools. -* *Updates:* will upgrade the system and informs you about new packets. +* *Summary:* display a brief overview of the node's resource usage. -* *Firewall:* on this level is only for this node. +* *Notes:* write custom comments in xref:markdown_basics[Markdown syntax]. -* *Disk:* gives you an brief overview about you physical hard drives and - how they are used. +* *Shell:* access to a shell interface for the node. -* *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 +* *System:* configure network, DNS and time settings, and access the syslog. + +* *Updates:* upgrade the system and see the available new packages. + +* *Firewall:* manage the Proxmox Firewall for a specific node. + +* *Disks:* get an overview of the attached disks, and manage how they are used. + +* *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. + +* *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="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. + +To access the various guest management interfaces, select a VM or container from +the menu on the left. + +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 panel on the right contains an interface for whatever item is selected from +the menu on the left. + +The available interfaces are as follows. + +* *Summary:* provides a brief overview of the VM's activity and a `Notes` field + for xref:markdown_basics[Markdown syntax] comments. + +* *Console:* access to an interactive console for the VM/container. + +* *(KVM)Hardware:* define the hardware available to the KVM VM. + +* *(LXC)Resources:* define the system resources available to the LXC. + +* *(LXC)Network:* configure a container's network settings. + +* *(LXC)DNS:* configure a container's DNS settings. + +* *Options:* manage guest options. + +* *Task History:* view all previous tasks related to the selected guest. + +* *(KVM) Monitor:* an interactive communication interface to the KVM process. + +* *Backup:* create and restore system backups. + +* *Replication:* view and manage the replication jobs for the selected guest. + +* *Snapshots:* create and restore VM snapshots. + +* *Firewall:* configure the firewall on the VM level. + +* *Permissions:* manage permissions for the selected guest. + + +Storage +~~~~~~~ + +[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. -* *Subscription:* here you can upload you subscription key and get a - system overview in case of a support case. +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 be shown. + +* *Summary:* shows important information about the storage, such as the type, + usage, and content which it stores. + +* *Content:* a menu item for each content type which the storage + stores, for example, Backups, ISO Images, CT Templates. + +* *Permissions:* manage permissions for the storage. + + +Pools +~~~~~ + +[thumbnail="screenshot/gui-pool-summary-development.png"] + +Again, the pools view comprises two partitions: a menu on the left, +and the corresponding interfaces for each menu item on the right. + +* *Summary:* shows a description of the pool. + +* *Members:* display and manage pool members (guests and storage). + +* *Permissions:* manage the permissions for the pool. + + +Tags +---- + +[thumbnail="screenshot/gui-qemu-summary-tags-edit.png", float="left"] + +For organizational purposes, it is possible to set `tags` for guests. +Currently, these only provide informational value to users. +Tags are displayed in two places in the web interface: in the `Resource Tree` and +in the status line when a guest is selected. + +Tags can be added, edited, and removed in the status line of the guest by +clicking on the `pencil` icon. You can add multiple tags by pressing the `+` +button and remove them by pressing the `-` button. To save or cancel the changes, +you can use the `✓` and `x` button respectively. + +Tags can also be set via the CLI, where multiple tags are separated by semicolons. +For example: + +---- +# qm set ID --tags myfirsttag;mysecondtag +---- + +Style Configuration +~~~~~~~~~~~~~~~~~~~ + +[thumbnail="screenshot/gui-datacenter-tag-style.png"] + +By default, the tag colors are derived from their text in a deterministic way. +The color, shape in the resource tree, and case-sensitivity, as well as how tags +are sorted, can be customized. This can be done via the web interface under +__Datacenter -> Options -> Tag Style Override__. Alternatively, this can be done +via the CLI. For example: + +---- +# pvesh set /cluster/options --tag-style color-map=example:000000:FFFFFF +---- + +sets the background color of the tag `example` to black (#000000) and the text +color to white (#FFFFFF). + +Permissions +~~~~~~~~~~~ + +[thumbnail="screenshot/gui-datacenter-options.png"] + +By default, users with the privilege `VM.Config.Options` on a guest (`/vms/ID`) +can set any tags they want (see +xref:pveum_permission_management[Permission Management]). If you want to +restrict this behavior, appropriate permissions can be set under +__Datacenter -> Options -> User Tag Access__: + +* `free`: users are not restricted in setting tags (Default) +* `list`: users can set tags based on a predefined list of tags +* `existing`: like list but users can also use already existing tags +* `none`: users are restricted from using tags + +The same can also be done via the CLI. + +Note that a user with the `Sys.Modify` privileges on `/` is always able to set +or delete any tags, regardless of the settings here. Additionally, there is a +configurable list of `registered tags` which can only be added and removed by +users with the privilege `Sys.Modify` on `/`. The list of registered tags can be +edited under __Datacenter -> Options -> Registered Tags__ or via the CLI. + + +For more details on the exact options and how to invoke them in the CLI, see +xref:datacenter_configuration_file[Datacenter Configuration]. ifdef::wiki[] @@ -138,9 +460,3 @@ See Also endif::wiki[] -//// -TODO: - -VM, CT, Storage, Pool section - -////