mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-07 13:53:12 +00:00
guojidan
cf863ba059
* feat(lock): Add support for disabling lock manager Implement control of lock system activation and deactivation via environment variables Add DisabledLockManager for lock-free operation scenarios Introduce LockManager trait to uniformly manage different lock managers Signed-off-by: junxiang Mu <1948535941@qq.com> * refactor(lock): Optimize implementation of global lock manager and parsing of boolean environment variables Refactor the implementation of the global lock manager: wrap FastObjectLockManager with Arc and add the as_fast_lock_manager method Extract the boolean environment variable parsing logic into an independent function parse_bool_env_var Signed-off-by: junxiang Mu <1948535941@qq.com> --------- Signed-off-by: junxiang Mu <1948535941@qq.com>
118 lines
3.6 KiB
Markdown
118 lines
3.6 KiB
Markdown
# RustFS Environment Variables
|
|
|
|
This document describes the environment variables that can be used to configure RustFS behavior.
|
|
|
|
## Background Services Control
|
|
|
|
### RUSTFS_ENABLE_SCANNER
|
|
|
|
Controls whether the data scanner service should be started.
|
|
|
|
- **Default**: `true`
|
|
- **Valid values**: `true`, `false`
|
|
- **Description**: When enabled, the data scanner will run background scans to detect inconsistencies and corruption in stored data.
|
|
|
|
**Examples**:
|
|
```bash
|
|
# Disable scanner
|
|
export RUSTFS_ENABLE_SCANNER=false
|
|
|
|
# Enable scanner (default behavior)
|
|
export RUSTFS_ENABLE_SCANNER=true
|
|
```
|
|
|
|
### RUSTFS_ENABLE_HEAL
|
|
|
|
Controls whether the auto-heal service should be started.
|
|
|
|
- **Default**: `true`
|
|
- **Valid values**: `true`, `false`
|
|
- **Description**: When enabled, the heal manager will automatically repair detected data inconsistencies and corruption.
|
|
|
|
**Examples**:
|
|
```bash
|
|
# Disable auto-heal
|
|
export RUSTFS_ENABLE_HEAL=false
|
|
|
|
# Enable auto-heal (default behavior)
|
|
export RUSTFS_ENABLE_HEAL=true
|
|
```
|
|
|
|
### RUSTFS_ENABLE_LOCKS
|
|
|
|
Controls whether the distributed lock system should be enabled.
|
|
|
|
- **Default**: `true`
|
|
- **Valid values**: `true`, `false`, `1`, `0`, `yes`, `no`, `on`, `off`, `enabled`, `disabled` (case insensitive)
|
|
- **Description**: When enabled, provides distributed locking for concurrent object operations. When disabled, all lock operations immediately return success without actual locking.
|
|
|
|
**Examples**:
|
|
```bash
|
|
# Disable lock system
|
|
export RUSTFS_ENABLE_LOCKS=false
|
|
|
|
# Enable lock system (default behavior)
|
|
export RUSTFS_ENABLE_LOCKS=true
|
|
```
|
|
|
|
## Service Combinations
|
|
|
|
The scanner and heal services can be independently controlled:
|
|
|
|
| RUSTFS_ENABLE_SCANNER | RUSTFS_ENABLE_HEAL | Result |
|
|
|----------------------|-------------------|--------|
|
|
| `true` (default) | `true` (default) | Both scanner and heal are active |
|
|
| `true` | `false` | Scanner runs without heal capabilities |
|
|
| `false` | `true` | Heal manager is available but no scanning |
|
|
| `false` | `false` | No background maintenance services |
|
|
|
|
## Use Cases
|
|
|
|
### Development Environment
|
|
For development or testing environments where you don't need background maintenance:
|
|
```bash
|
|
export RUSTFS_ENABLE_SCANNER=false
|
|
export RUSTFS_ENABLE_HEAL=false
|
|
./rustfs --address 127.0.0.1:9000 ...
|
|
```
|
|
|
|
### Scan-Only Mode
|
|
For environments where you want to detect issues but not automatically fix them:
|
|
```bash
|
|
export RUSTFS_ENABLE_SCANNER=true
|
|
export RUSTFS_ENABLE_HEAL=false
|
|
./rustfs --address 127.0.0.1:9000 ...
|
|
```
|
|
|
|
### Heal-Only Mode
|
|
For environments where external tools trigger healing but no automatic scanning:
|
|
```bash
|
|
export RUSTFS_ENABLE_SCANNER=false
|
|
export RUSTFS_ENABLE_HEAL=true
|
|
./rustfs --address 127.0.0.1:9000 ...
|
|
```
|
|
|
|
### Production Environment (Default)
|
|
For production environments where both services should be active:
|
|
```bash
|
|
# These are the defaults, so no need to set explicitly
|
|
# export RUSTFS_ENABLE_SCANNER=true
|
|
# export RUSTFS_ENABLE_HEAL=true
|
|
./rustfs --address 127.0.0.1:9000 ...
|
|
```
|
|
|
|
### No-Lock Development
|
|
For single-node development where locking is not needed:
|
|
```bash
|
|
export RUSTFS_ENABLE_LOCKS=false
|
|
./rustfs --address 127.0.0.1:9000 ...
|
|
```
|
|
|
|
## Performance Impact
|
|
|
|
- **Scanner**: Light to moderate CPU/IO impact during scans
|
|
- **Heal**: Moderate to high CPU/IO impact during healing operations
|
|
- **Locks**: Minimal CPU/memory overhead for coordination; disabling can improve throughput in single-client scenarios
|
|
- **Memory**: Each service uses additional memory for processing queues and metadata
|
|
|
|
Disabling these services in resource-constrained environments can improve performance for primary storage operations. |