feat(admin): start to work on v5 UI doc

This commit is contained in:
Olivier Lambert 2016-07-28 17:48:31 +02:00
parent 5352de1b01
commit 7ef6b4fcda
14 changed files with 93 additions and 15 deletions

View File

@ -2,36 +2,114 @@
This part is about everyday XenServer administration tasks.
### Infrastructure overview
## User interface
The original motivation of XO was to provide a view to understand the whole infrastructure in a single page. In short, to answer the question: "where is my VM?".
This section will describe quickly main concepts of Xen Orchestra web interface (`xo-web`).
### Home view
[![](https://xen-orchestra.com/blog/content/images/2014/Aug/main_view.png)](https://xen-orchestra.com/blog/introducing-new-interface/#horizontalhierarchy)
This is home view, what you see when you access your Xen Orchestra URL. It displays all running VMs. This could be configured for your needs (see "Filters section" below).
If you don't have any server connected, you'll see a panel to tell you to add a server:
![](./assets/xo5noserver.png)
#### Add a XenServer host
Just click on "Add server", enter the IP of a XenServer host (ideally the pool master if in a pool):
![](./assets/xo5addserver.png)
After clicking on connect, the server is displayed as connected:
![](./assets/xo5connectedserver.png)
Now go back on Home (or click on the "Xen Orchestra" title on top left of the screen), you'll see the default home view on VMs objects.
#### VMs
This view regroup all **running VMs** on your connected server:
![](./assets/xo5homevms.png)
Let's take a quick tour:
* the global menu is on the left, you can collapse it by clicking on the icon ![](./assets/xo5collapsemenu.png)
* the home view got a header with a type selector (VMs, hosts or pools), a filter zone and a button to create a new VMs
* the VM list also got a header (number of filtered VMs on total VMs) and assisted filters (by pool, host and tags) and a sort menu (by name, memory etc.). You can also expand all VMs details here with the icon ![](./assets/xo5expandhome.png)
> Pro Tip: you can edit a VM name, description and even current host by doing a long click on it
##### Bulk actions
You can select multiple objects (eg VMs) at once to make bulk action. The master checkbox will select all, or you can pick anything yourself.
After selecting one or more object, an action bar is displayed:
![](./assets/xo5bulk.png)
This will execute action for all those objects!
#### Hosts
All host objects are displayed:
![](./assets/xo5host.png)
You have power status, name, description, number of CPU core, total memory, management IP and pool name displayed. You can also edit those with a long click.
> Pro Tip: if some hosts had missing patches, you'll see a red dot with the total patches to install. Click on it to go the patch section of the host. See this blog post on [patches for XenServer](https://xen-orchestra.com/blog/hotfix-xs70e004-for-xenserver-7-0/) for more details.
#### Pools
All your pools are displayed here:
![](./assets/xo5pool.png)
You can also see missing patches in red.
> Did you know? Even a single XenServer host is inside a pool!
### Live filter search
If you infrastructure starts to be big, it could be useful to find exactly what you need. It could be an IP address, a VM name, or a storage name: any object!
The idea is not just to provide a good search engine, but also a complete solution for managing all your XenServer infrastructure. Ideally:
* less clicks to see or make what you want
* find a subset of interesting object
* make bulk actions on all results found
* sort your result for more pertinent insight
[![](https://xen-orchestra.com/blog/content/images/2014/Aug/flat_view_filtered.png)](https://xen-orchestra.com/blog/introducing-new-interface/#flatviewwithpowerfulsearchengine)
> Pro Tip: the URL of Xen Orchestra contains the search string, eg `home?s=power_state%3Arunning+`. You can share those URL to your colleagues to share your search!
You can also use a special query filter with the `*` char:
#### Search examples
* `*{running,halted}`
* `*{VM,SR,Host,Pool}`
We recorded some filters in the dropdown "Filters":
Those "helpers" are accessible in the sub-bar of the search view:
![](./assets/xo5presetfilter.png)
![](https://xen-orchestra.com/blog/content/images/2015/12/searchbar.png)
You can also use other filters here:
#### Examples
![](./assets/xo5presetfilter2.png)
* All running VMs: `*running *vm`
* All halted VMs with a "production" (in a tag): `*vm *halted production`
* Find all SR with a broken link to a host: `*disconnected *sr`
#### Save your search
![](https://xen-orchestra.com/blog/content/images/2015/12/disconnectedsr.png)
If you want to record your filter, just click on "Save" icon ![](./assets/xo5savefilter.png)
After giving a name to your filter, you can find it in the dropdown filter menu.
#### Manage your saved search
Just go in your user zone:
![](./assets/xo5usericon.png)
There, you can edit or remove any filter/search your created!
#### Make a default search
In this user zone, you can set a default filter (preset filters or your own).
> Pro Tip: this is saved in your user preference. It means that you can connect anywhere on any browser, you'll find your preference.
### Easy VM creation

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

BIN
docs/assets/xo5bulk.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 206 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 503 B

BIN
docs/assets/xo5homevms.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

BIN
docs/assets/xo5host.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

BIN
docs/assets/xo5noserver.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

BIN
docs/assets/xo5pool.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 695 B

BIN
docs/assets/xo5usericon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 719 B