From dfb6d1b58e13a26bb18c21df3b20613af4ff6e50 Mon Sep 17 00:00:00 2001
From: Julien Fontanet <julien.fontanet@isonoe.net>
Date: Wed, 30 Jan 2019 15:04:47 +0100
Subject: [PATCH] chore(xo-server/backup NG): document other_config entries

---
 .../xo-server/src/xo-mixins/backups-ng/index.js   | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/packages/xo-server/src/xo-mixins/backups-ng/index.js b/packages/xo-server/src/xo-mixins/backups-ng/index.js
index 0456a9e99..131b4a3c3 100644
--- a/packages/xo-server/src/xo-mixins/backups-ng/index.js
+++ b/packages/xo-server/src/xo-mixins/backups-ng/index.js
@@ -480,13 +480,26 @@ const disableVmHighAvailability = async (xapi: Xapi, vm: Vm) => {
 //      ├─ <YYYYMMDD>T<HHmmss>.xva
 //      └─ <YYYYMMDD>T<HHmmss>.xva.checksum
 //
+// Attributes on created VM snapshots:
+//
+// - `other_config`:
+//    - `xo:backup:datetime` = snapshot.snapshot_time (allow sorting replicated VMs)
+//    - `xo:backup:job` = job.id
+//    - `xo:backup:schedule` = schedule.id
+//    - `xo:backup:vm` = vm.uuid
+//    - `xo:backup:exported` = 'true' (added at the end of the backup)
+//
 // Attributes of created VMs:
 //
-// - name: `${original name} - ${job name} - (${safeDateFormat(backup timestamp)})`
+// - all snapshots attributes (see above)
+// - `name_label`: `${original name} - ${job name} - (${safeDateFormat(backup timestamp)})`
 // - tag:
 //    - copy in delta mode: `Continuous Replication`
 //    - copy in full mode: `Disaster Recovery`
 //    - imported from backup: `restored from backup`
+// - `blocked_operations.start`: message
+// - for copies/replications only, added after complete transfer
+//    - `other_config[xo:backup:sr]` = sr.uuid
 //
 // Task logs emitted in a backup execution:
 //