Commit 724f7540 authored by Marc Vef's avatar Marc Vef
Browse files

Updating daemon help and documentation

parent 2a28c444
Loading
Loading
Loading
Loading
+6 −9
Original line number Diff line number Diff line
@@ -103,15 +103,12 @@ Options:
                              Available: {ofi+sockets, ofi+verbs, ofi+psm2} for TCP, Infiniband, and Omni-Path, respectively. (Default ofi+sockets)
                              Libfabric must have enabled support verbs or psm2.
  --auto-sm                   Enables intra-node communication (IPCs) via the `na+sm` (shared memory) protocol, instead of using the RPC protocol. (Default off)
  -c,--clean-rootdir          Cleans Rootdir >before< launching the deamon
  -f, --clean-rootdir-finish Cleans Rootdir >After< the deamon finishes
  --version                   Print version and exit.

  --dbbackend               'rocksdb' (default) or 'parallaxdb' can be specified as
                            metadata backend, in that case a file in 'metadir' named
                            rocksdbx is created. Parallaxdb support is experimental.
  --parallax_size               'parallaxdb' specific, size of the metadata file in GB. Minimal is 8 GB
                            (default 8, 8 GB)
  --clean-rootdir             Cleans Rootdir >before< launching the deamon
  -c,--clean-rootdir-finish   Cleans Rootdir >after< the deamon finishes
  -d,--dbbackend TEXT         Metadata database backend to use. Available: {rocksdb, parallaxdb}
                              RocksDB is default if not set. Parallax support is experimental.
                              Note, parallaxdb creates a file called rocksdbx with 8GB created in metadir.
  --parallaxsize TEXT         parallaxdb - metadata file size in GB (default 8GB), used only with new files
  --version                   Print version and exit.
```

+23 −24
Original line number Diff line number Diff line
@@ -73,13 +73,12 @@ Further options are available
                              Available: {ofi+sockets, ofi+verbs, ofi+psm2} for TCP, Infiniband, and Omni-Path, respectively. (Default ofi+sockets)
                              Libfabric must have enabled support verbs or psm2.
  --auto-sm                   Enables intra-node communication (IPCs) via the `na+sm` (shared memory) protocol, instead of using the RPC protocol. (Default off)
   -c,--clean-rootdir          Cleans Rootdir >before< launching the deamon
   -f,--clean-rootdir-finish   Cleans Rootdir >after< finishing the deamon
    --dbbackend               'rocksdb' (default) or 'parallaxdb' can be specified as
                                metadata backend, in that case a file in 'metadir' named
                                rocksdbx is created. Parallaxdb support is experimental.
    --parallax_size               'parallaxdb' specific, size of the metadata file in GB. Minimal is 8 GB
                              (default 8, 8 GB)
  --clean-rootdir             Cleans Rootdir >before< launching the deamon
  -c,--clean-rootdir-finish   Cleans Rootdir >after< the deamon finishes
  -d,--dbbackend TEXT         Metadata database backend to use. Available: {rocksdb, parallaxdb}
                              RocksDB is default if not set. Parallax support is experimental.
                              Note, parallaxdb creates a file called rocksdbx with 8GB created in metadir.
  --parallaxsize TEXT         parallaxdb - metadata file size in GB (default 8GB), used only with new files
  --version                   Print version and exit.
````

+2 −2
Original line number Diff line number Diff line
@@ -677,7 +677,7 @@ main(int argc, const char* argv[]) {
                    "Creates an additional directory within the rootdir, allowing multiple daemons on one node.");
    desc.add_option(
                    "--metadir,-i", opts.metadir,
                    "Metadata directory where GekkoFS' RocksDB data directory is located. If not set, rootdir is used.");
                    "Metadata directory where GekkoFS RocksDB data directory is located. If not set, rootdir is used.");
    desc.add_option(
                    "--listen,-l", opts.listen,
                    "Address or interface to bind the daemon to. Default: local hostname.\n"
@@ -705,7 +705,7 @@ main(int argc, const char* argv[]) {
                "Cleans Rootdir >after< the deamon finishes");
    desc.add_option(
                "--dbbackend,-d", opts.dbbackend,
                "Metadata database backend to use. Available: {rocksdb, parallaxdb}'\n"
                "Metadata database backend to use. Available: {rocksdb, parallaxdb}\n"
                "RocksDB is default if not set. Parallax support is experimental.\n"
                "Note, parallaxdb creates a file called rocksdbx with 8GB created in metadir.");
    desc.add_option("--parallaxsize", opts.parallax_size,