Skip to content

Commit 8ad7425

Browse files
committed
docs: add optional StorageClass parameters table to README
1 parent ca56e4b commit 8ad7425

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,20 @@ parameters:
222222
fsType: ext4 # or xfs
223223
```
224224
225+
**Optional parameters** (all protocols):
226+
227+
| Parameter | Description |
228+
|-----------|-------------|
229+
| `compression` | Compression algorithm (`lz4`, `zstd`, `none`) |
230+
| `foregroundTarget` | Device group label for foreground writes |
231+
| `backgroundTarget` | Device group label for background moves |
232+
| `promoteTarget` | Device group label for read promotion (cache tier) |
233+
| `metadataTarget` | Device group label for metadata/btree writes |
234+
| `dataReplicas` | Number of data replicas (e.g., `"1"` for expendable data) |
235+
| `deleteStrategy` | `delete` (default) or `retain` |
236+
| `encryption` | `true` to require encrypted filesystem |
237+
| `markAdoptable` | `true` to allow cross-cluster volume adoption |
238+
225239
## Testing
226240

227241
This driver is tested against a **real NASty server** with actual bcachefs storage — not mocks or simulators:

0 commit comments

Comments
 (0)