docs(backups): outline writer API

This commit is contained in:
Julien Fontanet 2022-05-17 14:06:56 +02:00
parent 3c3a1f8981
commit ca5914dbfb

View File

@ -6,6 +6,7 @@
- [Task logs](#task-logs)
- [During backup](#during-backup)
- [During restoration](#during-restoration)
- [Writer API](#writer-api)
## File structure on remote
@ -95,3 +96,15 @@ task.start(message: 'restore', data: { jobId: string, srId: string, time: number
│ └─ task.end(result: { id: string, size: number })
└─ task.end
```
## Writer API
- `beforeBackup()`
- **Delta**
- `checkBaseVdis(baseUuidToSrcVdi, baseVm)`
- `prepare({ isFull })`
- `transfer({ timestamp, deltaExport, sizeContainers })`
- `cleanup()`
- **Full**
- `run({ timestamp, sizeContainer, stream })`
- `afterBackup()`