Changes for README.md: 6 added lines, 0 removed lines.
Original line number
Diff line number
Diff line
@@ -516,6 +516,8 @@ During redistribution, applications must not access the mounted GekkoFS file sys
To build the control tool, configure with `-DGKFS_BUILD_TOOLS=ON`. This builds `gkfs_malleability`. The control tool reads the marker hostfile directly; it does not need separate expand or shrink hostfiles and it does not start daemons. The `scripts/run/gkfs` wrapper uses the same model: prepare one workspace hostfile with `+` and `-` markers, make sure added daemons are already running, then run `scripts/run/gkfs mutate` to call `gkfs_malleability mutate start/status/finalize` and let finalize clean the workspace hostfile.
The clients can be restarted, or the user can sent to them a signal (SIGUSR1) to force a reload of the hostfile.
### Hostfile marker model
Malleability uses one workspace hostfile. Entries in this file are the source of truth:
@@ -829,6 +831,7 @@ Swap/mutate is the combination: mark leaving daemons with `-`, start replacement
| `GKFS_DISTRIBUTION_STRATEGY` | Common placement strategy. Supported values include `simple_hash` and `random_slicing` |
| `GKFS_RANDOM_SLICING_CUTSHIFT` | Set to `ON` to use CutShift for Random Slicing expand-only operations |
| `GKFS_EXPAND_ON_DEMAND` | Set to `ON` to enable v1 expand-only lazy data movement |
| `LIBGKFS_RELOAD_SIGNAL` | set by default to `SIGUSR1`, enables reloading of the hostfile|
## Expand-on-demand malleability
@@ -1111,6 +1114,9 @@ During write/pwrite operations, when the asynchronous write cache is enabled, th
-`LIBGKFS_ASYNC_WRITE=ON` - Enable client-side asynchronous write caching for data writes (default: OFF).
##### Malleability
-`LIBGKFS_RELOAD_SIGNAL` - default SIGUSR1, Signal to reload hostfile at the end of a malleability operation.
### Daemon
#### Core
-`GKFS_DAEMON_CREATE_EXIST_CHECK` - Check for existence of file metadata before create in RocksDB.
