You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add documentation for the live snapshot feature including:
- serviceConfig configuration options
- Device ID format and usage
- HTTP API endpoint (/snapshot)
- New config format requirements
- Usage examples and notes
Signed-off-by: Yifan Yuan <tuji.yyf@alibaba-inc.com>
Copy file name to clipboardExpand all lines: README.md
+69-1Lines changed: 69 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -169,7 +169,11 @@ Default configure file `overlaybd.json` is installed to `/etc/overlaybd/`.
169
169
"updateInterval": 60000000
170
170
},
171
171
"enableAudit": true,
172
-
"auditPath": "/var/log/overlaybd-audit.log"
172
+
"auditPath": "/var/log/overlaybd-audit.log",
173
+
"serviceConfig": {
174
+
"enable": false,
175
+
"address": "http://127.0.0.1:9862"
176
+
}
173
177
}
174
178
```
175
179
@@ -210,6 +214,8 @@ Default configure file `overlaybd.json` is installed to `/etc/overlaybd/`.
210
214
| certConfig.certFile | The path for SSL/TLS client certificate file |
211
215
| certConfig.keyFile | The path for SSL/TLS client key file |
212
216
| userAgent | customized userAgent to identify HTTP request. default value is package version like 'overlaybd/1.1.14-6c449832' |
217
+
| serviceConfig.enable | Enable live snapshot API service, `false` is default. |
218
+
| serviceConfig.address | API service listening address, default `http://127.0.0.1:9862`. |
213
219
214
220
215
221
> NOTE: `download` is the config for background downloading. After an overlaybd device is lauched, a background task will be running to fetch the whole blobs into local directories. After downloading, I/O requests are directed to local files. Unlike other options, download config is reloaded when a device launching.
@@ -381,6 +387,68 @@ At last, compression may be needed.
381
387
```
382
388
The zfile can be used as lower layer with online decompression.
383
389
390
+
### Live Snapshot
391
+
392
+
Overlaybd supports creating live snapshots without stopping the device. This feature allows you to capture the current state of a writable layer and stack a new writable layer on top.
393
+
394
+
#### Device ID
395
+
396
+
To use the live snapshot feature, you need to specify a device ID when creating the overlaybd device. The device ID is appended to the config path with a semicolon separator:
0 commit comments