Skip to content

Xtreemfs

services.xtreemfs.dir.address

If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any).

Type: string

Default

""

Example

"127.0.0.1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.dir.enable

Whether to enable XtreemFS DIR service.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.dir.extraConfig

Configuration of XtreemFS DIR service. WARNING: configuration is saved as plaintext inside nix store. For more options: https://www.xtreemfs.org/xtfs-guide-1.5.1/index.html

Type: strings concatenated with "\n"

Default

""

Example

'' # specify whether SSL is required ssl.enabled = true ssl.service_creds.pw = passphrase ssl.service_creds.container = pkcs12 ssl.service_creds = /etc/xos/xtreemfs/truststore/certs/dir.p12 ssl.trusted_certs = /etc/xos/xtreemfs/truststore/certs/trusted.jks ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.dir.httpPort

Specifies the listen port for the HTTP service that returns the status page.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

30638

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.dir.port

The port to listen on for incoming connections (TCP).

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

32638

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.dir.replication.enable

Whether to enable XtreemFS DIR replication plugin. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.dir.replication.extraConfig

Configuration of XtreemFS DIR replication plugin. WARNING: configuration is saved as plaintext inside nix store. For more options: https://www.xtreemfs.org/xtfs-guide-1.5.1/index.html

Type: strings concatenated with "\n"

Example

`#!nix '' # participants of the replication including this replica babudb.repl.participant.0 = 192.168.0.10 babudb.repl.participant.0.port = 35676 babudb.repl.participant.1 = 192.168.0.11 babudb.repl.participant.1.port = 35676 babudb.repl.participant.2 = 192.168.0.12 babudb.repl.participant.2.port = 35676

# number of servers that at least have to be up to date # To have a fault-tolerant system, this value has to be set to the # majority of nodes i.e., if you have three replicas, set this to 2 # Please note that a setup with two nodes provides no fault-tolerance. babudb.repl.sync.n = 2

# specify whether SSL is required babudb.ssl.enabled = true

babudb.ssl.protocol = tlsv12

# server credentials for SSL handshakes babudb.ssl.service_creds = /etc/xos/xtreemfs/truststore/certs/osd.p12 babudb.ssl.service_creds.pw = passphrase babudb.ssl.service_creds.container = pkcs12

# trusted certificates for SSL handshakes babudb.ssl.trusted_certs = /etc/xos/xtreemfs/truststore/certs/trusted.jks babudb.ssl.trusted_certs.pw = jks_passphrase babudb.ssl.trusted_certs.container = jks

babudb.ssl.authenticationWithoutEncryption = false ''`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.dir.syncMode

The sync mode influences how operations are committed to the disk log before the operation is acknowledged to the caller.

-ASYNC mode the writes to the disk log are buffered in memory by the operating system. This is the fastest mode but will lead to data loss in case of a crash, kernel panic or power failure. -SYNC_WRITE_METADATA opens the file with O_SYNC, the system will not buffer any writes. The operation will be acknowledged when data has been safely written to disk. This mode is slow but offers maximum data safety. However, BabuDB cannot influence the disk drive caches, this depends on the OS and hard disk model. -SYNC_WRITE similar to SYNC_WRITE_METADATA but opens file with O_DSYNC which means that only the data is commit to disk. This can lead to some data loss depending on the implementation of the underlying file system. Linux does not implement this mode. -FDATASYNC is similar to SYNC_WRITE but opens the file in asynchronous mode and calls fdatasync() after writing the data to disk. -FSYNC is similar to SYNC_WRITE_METADATA but opens the file in asynchronous mode and calls fsync() after writing the data to disk.

For best throughput use ASYNC, for maximum data safety use FSYNC.

(If xtreemfs.dir.replication.enable is true then FDATASYNC is forced)

Type: one of "ASYNC", "SYNC_WRITE_METADATA", "SYNC_WRITE", "FDATASYNC", "FSYNC"

Default

"FSYNC"

Example

"FDATASYNC"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.dir.uuid

Must be set to a unique identifier, preferably a UUID according to RFC 4122. UUIDs can be generated with uuidgen command, found in the util-linux package.

Type: string

Example

"eacb6bab-f444-4ebf-a06a-3f72d7465e40"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.enable

Whether to enable XtreemFS. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.homeDir

XtreemFS home dir for the xtreemfs user.

Type: path

Default

"/var/lib/xtreemfs"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.address

If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any).

Type: string

Default

""

Example

"127.0.0.1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.enable

Whether to enable XtreemFS MRC service.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.extraConfig

Configuration of XtreemFS MRC service. WARNING: configuration is saved as plaintext inside nix store. For more options: https://www.xtreemfs.org/xtfs-guide-1.5.1/index.html

Type: strings concatenated with "\n"

Example

`#!nix '' osd_check_interval = 300 no_atime = true local_clock_renewal = 0 remote_time_sync = 30000 authentication_provider = org.xtreemfs.common.auth.NullAuthProvider

# shared secret between the MRC and all OSDs capability_secret = iNG8UuQJrJ6XVDTe

dir_service.host = 192.168.0.10 dir_service.port = 32638

# if replication is enabled dir_service.1.host = 192.168.0.11 dir_service.1.port = 32638 dir_service.2.host = 192.168.0.12 dir_service.2.port = 32638

# specify whether SSL is required ssl.enabled = true ssl.protocol = tlsv12 ssl.service_creds.pw = passphrase ssl.service_creds.container = pkcs12 ssl.service_creds = /etc/xos/xtreemfs/truststore/certs/mrc.p12 ssl.trusted_certs = /etc/xos/xtreemfs/truststore/certs/trusted.jks ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks ''`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.httpPort

