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
Copy file name to clipboardExpand all lines: api.md
+68-4Lines changed: 68 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1361,8 +1361,14 @@ Remove a device from a filesystem. The device should be fully evacuated first.
1361
1361
1362
1362
| Field | Type | Required | Description |
1363
1363
|-------|------|:--------:|-------------|
1364
-
|`device`| string | yes | Absolute path of the block device (e.g. `/dev/sdb`). |
1364
+
| `device` | string | yes | The device to act on: an absolute block-device path (e.g. `/dev/sdb`)
1365
+
or, for a missing/dead member with no current path, its numeric
1366
+
bcachefs member index. |
1365
1367
|`filesystem`| string | yes | Name of the filesystem containing the device. |
1368
+
| `force` | boolean | no | Force removal even when data/metadata can't be migrated off first —
1369
+
required for a *missing* member (the disk is gone, nothing to
1370
+
evacuate; safe while enough replicas remain on surviving devices).
1371
+
Ignored by non-remove actions. |
1366
1372
1367
1373
**Returns:**
1368
1374
@@ -1392,8 +1398,14 @@ Evacuate all data from a device to the remaining filesystem members. Long-runnin
1392
1398
1393
1399
| Field | Type | Required | Description |
1394
1400
|-------|------|:--------:|-------------|
1395
-
|`device`| string | yes | Absolute path of the block device (e.g. `/dev/sdb`). |
1401
+
| `device` | string | yes | The device to act on: an absolute block-device path (e.g. `/dev/sdb`)
1402
+
or, for a missing/dead member with no current path, its numeric
1403
+
bcachefs member index. |
1396
1404
|`filesystem`| string | yes | Name of the filesystem containing the device. |
1405
+
| `force` | boolean | no | Force removal even when data/metadata can't be migrated off first —
1406
+
required for a *missing* member (the disk is gone, nothing to
1407
+
evacuate; safe while enough replicas remain on surviving devices).
1408
+
Ignored by non-remove actions. |
1397
1409
1398
1410
1399
1411
### `fs.device.set_state`
@@ -1470,8 +1482,14 @@ Bring a device back online.
1470
1482
1471
1483
| Field | Type | Required | Description |
1472
1484
|-------|------|:--------:|-------------|
1473
-
|`device`| string | yes | Absolute path of the block device (e.g. `/dev/sdb`). |
1485
+
| `device` | string | yes | The device to act on: an absolute block-device path (e.g. `/dev/sdb`)
1486
+
or, for a missing/dead member with no current path, its numeric
1487
+
bcachefs member index. |
1474
1488
|`filesystem`| string | yes | Name of the filesystem containing the device. |
1489
+
| `force` | boolean | no | Force removal even when data/metadata can't be migrated off first —
1490
+
required for a *missing* member (the disk is gone, nothing to
1491
+
evacuate; safe while enough replicas remain on surviving devices).
1492
+
Ignored by non-remove actions. |
1475
1493
1476
1494
**Returns:**
1477
1495
@@ -1501,8 +1519,14 @@ Take a device offline.
1501
1519
1502
1520
| Field | Type | Required | Description |
1503
1521
|-------|------|:--------:|-------------|
1504
-
|`device`| string | yes | Absolute path of the block device (e.g. `/dev/sdb`). |
1522
+
| `device` | string | yes | The device to act on: an absolute block-device path (e.g. `/dev/sdb`)
1523
+
or, for a missing/dead member with no current path, its numeric
1524
+
bcachefs member index. |
1505
1525
|`filesystem`| string | yes | Name of the filesystem containing the device. |
1526
+
| `force` | boolean | no | Force removal even when data/metadata can't be migrated off first —
1527
+
required for a *missing* member (the disk is gone, nothing to
1528
+
evacuate; safe while enough replicas remain on surviving devices).
1529
+
Ignored by non-remove actions. |
1506
1530
1507
1531
**Returns:**
1508
1532
@@ -5680,6 +5704,30 @@ field — that's the comparison we make. |
5680
5704
``VolumeMismatch`[]`
5681
5705
5682
5706
5707
+
### `apps.check_compose`
5708
+
5709
+
Validate a docker-compose YAML the way deploy will: in-process YAML syntax check, then `docker compose config` schema validation, returning per-line diagnostics for the editor to underline.
5710
+
5711
+
**Role:**`any`
5712
+
5713
+
**Params:**
5714
+
5715
+
| Field | Type | Required | Description |
5716
+
|-------|------|:--------:|-------------|
5717
+
|`compose`| string | yes | Full docker-compose YAML text, as it sits in the editor. |
5718
+
5719
+
**Returns:**
5720
+
5721
+
| Field | Type | Required | Description |
5722
+
|-------|------|:--------:|-------------|
5723
+
|`diagnostics`|`ComposeDiagnostic`[]| yes ||
5724
+
| `schema_checked` | boolean | yes | False when schema validation couldn't run (docker compose not
5725
+
on PATH — apps disabled, or a stripped-down box). YAML syntax is
5726
+
still checked in-process; the UI shouldn't claim "fully valid"
5727
+
when this is false. |
5728
+
|`valid`| boolean | yes ||
5729
+
5730
+
5683
5731
### `apps.enable`
5684
5732
5685
5733
Enable the apps runtime on this box (optionally pinning the storage filesystem) and start Docker.
@@ -6526,6 +6574,10 @@ at runtime that rustic_backend reads via its `cacert` option. |
0 commit comments