Massive documentation update (#109)

* Major refresh on some features, new screenshots
This commit is contained in:
marcpezin 2017-10-21 09:43:50 +02:00 committed by Olivier Lambert
parent 5e3702856f
commit 77d067613d
22 changed files with 19 additions and 53 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/assets/heatmap.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

BIN
docs/assets/job_create.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

BIN
docs/assets/job_execute.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

BIN
docs/assets/jobmanager.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

BIN
docs/assets/react_js.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

View File

@ -1,5 +0,0 @@
# Auto scalability
> This plugin is not developed yet.
The concept here is to detect when your VMs needs more RAM or vCPUs, and act accordingly (to a maximum given by the administrator).

View File

@ -1,19 +0,0 @@
# Forecaster
> This feature is planned for 2016.
Thanks to [machine-learning](https://en.wikipedia.org/wiki/Machine_learning), we should be able to analyze previous events (load evolution, RAM usage, etc.) and to forecast what would come next.
It could leads to:
* forecast report and alerts inside advanced reports
* taking automatic actions before bottlenecks happened
* match the resources needed for a predicted load
* green IT! By cutting useless nodes in quiet moment and boot them just before the load rise
## Example
The system detects that every Monday, you got a huge CPU spike on some VMs. It could:
* report you this information
* scale up those VMs just before those spikes, and scale them down after

View File

@ -1,8 +1,8 @@
# Full backups
You can schedule full backups of your VMs, by exporting them in the local XOA file-system, or directly in a NFS or SMB share. "Depth" parameter allow to modify the retention (removing the oldest one).
You can schedule full backups of your VMs, by exporting them in the local XOA file-system, or directly in a NFS or SMB share. "rentention" parameter allow to modify the retention (removing the oldest one).
[![](https://xen-orchestra.com/blog/content/images/2015/07/backupexample.png)](https://xen-orchestra.com/blog/backup-your-xenserver-vms-with-xen-orchestra/)
[![](./assets/backupexample.png)](https://xen-orchestra.com/blog/backup-your-xenserver-vms-with-xen-orchestra/)
Full backups are space consuming! But they allow a very simple restoration without anything to think of (the file will contain all the VM disks and information).

View File

@ -6,10 +6,10 @@ This view will help you to find any bottleneck or to compare the metrics of your
A heatmap allows its reader to understand when your VMs or hosts are stressed. Values are relative, thus it's easy to detect trends or spikes.
[![](https://xen-orchestra.com/blog/content/images/2015/08/db1.png)](https://xen-orchestra.com/blog/xen-orchestra-4-4/#heatmapforinfrastructurehealth).
[![](./assets/heatmap.png)](https://xen-orchestra.com/blog/xen-orchestra-4-4/#heatmapforinfrastructurehealth).
### Event correlation
This is the place to compare metrics on comparable objects (VMs to VMs, hosts to hosts).
[![](https://xen-orchestra.com/blog/content/images/2015/09/correlate_small.jpg)](https://xen-orchestra.com/blog/xen-orchestra-4-6#eventcorrelation).
[![](https://xen-orchestra.com/blog/content/images/2015/09/correlate_small.jpg)](https://xen-orchestra.com/blog/xen-orchestra-4-6#eventcorrelation).

View File

@ -1,16 +1,11 @@
# Roadmap
Please consider it as an indicative roadmap, things can change.
Item are expressed in a (roughly) decreasing priority order.
> Our roadmap is very flexible, you can check the milestones repository for a complete overview of all the features we are working on.
## Features
- [Milestones](https://github.com/vatesfr/xo-web/milestones)
- Cloud Backup
- [Alerts and reports](alerts.md)
- [Auto scalability](auto_scalability.md)
- [Forecaster](forecaster.md)
## Fixes

View File

@ -6,7 +6,7 @@ The key idea is to be able to schedule any action (migrate, reboot etc.), like f
In the main menu, go inside the "Job Manager" section:
![](https://xen-orchestra.com/blog/content/images/2015/11/jobmanager.png)
![](./assets/jobmanager.png)
You can now **schedule all actions** on your hosts, VMs, or ACLs. It's configured in 2 steps:
@ -15,19 +15,19 @@ You can now **schedule all actions** on your hosts, VMs, or ACLs. It's configure
Real example, step by step: **Creating a job called "security reboot"** (in this case, restart "nfs" and "Core1" VMs):
![](https://xen-orchestra.com/blog/content/images/2015/11/job_create.png)
![](./assets/job_create.png)
Note that you can execute this job **now** by clicking on the orange play button (to test it for instance):
![](https://xen-orchestra.com/blog/content/images/2015/11/job_execute.png)
![](./assets/job_execute.png)
**Schedule the job** (every Sunday at 5:00 AM):
![](https://xen-orchestra.com/blog/content/images/2015/11/schedule_job.png)
![](./assets/schedule_job.png)
And this is it! The job is listed in the Overview:
![](https://xen-orchestra.com/blog/content/images/2015/11/schedule_recap.png)
![](./assets/schedule_recap.png)
Possibilities are infinite! You can plan a LOT of things (any actions on a VM, like migrate, start, clone, suspend etc. Same thing apply on a host).
@ -51,4 +51,4 @@ Possibilities are infinite! You can plan a LOT of things (any actions on a VM, l
### Add or Remove ACLs
* revoke your user ACLs Friday at 11:00PM (e.g: no access on the week end)
* restore them Monday at 6:00AM
* restore them Monday at 6:00AM

View File

@ -1,22 +1,17 @@
# Visualizations
> Visualization are available since 4.4
Visualizations help you to understand your own XenServer infrastructure, to correlate event and detect bottlenecks.
### Dashboard
The dashboard is a view gathering information on all your connected pools/hosts.
[![](https://xen-orchestra.com/blog/content/images/2015/11/dashboard1.png)](https://xen-orchestra.com/blog/xen-orchestra-4-4/#dashboard).
[![](./assets/visualizationdashboard.png)](https://xen-orchestra.com/blog/xen-orchestra-4-4/#dashboard).
> You can also update all your hosts (install missing patches) from this place.
### Sunburst
### Parralel Coordinates
A sunburst visualization helps a lot to detect proportions in a hierarchical environment. Two cases with XenServer:
A Parallel Coordinates visualization helps a lot to detect proportions in a hierarchical environment. In a XenServer environment, it's especially useful if you seek information in a large amount of data.
* VM disk usage in storage repositories
* VM RAM usage in hosts
[![](https://xen-orchestra.com/blog/content/images/2015/07/sunburst-2.png)](https://xen-orchestra.com/blog/xen-orchestra-4-4/#sunburstvisualizationforvdiandramusage).
[![](./assets/parralelcoordinates.png)](https://xen-orchestra.com/blog/xen-orchestra-4-4/#sunburstvisualizationforvdiandramusage).

View File

@ -6,8 +6,8 @@ This is probably the first thing you'll see of Xen Orchestra. It's the Web inter
[Read the features section](https://vates.gitbooks.io/xen-orchestra/content/features.html) to discover what you can do in XO-web.
### JavaScript
### ReactJS
We are also using JavaScript for XO-web: we stay consistent from the back-end to the front-end with one main language. [AngularJS](https://en.wikipedia.org/wiki/Angularjs) and [Twitter Bootstrap](https://en.wikipedia.org/wiki/Bootstrap_%28front-end_framework%29) are also powerful allies to our everyday development.
We stay consistent from the back-end to the front-end with one main language: [ReactJS](https://reactjs.org/)
![](http://www.treselle.com/wp-content/uploads/freshizer/b7cac3b15cae8cc0b8dbbbfc780cd7a4_angularjs-bootstrap-863-430-c.jpg)
![](./assets/react_js.png)