Specifies the listen port for the HTTP service that returns the status page.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

30636

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.port

The port to listen on for incoming connections (TCP).

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

32636

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.replication.enable

Whether to enable XtreemFS MRC replication plugin. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.replication.extraConfig

Configuration of XtreemFS MRC replication plugin. WARNING: configuration is saved as plaintext inside nix store. For more options: https://www.xtreemfs.org/xtfs-guide-1.5.1/index.html

Type: strings concatenated with "\n"

Example

`#!nix '' # participants of the replication including this replica babudb.repl.participant.0 = 192.168.0.10 babudb.repl.participant.0.port = 35678 babudb.repl.participant.1 = 192.168.0.11 babudb.repl.participant.1.port = 35678 babudb.repl.participant.2 = 192.168.0.12 babudb.repl.participant.2.port = 35678

# number of servers that at least have to be up to date # To have a fault-tolerant system, this value has to be set to the # majority of nodes i.e., if you have three replicas, set this to 2 # Please note that a setup with two nodes provides no fault-tolerance. babudb.repl.sync.n = 2

# specify whether SSL is required babudb.ssl.enabled = true

babudb.ssl.protocol = tlsv12

# server credentials for SSL handshakes babudb.ssl.service_creds = /etc/xos/xtreemfs/truststore/certs/osd.p12 babudb.ssl.service_creds.pw = passphrase babudb.ssl.service_creds.container = pkcs12

# trusted certificates for SSL handshakes babudb.ssl.trusted_certs = /etc/xos/xtreemfs/truststore/certs/trusted.jks babudb.ssl.trusted_certs.pw = jks_passphrase babudb.ssl.trusted_certs.container = jks

babudb.ssl.authenticationWithoutEncryption = false ''`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.syncMode

The sync mode influences how operations are committed to the disk log before the operation is acknowledged to the caller.

-ASYNC mode the writes to the disk log are buffered in memory by the operating system. This is the fastest mode but will lead to data loss in case of a crash, kernel panic or power failure. -SYNC_WRITE_METADATA opens the file with O_SYNC, the system will not buffer any writes. The operation will be acknowledged when data has been safely written to disk. This mode is slow but offers maximum data safety. However, BabuDB cannot influence the disk drive caches, this depends on the OS and hard disk model. -SYNC_WRITE similar to SYNC_WRITE_METADATA but opens file with O_DSYNC which means that only the data is commit to disk. This can lead to some data loss depending on the implementation of the underlying file system. Linux does not implement this mode. -FDATASYNC is similar to SYNC_WRITE but opens the file in asynchronous mode and calls fdatasync() after writing the data to disk. -FSYNC is similar to SYNC_WRITE_METADATA but opens the file in asynchronous mode and calls fsync() after writing the data to disk.

For best throughput use ASYNC, for maximum data safety use FSYNC.

(If xtreemfs.mrc.replication.enable is true then FDATASYNC is forced)

Type: one of "ASYNC", "SYNC_WRITE_METADATA", "SYNC_WRITE", "FDATASYNC", "FSYNC"

Default

"FSYNC"

Example

"FDATASYNC"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.mrc.uuid

Must be set to a unique identifier, preferably a UUID according to RFC 4122. UUIDs can be generated with uuidgen command, found in the util-linux package.

Type: string

Example

"eacb6bab-f444-4ebf-a06a-3f72d7465e41"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.osd.address

If specified, it defines the interface to listen on. If not specified, the service will listen on all interfaces (any).

Type: string

Default

""

Example

"127.0.0.1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.osd.enable

Whether to enable XtreemFS OSD service.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.osd.extraConfig

Configuration of XtreemFS OSD service. WARNING: configuration is saved as plaintext inside nix store. For more options: https://www.xtreemfs.org/xtfs-guide-1.5.1/index.html

Type: strings concatenated with "\n"

Example

`#!nix '' local_clock_renewal = 0 remote_time_sync = 30000 report_free_space = true capability_secret = iNG8UuQJrJ6XVDTe

dir_service.host = 192.168.0.10 dir_service.port = 32638

# if replication is used dir_service.1.host = 192.168.0.11 dir_service.1.port = 32638 dir_service.2.host = 192.168.0.12 dir_service.2.port = 32638

# specify whether SSL is required ssl.enabled = true ssl.service_creds.pw = passphrase ssl.service_creds.container = pkcs12 ssl.service_creds = /etc/xos/xtreemfs/truststore/certs/osd.p12 ssl.trusted_certs = /etc/xos/xtreemfs/truststore/certs/trusted.jks ssl.trusted_certs.pw = jks_passphrase ssl.trusted_certs.container = jks ''`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.osd.httpPort

Specifies the listen port for the HTTP service that returns the status page.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

30640

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.osd.port

The port to listen on for incoming connections (TCP and UDP).

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

32640

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix

services.xtreemfs.osd.uuid

Must be set to a unique identifier, preferably a UUID according to RFC 4122. UUIDs can be generated with uuidgen command, found in the util-linux package.

Type: string

Example

"eacb6bab-f444-4ebf-a06a-3f72d7465e42"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/xtreemfs.nix