NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Lucky #13 (grammar updates) (#135)

Browse Source 
* Clarification, update links, organize

* add nfs warning, fix debian version

* add ENOSPC troubleshooting

* add more enospc detail

* add note on editing username

* Documentation typo/grammar cleanup part 9

* grammar cleanup v10

* grammar editing v10

* grammar updates v11

* Grammar updates v11

* Lucky #13 (grammar updates)
This commit is contained in:
Jon Sands 2018-05-21 18:00:19 -04:00 committed by Olivier Lambert
parent 95252be5f0
commit 0045a1e608
5 changed files with 28 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/authentication.md
View File

@ -1,17 +1,17 @@
# User authentication
Xen Orchestra support various type of user authentication, internal or even external thanks to the usage of [Passport library](http://passportjs.org/).
Xen Orchestra supports various types of user authentication, internal or even external thanks to the usage of the [Passport library](http://passportjs.org/).
There is 2 types of XO users:
There are 2 types of XO users:
* admins, with all rights on all connected resources
* users, with no right by default
* users, with no rights by default
All users will land on the "flat" view, which display no hierarchy, only all their visible objects (or no object if they are not configured).
All users will land on the "flat" view, which displays no hierarchy, only all their visible objects (or no object if they are not configured).
ACLs will thus apply only on "users".
ACLs will thus apply only to "users".
> Any account created by an external authentication process (LDAP, SSO...) will be a **user** without any permission.

22
docs/backup_reports.md
View File

@ -1,19 +1,18 @@
# How to configure backup reports
At the end of a backup Job, you can configure Xen Orchestra in order to receive a backup reports directly by email, on Slack or on Mattermost. It's up to you.
At the end of a backup job, you can configure Xen Orchestra to send backup reports directly by email, Slack or in Mattermost. It's up to you.
## Email notification
## Email notifications
### Step-by-step
1. On the "settings/plugins" view you have to activate and configure the "Backup-reports" plugin.
![](./assets/backup-reports-plugin.png)
2. Still on the plugins view, you also have to configure the "transport-email" plugin.
2. Still in the plugins view, you also have to configure the "transport-email" plugin.
![](./assets/transport-email-plugin.png)
3. Once it's done, you can now create your backup job. On the line "report" you can choose the situation in wish you want to receive
an email (always, never or failure).
3. Once it's done, you can now create your backup job. In the "report" selection you can choose the situation in wish you want to receive an email (always, never or failure).
![](./assets/backup-report-config.png)
> Note: You can also modify existing backup jobs and change the behaviour of the report system.
@ -21,23 +20,22 @@ an email (always, never or failure).
You can **be notified via XMPP** after the backup task is finished (scheduled "full backup", "snapshots" or "disaster recovery").
To configure it, 2 steps in the plugin section (in "Settings"):
To configure it, 2 steps are needed in the plugin section (under "Settings"):
1. add a list of recipient(s) for the notifications (in the plugin "backup-reports" and for XMPP)
2. set the XMPP server
That's it: your next scheduled jobs will be recap in a message:
That's it: your next scheduled job will be recapped in a message:
![](https://xen-orchestra.com/blog/content/images/2015/12/xmpp.png)
## Slack or Mattermost notifications
Xen Orchestra is able to send backup report to Slack or Mattermost.
Xen Orchestra is able to send backup reports to Slack or Mattermost.
### Plugin configuration
Like all other xo-server plugins, it can be configured directly via
the web iterface, see [the plugin documentation](https://xen-orchestra.com/docs/plugins.html).
Like all other xo-server plugins, it can be configured directly via the web interface, see [the plugin documentation](https://xen-orchestra.com/docs/plugins.html).
### Generate the Webhook
@ -67,9 +65,9 @@ the web iterface, see [the plugin documentation](https://xen-orchestra.com/docs/
#### Mattermost
You need to be an admin.
You need to be an admin:
* Go in MatterMost menu, then Integration
* Go into the MatterMost menu, then Integration
* Click on "Add Incoming webhook"
* "Add Incoming Webhook"

15
docs/backup_troubleshooting.md
View File

@ -1,4 +1,3 @@
# Backup troubleshooting
## Backup progress
@ -15,22 +14,22 @@ Another good way to check if there is activity is the XOA VM stats view (on the
> This message is relevant for *Continuous Delta Backup* or *Continuous Replication* only.
It means your previous VM disks and snapshots should be "merged" (*coalesced* in the XenServer world) before we take a new snapshot. This mechanism is handled by XenServer itself, not Xen Orchestra. But we can check your existing VDI chain and avoiding creating more snapshots than your storage can merge. Otherwise, this will lead to catastrophic consequences. Xen Orchestra is the **only** XenServer/XCP backup product dealing with this.
This means your previous VM disks and snapshots should be "merged" (*coalesced* in the XenServer world) before we take a new snapshot. This mechanism is handled by XenServer itself, not Xen Orchestra. But we can check your existing VDI chain and avoid creating more snapshots than your storage can merge. Otherwise, this will lead to catastrophic consequences. Xen Orchestra is the **only** XenServer/XCP backup product dealing with this.
Without this detection, you could have 2 potential issues:
* `The Snapshot Chain is too Long`
* `SR_BACKEND_FAILURE_44 (insufficient space)`
First one is a chain that contains more than 30 elements (fixed XenServer limit), and the other one means it's full because "coalesced" also can't keep up the pace and the storage is filled.
The first issue is a chain that contains more than 30 elements (fixed XenServer limit), and the other one means it's full because the "coalesce" process couldn't keep up the pace and the storage became filled.
In the end, this message is a **protection mechanism against damaging your SR**. THe backup job will fail but maybe next time it will be run, that chain will be OK.
In the end, this message is a **protection mechanism against damaging your SR**. The backup job will fail, but XenServer itself should eventually automatically coalesce the snapshot chain, and the the next time the backup job should complete.
> You can read more on this into our dedicated blog post regarding [XenServer coalesce detection](https://xen-orchestra.com/blog/xenserver-coalesce-detection-in-xen-orchestra/).
> You can read more on this on our dedicated blog post regarding [XenServer coalesce detection](https://xen-orchestra.com/blog/xenserver-coalesce-detection-in-xen-orchestra/).
### `SR_BACKEND_FAILURE_44 (insufficient space)`
> This message could be triggered by any backup method.
> This message can be triggered by any backup method.
The Storage Repository (where your VM disks are currently stored) is full. Note that doing a snapshot on a thick provisioned SR (LVM family for all block devices, like iSCSI, HBA or Local LVM) will consume the current disk size. Eg if you are using this kind of SR at more than 50% and you want to backup ALL VM disks on it, you'll hit this wall.
@ -38,7 +37,7 @@ Workarounds:
* use a thin provisioned SR (local ext, NFS, XOSAN)
* wait for Citrix to release thin provisioning on LVM
* wait for Citrix to allow another mechanism than snapshot to be able to export disks
* wait for Citrix to allow another mechanism besides snapshot to be able to export disks
* use less than 50% of SR space or don't backup all VMs
### Could not find the base VM
@ -47,7 +46,7 @@ This message appears when the previous replicated VM has been deleted on the tar
### LICENCE_RESTRICTION(PCI_device_for_auto_update)
This message appears when you try to do a backup/snapshot from a VM that was previously on a host with an active commercial XenServer license and which is now on a host with a free edition of XenServer.
This message appears when you try to do a backup/snapshot from a VM that was previously on a host with an active commercial XenServer license but is now on a host with a free edition of XenServer.
To solve it, you have to change a parameter in your VM. `xe vm-param-set has-vendor-device=false uuid=<VM_UUID>`

6
docs/built-in.md
View File

@ -1,10 +1,10 @@
# Built-in
This method is the default one. Creating a user is very simple:
This is the default method. Creating a user is very simple:
1. Go into the Settings view, select "Users"
2. You can create a *user* or an *admin*, with his password (or generate one)
2. You can create a *user* or an *admin*, with their password (or generate one)
![](./assets/usercreation.png)
By default, a *user* won't have any permission. At the opposite, an *admin* will have every rights.
By default, a *user* won't have any permissions. At the opposite, an *admin* will have all rights.

6
docs/ldap.md
View File

@ -1,8 +1,8 @@
# LDAP
XO currently support connection to LDAP directories, like *Open LDAP* or *Active Directory*.
XO currently supports connections to LDAP directories, like *Open LDAP* or *Active Directory*.
To configure your LDAP, go need to go in the *Plugins* section in the "Settings" view. Then configure it:
To configure your LDAP, you need to go into the *Plugins* section in the "Settings" view. Then configure it:
![LDAP plugin settings](./assets/ldapconfig.png)
@ -10,7 +10,7 @@ Don't forget to save the configuration, and also check if the plugin is activate
## Filters
LDAP Filters allow you to match properly your user. It's not an easy task to always find the right filter, and it's entirely depending of your LDAP configuration. Still, here is a list of common filters:
LDAP Filters allow you to properly match your user. It's not an easy task to always find the right filter, and it entirely depends on your LDAP configuration. Still, here is a list of common filters:
* `'(uid={{name}})'` is usually the default filter for *Open LDAP*
* `'(cn={{name}})'`, `'(sAMAccountName={{name}})'`, `'(sAMAccountName={{name}}@<domain>)'` or even `'(userPrincipalName={{name}})'` are widely used for *Active Directory*. Please check with your AD Admin to find the right one.