Merge branch 'xo/master'

.gitignore

@@ -1,3 +1,4 @@
+/_book/
 /coverage/
 /node_modules/
 /lerna-debug.log

book.json

@@ -0,0 +1,9 @@
+{
+  "gitbook": ">=3.0.0",
+  "root": "./docs",
+  "plugins": [
+      "anchors",
+      "-edit-link"
+  ],
+  "pluginsConfig": {}
+}

docs/README.md

@@ -0,0 +1,31 @@
+
+# Xen Orchestra
+
+## Introduction
+
+Welcome to the official Xen Orchestra (XO) documentation.
+
+XO is a web interface to visualize and administer your XenServer (or XAPI enabled) hosts. **No agent** is required for it to work.
+
+It aims to be easy to use on any device supporting modern web technologies (HTML 5, CSS 3, JavaScript), such as your desktop computer or your smartphone.
+
+![](https://pbs.twimg.com/profile_images/601775622675898368/xWbbafyO_400x400.png)
+
+## XOA quick deploy
+
+SSH to your XenServer, and execute the following:
+
+```
+bash -c "$(curl -s http://xoa.io/deploy)"
+```
+
+### XOA credentials
+
+* Web UI: `admin@admin.net` / `admin`
+* Console/SSH: `xoa` / `xoa` (first login)
+
+## Must read
+
+* [XOA installation](xoa.md)
+* [Main features](features.md)
+* [Pro Support](support.md)

docs/SUMMARY.md

@@ -0,0 +1,77 @@
+# Summary
+
+* [Introduction](README.md)
+* [Architecture](architecture.md)
+   * [xo-server](xo-server.md)
+   * [xo-web](xo-web.md)
+   * [xo-cli](xo-cli.md)
+   * [others](others.md)
+* [Installation](installation.md)
+   * [XOA](xoa.md)
+       * [Updater](updater.md)
+       * [Trial activation](trial_activation.md)
+       * [Plugins](plugins.md)
+       * [Logs](logs.md)
+       * [Troubleshooting](troubleshooting.md)
+   * [From the sources](from_the_sources.md)
+* [Configuration](configuration.md)
+* [Features](features.md)
+   * [Administration](administration.md)
+       * [Home view](user_interface.md)
+       * [Search and filters](search.md)
+       * [VM management](vm_management.md)
+       * [VM creation](vm_creation.md)
+       * [VM import and export](vm_import_export.md)
+       * [XenServer Patching](patching.md)
+   * [Docker support](docker_support.md)
+   * [Backup and DR](backups.md)
+       * [Full backups](full_backups.md)
+       * [Rolling snapshots](rolling_snapshots.md)
+       * [Continuous Delta backups](delta_backups.md)
+       * [Continuous Replication](continuous_replication.md)
+       * [Disaster recovery](disaster_recovery.md)
+       * [Smart Backup](smart_backup.md)
+       * [File level Restore](file_level_restore.md)
+       * [Backup Concurrency](concurrency.md)
+       * [Configure backup reports](backup_reports.md)
+       * [Backup troubleshooting](backup_troubleshooting.md)
+   * [User authentication](authentication.md)
+       * [Built-in](built-in.md)
+       * [LDAP](ldap.md)
+       * [SAML](saml.md)
+       * [GitHub](github.md)
+       * [Google](google.md)
+   * [Resources delegation](resources_delegation.md)
+       * [ACLs](acls.md)
+   * [CloudInit](cloudinit.md)
+   * [Self Service](self_service.md)
+   * [Visualizations](visualizations.md)
+   * [Health](health.md)
+   * [Job manager](scheduler.md)
+   * [Alerts](alerts.md)
+   * [Load balancing](load_balancing.md)
+   * [Auto scalability](auto_scalability.md)
+   * [Forecaster](forecaster.md)
+* [Recipes](recipes.md)
+   * [Reverse proxy](reverse_proxy.md)
+* [How to contribute?](contributing.md)
+* [Support](support.md)
+* [Roadmap](roadmap.md)
+* [Purchase](purchase.md)
+   * [Direct purchase](directpurchase.md)
+   * [Through purchase department](through_purchase_department.md)
+   * [Reseller](reseller.md)
+   * [Editions](editions.md)
+   * [Trial](trial.md)
+   * [Invoices](invoices.md)
+   * [Upgrade](upgrade.md)
+* [XOSAN](xosan.md)
+  * [Requirements](xosan_requirements.md)
+  * [Types](xosan_types.md)
+    * [Replicated](xosan_replicated.md)
+    * [Disperse](xosan_disperse.md)
+  * [Creation](xosan_create.md)
+  * [Management](xosan_management.md)
+  * [Trial](xosan_trial.md)
+* [General Troubleshooting](general-troubleshooting.md)
+* [Glossary](glossary.md)

docs/acls.md

@@ -0,0 +1,72 @@
+# ACLs
+
+> ACLs are permissions that apply to pre-existing objects. Only a super admin (XO administrator) can create objects.
+
+ACLs are the permissions for your users or groups. The ACLs view can be accessed in the "Settings" panel.
+
+1. Select the user or group you want to apply permissions on
+2. Select the object on which the permission will apply
+3. Choose the role for this ACL
+4. Click on "Create"
+
+![](./assets/createacl.png)
+
+> Pro tip: you can click to add multiple objects at the same time!
+
+Your ACL is now available in the right list:
+
+![](./assets/acllist.png)
+
+You can edit/remove existing ACLs here.
+
+## Roles
+
+There are 3 different roles for your users:
+
+* Admin
+* Operator
+* Viewer
+
+### Admin
+
+An object admin can do everything on it, even destroy it. E.g with its admin VM:
+
+* remove it
+* migrate it (to a host with admin permission on it)
+* modify the VM resources, name and description
+* clone it
+* copy it
+* convert it into a template
+* snapshot it (even revert from a snapshot)
+* export it
+* attach/add visible disks
+* same for network cards
+
+### Operator
+
+An operator can make everyday operations on assigned objects. E.g on a VM:
+
+* eject a CD
+* insert a CD (if he can view the ISO storage repository)
+* start, restart, shutdown, suspend/resume it
+
+All other operations are forbidden.
+
+### Viewer
+
+A viewer can only see the VM state and its metrics. That's all!
+
+## Inheritance
+
+Objects have a hierarchy: a Pool contains all its hosts, containing itself all its VMs.
+
+If you give a *view* permission to a user (or a group) on a pool, he will automatically see all the objects inside this pool (SRs, hosts, VMs).
+
+## Examples
+
+### Allow a user to install an OS
+
+If the OS install needs an ISO, you need to give this user 2 permissions:
+
+* *Operate* on the VM (e.g to start it)
+* *View* on the ISO Storage containing the needed ISO.

docs/administration.md

@@ -0,0 +1,12 @@
+# Administration
+
+This section contains everyday XenServer administration tasks.
+
+* [Home view](user_interface.md)
+* [Search and filters](search.md)
+* [VM management](vm_management.md)
+* [VM creation](vm_creation.md)
+* [VM import and export](vm_import_export.md)
+* [XenServer Patching](patching.md)
+
+![](./assets/xo5homevms.png)

docs/alerts.md

@@ -0,0 +1,35 @@
+# Alerts
+
+Alerts are a way to warn the administrator about various events. The first kind of alerts will be emails and also in a dedicated area of `xo-web` to display them.
+
+## Performances alerts
+
+The administrator will configure alerts based on performance thresholds.
+
+The configurable metrics are:
+
+* CPU usage (VM, host)
+* RAM usage (VM, host)
+* network bandwidth (VM, host)
+* load average (host)
+* disk IO (VM)
+* total IO (SR, only for XenServer Dundee and higher)
+
+If any configured values exceed the threshold during a selected period of time, an alert will be sent.
+
+Those alerts will be also stored and accessible in the web interface, and also later for the load balancing feature (helping it to solve those performance problems).
+
+## Updates alerts
+
+When your XOA detects new packages, you'll be notified by email.
+
+## Backup alerts
+
+Same story for backups: if a backup fails, you'll receive an email.
+
+You can choose to be notified only if it fails or even after each backup job.
+
+Current supported alerts system:
+
+* Email
+* XMPP

docs/architecture.md

@@ -0,0 +1,28 @@
+
+# Architecture
+
+Xen Orchestra (XO) is software built with a server and clients, such as the web client `xo-web`, but also a CLI capable client, called `xo-cli`.
+
+> XO is totally agent-less: you don't have to install any program on your hosts to get it working!
+
+## XOA
+
+*Xen Orchestra Virtual Appliance* (XOA) is a virtual machine with Xen Orchestra already installed, thus working out-of-the-box.
+
+This is the easiest way to try Xen Orchestra quickly.
+
+Your XOA is connected to all your hosts, or the pool master only if you are using Pools in XenServer:
+
+![](./assets/partner2.jpg)
+
+## Xen Orchestra (XO)
+
+![](./assets/xo-arch.jpg)
+
+Xen Orchestra itself is built as a modular solution. Each part has its role:
+- The core is "[xo-server](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-server/)" - a daemon dealing directly with XenServer or XAPI capable hosts. This is where users are stored, and it's the center point for talking to your whole Xen infrastructure.
+- The web interface is "[xo-web](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-web)" - it runs directly from your browser. The connection with ```xo-server``` is done via *WebSockets*.
+- "[xo-cli](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-cli)" is a module allowing you to send commands directly from the command line.
+
+
+We have other modules as well (like the LDAP plugin for example). It allows us to use this modular architecture to add further parts as we need them. It's completely flexible, allowing us to adapt Xen Orchestra to every existing workflow.