Skip to content

Commit 1a70904

Browse files
doc: qsfsd documentation
1 parent b19975b commit 1a70904

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

docs/cmds/qsfsd.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Qsfsd
2+
3+
The `QSFS` (Quantum Safe File System) package provides a secure and distributed file system implementation for the ZOS ecosystem while maintaining the standard filesystem interface.
4+
5+
`qsfsd` manages the `qsfs`package
6+
7+
## How it works
8+
9+
- Connects to `Redis` message broker over `zbus`
10+
- Registers itself as the `qsfsd` module to expose its methods through `zbus`
11+
12+
## Usage
13+
14+
```sh
15+
qsfsd --root /var/cache/modules/qsfsd \
16+
--broker unix:///var/run/redis.sock \
17+
--workers 2
18+
```
19+
20+
### Command-line flags
21+
22+
| Flag | Description | Default |
23+
| ----------- | -------------------------------------------| ---------------------------- |
24+
| `--broker` | Connection string to the message BROKER | `unix:///var/run/redis.sock` |
25+
| `--root` | ROOT working directory of the module | `/var/cache/modules/qsfsd` |
26+
| `--workers` | Number of workers N | `1` |

0 commit comments

Comments
 (0)