feat(xo-server-cloud): 0.2.4

Fixes #3245

.flowconfig

@@ -9,6 +9,7 @@
 
 [options]
 esproposal.decorators=ignore
+esproposal.optional_chaining=enable
 include_warnings=true
 module.use_strict=true
 

.gitignore

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

@xen-orchestra/babel-config/index.js

@@ -11,10 +11,16 @@ const configs = {
   '@babel/plugin-proposal-decorators': {
     legacy: true,
   },
+  '@babel/plugin-proposal-pipeline-operator': {
+    proposal: 'minimal',
+  },
   '@babel/preset-env' (pkg) {
     return {
       debug: !__TEST__,
-      loose: true,
+
+      // disabled until https://github.com/babel/babel/issues/8323 is resolved
+      // loose: true,
+
       shippedProposals: true,
       targets: __PROD__
         ? (() => {

@xen-orchestra/cron/package.json

@@ -41,10 +41,10 @@
     "moment-timezone": "^0.5.14"
   },
   "devDependencies": {
-    "@babel/cli": "7.0.0-beta.49",
-    "@babel/core": "7.0.0-beta.49",
-    "@babel/preset-env": "7.0.0-beta.49",
-    "@babel/preset-flow": "7.0.0-beta.49",
+    "@babel/cli": "7.0.0-rc.1",
+    "@babel/core": "7.0.0-rc.1",
+    "@babel/preset-env": "7.0.0-rc.1",
+    "@babel/preset-flow": "7.0.0-rc.1",
     "cross-env": "^5.1.3",
     "rimraf": "^2.6.2"
   },

@xen-orchestra/fs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xen-orchestra/fs",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "license": "AGPL-3.0",
   "description": "The File System for Xen Orchestra backups.",
   "keywords": [],
@@ -20,24 +20,24 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@babel/runtime": "^7.0.0-beta.49",
-    "@marsaud/smb2-promise": "^0.2.1",
+    "@babel/runtime": "7.0.0-rc.1",
+    "@marsaud/smb2": "^0.9.0",
     "execa": "^0.10.0",
-    "fs-extra": "^6.0.1",
-    "get-stream": "^3.0.0",
+    "fs-extra": "^7.0.0",
+    "get-stream": "^4.0.0",
     "lodash": "^4.17.4",
     "promise-toolbox": "^0.9.5",
     "through2": "^2.0.3",
     "tmp": "^0.0.33",
-    "xo-remote-parser": "^0.3"
+    "xo-remote-parser": "^0.5.0"
   },
   "devDependencies": {
-    "@babel/cli": "7.0.0-beta.49",
-    "@babel/core": "7.0.0-beta.49",
-    "@babel/plugin-proposal-function-bind": "7.0.0-beta.49",
-    "@babel/plugin-transform-runtime": "^7.0.0-beta.49",
-    "@babel/preset-env": "7.0.0-beta.49",
-    "@babel/preset-flow": "7.0.0-beta.49",
+    "@babel/cli": "7.0.0-rc.1",
+    "@babel/core": "7.0.0-rc.1",
+    "@babel/plugin-proposal-function-bind": "7.0.0-rc.1",
+    "@babel/plugin-transform-runtime": "7.0.0-rc.1",
+    "@babel/preset-env": "7.0.0-rc.1",
+    "@babel/preset-flow": "7.0.0-rc.1",
     "babel-plugin-lodash": "^3.3.2",
     "cross-env": "^5.1.3",
     "index-modules": "^0.3.0",

@xen-orchestra/fs/src/local.js

@@ -81,15 +81,13 @@ export default class LocalHandler extends RemoteHandlerAbstract {
   }
 
   async _createReadStream (file, options) {
-    if (typeof file === 'string') {
-      return fs.createReadStream(this._getFilePath(file), options)
-    } else {
-      return fs.createReadStream('', {
-        autoClose: false,
-        ...options,
-        fd: file.fd,
-      })
-    }
+    return typeof file === 'string'
+      ? fs.createReadStream(this._getFilePath(file), options)
+      : fs.createReadStream('', {
+          autoClose: false,
+          ...options,
+          fd: file.fd,
+        })
   }
 
   async _createOutputStream (file, options) {
@@ -97,13 +95,12 @@ export default class LocalHandler extends RemoteHandlerAbstract {
       const path = this._getFilePath(file)
       await fs.ensureDir(dirname(path))
       return fs.createWriteStream(path, options)
-    } else {
-      return fs.createWriteStream('', {
-        autoClose: false,
-        ...options,
-        fd: file.fd,
-      })
     }
+    return fs.createWriteStream('', {
+      autoClose: false,
+      ...options,
+      fd: file.fd,
+    })
   }
 
   async _unlink (file) {

@xen-orchestra/fs/src/nfs.js

@@ -52,12 +52,13 @@ export default class NfsHandler extends LocalHandler {
 
   async _mount () {
     await fs.ensureDir(this._getRealPath())
+    const { host, path, port } = this._remote
     return execa('mount', [
       '-t',
       'nfs',
       '-o',
       'vers=3',
-      `${this._remote.host}:${this._remote.path}`,
+      `${host}${port !== undefined ? ':' + port : ''}:${path}`,
       this._getRealPath(),
     ])
   }

@xen-orchestra/fs/src/smb.js

@@ -1,4 +1,4 @@
-import Smb2 from '@marsaud/smb2-promise'
+import Smb2 from '@marsaud/smb2'
 import { lastly as pFinally } from 'promise-toolbox'
 
 import RemoteHandlerAbstract from './abstract'
@@ -12,13 +12,13 @@ const normalizeError = error => {
   return code === 'STATUS_OBJECT_NAME_NOT_FOUND' ||
     code === 'STATUS_OBJECT_PATH_NOT_FOUND'
     ? Object.create(error, {
-      code: {
-        configurable: true,
-        readable: true,
-        value: 'ENOENT',
-        writable: true,
-      },
-    })
+        code: {
+          configurable: true,
+          readable: true,
+          value: 'ENOENT',
+          writable: true,
+        },
+      })
     : error
 }
 
@@ -32,7 +32,9 @@ export default class SmbHandler extends RemoteHandlerAbstract {
     return 'smb'
   }
 
-  _getClient (remote) {
+  _getClient () {
+    const remote = this._remote
+
     return new Smb2({
       share: `\\\\${remote.host}`,
       domain: remote.domain,
@@ -81,7 +83,7 @@ export default class SmbHandler extends RemoteHandlerAbstract {
   }
 
   async _outputFile (file, data, options = {}) {
-    const client = this._getClient(this._remote)
+    const client = this._getClient()
     const path = this._getFilePath(file)
     const dir = this._dirname(path)
 
@@ -90,19 +92,40 @@ export default class SmbHandler extends RemoteHandlerAbstract {
     }
 
     return client.writeFile(path, data, options)::pFinally(() => {
-      client.close()
+      client.disconnect()
     })
   }
 
+  async _read (file, buffer, position) {
+    const needsClose = typeof file === 'string'
+
+    let client
+    if (needsClose) {
+      client = this._getClient()
+      file = await client.open(this._getFilePath(file))
+    } else {
+      ;({ client, file } = file.fd)
+    }
+
+    try {
+      return await client.read(file, buffer, 0, buffer.length, position)
+    } finally {
+      if (needsClose) {
+        await client.close(file)
+        client.disconnect()
+      }
+    }
+  }
+
   async _readFile (file, options = {}) {
-    const client = this._getClient(this._remote)
+    const client = this._getClient()
     let content
 
     try {
       content = await client
         .readFile(this._getFilePath(file), options)
         ::pFinally(() => {
-          client.close()
+          client.disconnect()
         })
     } catch (error) {
       throw normalizeError(error)
@@ -112,13 +135,15 @@ export default class SmbHandler extends RemoteHandlerAbstract {
   }
 
   async _rename (oldPath, newPath) {
-    const client = this._getClient(this._remote)
+    const client = this._getClient()
 
     try {
       await client
-        .rename(this._getFilePath(oldPath), this._getFilePath(newPath))
+        .rename(this._getFilePath(oldPath), this._getFilePath(newPath), {
+          replace: true,
+        })
         ::pFinally(() => {
-          client.close()
+          client.disconnect()
         })
     } catch (error) {
       throw normalizeError(error)
@@ -126,12 +151,12 @@ export default class SmbHandler extends RemoteHandlerAbstract {
   }
 
   async _list (dir = '.') {
-    const client = this._getClient(this._remote)
+    const client = this._getClient()
     let list
 
     try {
       list = await client.readdir(this._getFilePath(dir))::pFinally(() => {
-        client.close()
+        client.disconnect()
       })
     } catch (error) {
       throw normalizeError(error)
@@ -144,13 +169,13 @@ export default class SmbHandler extends RemoteHandlerAbstract {
     if (typeof file !== 'string') {
       file = file.path
     }
-    const client = this._getClient(this._remote)
+    const client = this._getClient()
     let stream
 
     try {
       // FIXME ensure that options are properly handled by @marsaud/smb2
       stream = await client.createReadStream(this._getFilePath(file), options)
-      stream.on('end', () => client.close())
+      stream.on('end', () => client.disconnect())
     } catch (error) {
       throw normalizeError(error)
     }
@@ -162,7 +187,7 @@ export default class SmbHandler extends RemoteHandlerAbstract {
     if (typeof file !== 'string') {
       file = file.path
     }
-    const client = this._getClient(this._remote)
+    const client = this._getClient()
     const path = this._getFilePath(file)
     const dir = this._dirname(path)
     let stream
@@ -172,19 +197,19 @@ export default class SmbHandler extends RemoteHandlerAbstract {
       }
       stream = await client.createWriteStream(path, options) // FIXME ensure that options are properly handled by @marsaud/smb2
     } catch (err) {
-      client.close()
+      client.disconnect()
       throw err
     }
-    stream.on('finish', () => client.close())
+    stream.on('finish', () => client.disconnect())
     return stream
   }
 
   async _unlink (file) {
-    const client = this._getClient(this._remote)
+    const client = this._getClient()
 
     try {
       await client.unlink(this._getFilePath(file))::pFinally(() => {
-        client.close()
+        client.disconnect()
       })
     } catch (error) {
       throw normalizeError(error)
@@ -192,14 +217,14 @@ export default class SmbHandler extends RemoteHandlerAbstract {
   }
 
   async _getSize (file) {
-    const client = await this._getClient(this._remote)
+    const client = await this._getClient()
     let size
 
     try {
       size = await client
         .getSize(this._getFilePath(typeof file === 'string' ? file : file.path))
         ::pFinally(() => {
-          client.close()
+          client.disconnect()
         })
     } catch (error) {
       throw normalizeError(error)
@@ -208,10 +233,17 @@ export default class SmbHandler extends RemoteHandlerAbstract {
     return size
   }
 
-  // this is a fake
+  // TODO: add flags
   async _openFile (path) {
-    return this._getFilePath(path)
+    const client = this._getClient()
+    return {
+      client,
+      file: await client.open(this._getFilePath(path)),
+    }
   }
 
-  async _closeFile (fd) {}
+  async _closeFile ({ client, file }) {
+    await client.close(file)
+    client.disconnect()
+  }
 }

CHANGELOG.md

@@ -4,6 +4,117 @@
 
 ### Enhancements
 
+### Bug fixes
+
+### Released packages
+
+- xo-server v5.25.0
+- xo-web v5.25.0
+
+## **5.24.0** (2018-08-09)
+
+### Enhancements
+
+- [Remotes] Make SMB subfolder field optional [#3249](https://github.com/vatesfr/xen-orchestra/issues/3249) (PR [#3250](https://github.com/vatesfr/xen-orchestra/pull/3250))
+- [Backup NG form] Make the smart mode's toggle more visible [#2711](https://github.com/vatesfr/xen-orchestra/issues/2711) (PR [#3263](https://github.com/vatesfr/xen-orchestra/pull/3263))
+- Move the copy clipboard of the VM's UUID to the header [#3221](https://github.com/vatesfr/xen-orchestra/issues/3221) (PR [#3248](https://github.com/vatesfr/xen-orchestra/pull/3248))
+- [Health / Orphaned VMs] Homogenize action buttons in table and enable bulk deletion [#3179](https://github.com/vatesfr/xen-orchestra/issues/3179) (PR [#3274](https://github.com/vatesfr/xen-orchestra/pull/3274))
+- [Health / Orphaned snapshot VDIs] Homogenize action buttons in table and enable bulk deletion [#3179](https://github.com/vatesfr/xen-orchestra/issues/3179) (PR [#3270](https://github.com/vatesfr/xen-orchestra/pull/3270))
+- [Health / Alarms] Homogenize action buttons in table and enable bulk deletion [#3179](https://github.com/vatesfr/xen-orchestra/issues/3179) (PR [#3271](https://github.com/vatesfr/xen-orchestra/pull/3271))
+- [Backup NG Overview] List the Backup NG job's modes [#3169](https://github.com/vatesfr/xen-orchestra/issues/3169) (PR [#3277](https://github.com/vatesfr/xen-orchestra/pull/3277))
+- [Backup NG form] Move "Use compression" checkbox in the advanced settings [#2711](https://github.com/vatesfr/xen-orchestra/issues/2711) (PR [#3281](https://github.com/vatesfr/xen-orchestra/pull/3281))
+- [Backup NG form] Ability to remove previous backups first before backup the VMs [#3212](https://github.com/vatesfr/xen-orchestra/issues/3212) (PR [#3260](https://github.com/vatesfr/xen-orchestra/pull/3260))
+- [Backup reports] Send report for the interrupted backup jobs on the server startup [#2998](https://github.com/vatesfr/xen-orchestra/issues/#2998) (PR [3164](https://github.com/vatesfr/xen-orchestra/pull/3164) [3154](https://github.com/vatesfr/xen-orchestra/pull/3154))
+- [Patching] Check date consistency before patching to avoid error on install [#3056](https://github.com/vatesfr/xen-orchestra/issues/3056)
+
+### Bug fixes
+
+- [Pools] Filter GPU groups by pool [#3176](https://github.com/vatesfr/xen-orchestra/issues/3176) (PR [#3253](https://github.com/vatesfr/xen-orchestra/pull/3253))
+- [Backup NG] Fix delta backups with SMB remotes [#3224](https://github.com/vatesfr/xen-orchestra/issues/3224) (PR [#3278](https://github.com/vatesfr/xen-orchestra/pull/3278))
+- Fix VM restoration getting stuck on local SRs [#3245](https://github.com/vatesfr/xen-orchestra/issues/3245) (PR [#3243](https://github.com/vatesfr/xen-orchestra/pull/3243))
+
+### Released packages
+
+- xen-api v0.17.0
+- @xen-orchestra/fs 0.2.1
+- xo-server v5.24.0
+- xo-web v5.24.0
+
+## **5.23.0** (2018-07-26)
+
+### Enhancements
+
+- Export VDI content [#2432](https://github.com/vatesfr/xen-orchestra/issues/2432) (PR [#3194](https://github.com/vatesfr/xen-orchestra/pull/3194))
+- Search syntax support wildcard (`*`) and regular expressions [#3190](https://github.com/vatesfr/xen-orchestra/issues/3190) (PRs [#3198](https://github.com/vatesfr/xen-orchestra/pull/3198) & [#3199](https://github.com/vatesfr/xen-orchestra/pull/3199))
+- Import VDI content [#2432](https://github.com/vatesfr/xen-orchestra/issues/2432) (PR [#3216](https://github.com/vatesfr/xen-orchestra/pull/3216))
+- [Backup NG form] Ability to edit a schedule's name [#2711](https://github.com/vatesfr/xen-orchestra/issues/2711) [#3071](https://github.com/vatesfr/xen-orchestra/issues/3071) (PR [#3143](https://github.com/vatesfr/xen-orchestra/pull/3143))
+- [Remotes] Ability to change the type of a remote [#2423](https://github.com/vatesfr/xen-orchestra/issues/2423) (PR [#3207](https://github.com/vatesfr/xen-orchestra/pull/3207))
+- [Backup NG new] Ability to set a job's timeout [#2978](https://github.com/vatesfr/xen-orchestra/issues/2978) (PR [#3222](https://github.com/vatesfr/xen-orchestra/pull/3222))
+- [Remotes] Ability to edit/delete a remote with an invalid URL [#3182](https://github.com/vatesfr/xen-orchestra/issues/3182) (PR [#3226](https://github.com/vatesfr/xen-orchestra/pull/3226))
+- [Backup NG logs] Prevent user from deleting logs to help resolving issues [#3153](https://github.com/vatesfr/xen-orchestra/issues/3153) (PR [#3235](https://github.com/vatesfr/xen-orchestra/pull/3235))
+
+### Bug fixes
+
+- [Backup Reports] Report not sent if reportWhen failure and at least a VM is successfull [#3181](https://github.com/vatesfr/xen-orchestra/issues/3181) (PR [#3185](https://github.com/vatesfr/xen-orchestra/pull/3185))
+- [Backup NG] Correctly migrate report setting from legacy jobs [#3180](https://github.com/vatesfr/xen-orchestra/issues/3180) (PR [#3206](https://github.com/vatesfr/xen-orchestra/pull/3206))
+- [Backup NG] remove incomplete XVA files [#3159](https://github.com/vatesfr/xen-orchestra/issues/3159) (PR [#3215](https://github.com/vatesfr/xen-orchestra/pull/3215))
+- [Backup NG form] Ability to edit a schedule's state [#3223](https://github.com/vatesfr/xen-orchestra/issues/3223) (PR [#3228](https://github.com/vatesfr/xen-orchestra/pull/3228))
+
+### Released packages
+
+- xo-remote-parser v0.5.0
+- complex-matcher v0.4.0
+- xo-server-backup-reports v0.13.0
+- xo-server v5.23.0
+- xo-web v5.23.0
+
+## **5.22.1** (2018-07-13)
+
+### Bug fixes
+
+- [Remote select] Gracefully ignore remotes with invalid URL (PR [#3178](https://github.com/vatesfr/xen-orchestra/pull/3178))
+
+### Released packages
+
+- xo-web v5.22.1
+
+## **5.22.0** (2018-07-12)
+
+### Enhancements
+
+- [Backup NG form] Add a link to the remotes' settings [#2711](https://github.com/vatesfr/xen-orchestra/issues/2711) [#3106](https://github.com/vatesfr/xen-orchestra/issues/3106) [#2299](https://github.com/vatesfr/xen-orchestra/issues/2299) (PR [#3128](https://github.com/vatesfr/xen-orchestra/pull/3128))
+- [Backup NG logs] Make copy to clipboard and report buttons always available [#3130](https://github.com/vatesfr/xen-orchestra/issues/3130) (PR [#3133](https://github.com/vatesfr/xen-orchestra/pull/3133))
+- Warning message when creating a local remote [#3105](https://github.com/vatesfr/xen-orchestra/issues/3105) (PR [3142](https://github.com/vatesfr/xen-orchestra/pull/3142))
+- [Remotes] Allow optional port for NFS remote [2299](https://github.com/vatesfr/xen-orchestra/issues/2299) (PR [#3131](https://github.com/vatesfr/xen-orchestra/pull/3131))
+- [Backup NG form] Add offline snapshot info (PR [#3144](https://github.com/vatesfr/xen-orchestra/pull/3144))
+- [Backup NG overview] Display concurrency and offline snapshot value [3087](https://github.com/vatesfr/xen-orchestra/issues/3087) (PR [3145](https://github.com/vatesfr/xen-orchestra/pull/3145))
+- [VM revert] notify the result of reverting a VM [3095](https://github.com/vatesfr/xen-orchestra/issues/3095) (PR [3150](https://github.com/vatesfr/xen-orchestra/pull/3150))
+- [Backup NG logs] Link XO items in the details modal [#2711](https://github.com/vatesfr/xen-orchestra/issues/2711) (PR [#3171](https://github.com/vatesfr/xen-orchestra/pull/3171))
+- [VM/Snapshots] Add fast clone option when creating a VM [#3120](https://github.com/vatesfr/xen-orchestra/issues/3120) (PR [#3136](https://github.com/vatesfr/xen-orchestra/pull/3136))
+- Add the Turkish translation (PR [#3174](https://github.com/vatesfr/xen-orchestra/pull/3174) [#2870](https://github.com/vatesfr/xen-orchestra/pull/2870) [#2871](https://github.com/vatesfr/xen-orchestra/pull/2871))
+
+### Bug fixes
+
+- Delete schedules with their job [#3108](https://github.com/vatesfr/xen-orchestra/issues/3108) (PR [3124](https://github.com/vatesfr/xen-orchestra/pull/3124))
+- Remote creation: correctly reset form [#3140](https://github.com/vatesfr/xen-orchestra/issues/3140) (PR [3141](https://github.com/vatesfr/xen-orchestra/pull/3141))
+- Make cloud config templates available for all users [3147](https://github.com/vatesfr/xen-orchestra/issues/3147) (PR [3148](https://github.com/vatesfr/xen-orchestra/pull/3148))
+- [New VM] Only create the cloud config drive when its option is enabled [3161](https://github.com/vatesfr/xen-orchestra/issues/3161) (PR [3162](https://github.com/vatesfr/xen-orchestra/pull/3162))
+- Fix error when installing patches from the host or without a default SR (PR [3166](https://github.com/vatesfr/xen-orchestra/pull/3166))
+- [Backup NG] Fix SMB *Not implemented* issue [#3149](](https://github.com/vatesfr/xen-orchestra/issues/3149) (PR [3175](https://github.com/vatesfr/xen-orchestra/pull/3175))
+
+### Released packages
+
+- xo-remote-parser 0.4.0
+- @xen-orchestra/fs 0.2.0
+- vhd-lib 0.3.0
+- vhd-cli 0.1.0
+- xo-server v5.22.0
+- xo-web v5.22.0
+
+## **5.21.0** (2018-06-28)
+
+### Enhancements
+
 - Hide legacy backup creation view [#2956](https://github.com/vatesfr/xen-orchestra/issues/2956)
 - [Delta Backup NG logs] Display wether the export is a full or a delta [#2711](https://github.com/vatesfr/xen-orchestra/issues/2711)
 - Copy VDIs' UUID from SR/disks view [#3051](https://github.com/vatesfr/xen-orchestra/issues/3051)
@@ -11,14 +122,29 @@
 - [Backup NG form] Improve feedback [#2711](https://github.com/vatesfr/xen-orchestra/issues/2711)
 - [Backup NG] Different retentions for backup and replication [#2895](https://github.com/vatesfr/xen-orchestra/issues/2895)
 - Possibility to use a fast clone when creating a VM from a snapshot [#2937](https://github.com/vatesfr/xen-orchestra/issues/2937)
+- Ability to customize cloud config templates [#2984](https://github.com/vatesfr/xen-orchestra/issues/2984)
+- Add Backup deprecation message and link to Backup NG migration blog post [#3089](https://github.com/vatesfr/xen-orchestra/issues/3089)
+- [Backup NG] Ability to cancel a running backup job [#3047](https://github.com/vatesfr/xen-orchestra/issues/3047)
+- [Backup NG form] Ability to enable/disable a schedule [#3062](https://github.com/vatesfr/xen-orchestra/issues/3062)
+- New backup/health view with non-existent backup snapshots table [#3090](https://github.com/vatesfr/xen-orchestra/issues/3090)
+- Disable cancel/destroy tasks when not allowed [#3076](https://github.com/vatesfr/xen-orchestra/issues/3076)
+- Default remote type is NFS [#3103](https://github.com/vatesfr/xen-orchestra/issues/3103) (PR [#3114](https://github.com/vatesfr/xen-orchestra/pull/3114))
+- Add legacy backups snapshots to backup/health [#3082](https://github.com/vatesfr/xen-orchestra/issues/3082) (PR [#3111](https://github.com/vatesfr/xen-orchestra/pull/3111))
+- [Backup NG logs] Add the job's name to the modal's title [#2711](https://github.com/vatesfr/xen-orchestra/issues/2711) (PR [#3115](https://github.com/vatesfr/xen-orchestra/pull/3115))
+- Adding a XCP-ng host to a XS pool now fails fast [#3061](https://github.com/vatesfr/xen-orchestra/issues/3061) (PR [#3118](https://github.com/vatesfr/xen-orchestra/pull/3118))
+- [Backup NG logs] Ability to report a failed job and copy its log to the clipboard [#3100](https://github.com/vatesfr/xen-orchestra/issues/3100) (PR [#3110](https://github.com/vatesfr/xen-orchestra/pull/3110))
 
-### Bugs
+### Bug fixes
 
 - update the xentools search item to return the version number of installed xentools [#3015](https://github.com/vatesfr/xen-orchestra/issues/3015)
 - Fix Nagios backup reports [#2991](https://github.com/vatesfr/xen-orchestra/issues/2991)
 - Fix the retry of a single failed/interrupted VM backup [#2912](https://github.com/vatesfr/xen-orchestra/issues/2912#issuecomment-395480321)
 - New VM with Self: filter out networks that are not in the template's pool [#3011](https://github.com/vatesfr/xen-orchestra/issues/3011)
 - [Backup NG] Auto-detect when a full export is necessary.
+- Fix Load Balancer [#3075](https://github.com/vatesfr/xen-orchestra/issues/3075#event-1685469551) [#3026](https://github.com/vatesfr/xen-orchestra/issues/3026)
+- [SR stats] Don't scale XAPI iowait values [#2969](https://github.com/vatesfr/xen-orchestra/issues/2969)
+- [Backup NG] Don't list unusable SRs for CR/DR [#3050](https://github.com/vatesfr/xen-orchestra/issues/3050)
+- Fix creating VM from snapshot (PR [3117](https://github.com/vatesfr/xen-orchestra/pull/3117))
 
 ## **5.20.0** (2018-05-31)
 

PULL_REQUEST_TEMPLATE.md

@@ -4,7 +4,9 @@
 
 - [ ] PR reference the relevant issue (e.g. `Fixes #007`)
 - [ ] if UI changes, a screenshot has been added to the PR
-- [ ] CHANGELOG updated
+- [ ] CHANGELOG:
+   - enhancement/bug fix entry added
+   - list of packages to release updated (`${name} v${new version}`)
 - [ ] documentation updated
 
 ### Process
@@ -12,8 +14,4 @@
 1. create a PR as soon as possible
 1. mark it as `WiP:` (Work in Progress) if not ready to be merged
 1. when you want a review, add a reviewer
-1. if necessary, update your PR, and readd a reviewer
-
-### List of packages to release
-
-> No need to mention xo-server and xo-web.
+1. if necessary, update your PR, and re- add a reviewer

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)
+       * [Compatibility](supported-version.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)
+  * [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.