DownloadTranslators options
From GlusterDocumentation
[edit]
Option type and possible values
[edit]
ANY
Doesn't have any specific pattern. Interpreted later by init() of each translator/module.
[edit]
STRING
String type, can have fixed values.
[edit]
TIME
Time (in seconds)
[edit]
PERCENT
1-100%
[edit]
INTEGER
Integer, can have a suggested range.
[edit]
XLATOR
Translator name only
[edit]
PATH
Should be a absolute path
[edit]
BOOLEAN
'on|off', 'true|false', 'enable|disable', '0|1', 'yes|no' are permitted.
[edit]
SIZET
Integer followed by, without spaces in between, any of the followed size determinators: 'KB', 'MB', 'GB', 'TB', 'PB'
[edit]
Translators and their options
[edit]
mount/fuse
| Option | Type | Min | Max | Mandatory? | Values(Default in Bold) | Description |
|---|---|---|---|---|---|---|
| direct-io-mode | BOOLEAN | - | - | No | off|yes|no | Allows FUSE kernel module to perform IO in large chunks. |
| macfuse-local | BOOLEAN | - | - | No | off|yes|no | This way, GlusterFS will be detected as 'servers' instead of 'devices'. This method is useful if you want to do 'umount <mount_point>' over network, instead of 'eject'ing it from desktop. |
| mount-point (mountpoint) | PATH | - | - | Yes | Valid unix path | Directory to mount glusterfs on. |
| attribute-timeout | TIME | 0 | 3600 | No | 1 | Time after which an inode's attributes like owner, mode, size will timeout in the inode cache. Any lookup after this period will lead to an actual lookup from the gluster server. |
| entry-timeout | TIME | 0 | 3600 | No | 1 | Time after which a dentry will timeout in the dentry cache. |
| strict-volfile-check | BOOLEAN | - | - | No | off|yes|no | Unused option |
[edit]
protocol/server
| Option | Type | Min | Max | Mandatory? | Values | Description |
|---|---|---|---|---|---|---|
| transport-type | STRING | - | - | Yes | socket|ib-verbs|unix|ib-sdp|tcp/server|ib-verbs/server | - |
| volume-filename.<key> | PATH | - | - | No | - | The volume file in PATH is associated with the key in <key> so that a glusterfs client instance can be invoked with --volfile-id=<key> parameter where the <key> can be the identifier for the client volume file to be fetched from the server. |
| inode-lru-limit | INTEGER | 0 | (1 * GF_UNIT_MB) | No | 1024 | Maximum of megabytes of memory to use in the inode cache. |
| client-volume-filename | PATH | - | - | - | - | Deprecated. Please use volume-filename.<key> option. |
[edit]
auth.addr
| Option | Type | Min | Max | Mandatory? | Values | Description |
|---|---|---|---|---|---|---|
| auth.addr.<subvolume>.allow | ANY | - | - | Yes | IP Addresses | IP addresses of clients which should be allowed to access the <subvolume>. This <subvolume> is any of the volumes defined in the volfile and that need to be exported to the clients. |
| auth.addr.<subvolume>.reject | ANY | - | - | No | IP Addresses | Addresses that should be denied access to the volume in <subvolume>. |
Note on IP Addresses
IP addresses for the auth mechanism can be of the form:
a. 192.168.1.121, to specify an exact match.
b. 192.168.1.*, to specify an address that matches with netmask of 24.
[edit]
auth.login
| Option | Type | Min | Max | Mandatory? | Values | Description |
|---|---|---|---|---|---|---|
| auth.login.<subvolume>.allow | ANY | - | - | No | Login ID | Login ID that must be used by a client to mount the subvolume in <subvolume>. |
| auth.login.<subvolume>.password | ANY | - | - | No | Password | Password that needs to be used with the login ID specified above, in order to access <subvolume> |
[edit]
protocol/client
| Options | Type | Min | Max | Mandatory? | Values(Defaults in bold) | Description |
|---|---|---|---|---|---|---|
| username | ANY | - | - | No | Login ID | This option is mandatory only if the volume that is specified with the 'remote-subvolume' option has been configured to require a username and password on the server's volume file. |
| password | ANY | - | - | No | - | This option is mandatory only if the volume that is specified with the 'remote-subvolume' option has been configured to require a username and password on the server's volume file. |
| transport-type | STRING | - | - | Yes | tcp|ib-verbs|unix|ib-sdp|tcp/client|ib-verbs/client | Transport type must be the same as that define on the server for corresponding sub-volumes. |
| remote-host | ANY | - | - | Yes | Hostname or IP address | Hostname or the IP of the server. |
| remote-subvolume | ANY | - | - | Yes | - | The subvolume on the remote-host that must be mounted locally. |
| transport-timeout | TIME | 5 | 1013 | No | 600 | The transport connection to the server times out if no reply is received until the specified seconds and a new connection re-attempted. |
| ping-timeout | TIME | 5 | 1013 | No | 10 | - |
[edit]
storage/posix
| Options | Type | Min | Max | Mandatory? | Values(Default in bold) | Description |
|---|---|---|---|---|---|---|
| o-direct | BOOLEAN | - | - | No | off|yes|no | Sets the O_DIRECT flag for every file opened. |
| directory | PATH | - | - | Yes | Valid unix path | The directory that will serve as the data store. |
| export-statfs-size | BOOLEAN | - | - | No | off|yes|no | Allows exporting of file system stats like size, used, available, etc. for the filesystem underlying the exported directory. |
| mandate-attribute | BOOLEAN | - | - | No | off|yes|no | GlusterFS requires extended attributes support in the underlying file system and the default behaviour is to exit if there is no extended attributes support. This option can be used to over-ride this behaviour. |
| span-devices | INT | - | - | No | 1 | This feature enables exported directory containing different mountpoints. This option allows a number of different mountpoints export directories can have, one can enable this feature. |
[edit]
cluster/replicate
| Options | Type | Min | Max | Mandatory? | Values(Default in bold) | Description |
|---|---|---|---|---|---|---|
| read-subvolume | XLATOR | - | - | No | Name of a pre-defined volume | If this option is given with volume name as the argument, read operations are sent only to this volume instead of being load-balanced across all volumes. |
| favorite-child | XLATOR | - | - | No | Name of a pre-defined volume | After a network partition or a split-brain situation, if a discrepancy is noticed in the attributes or content of a file, the copy on this volume will be considered the definitive version and its contents will overwrite the contents of all other copies. Use with caution. |
| data-self-heal | BOOLEAN | - | - | No | off|yes|no | Enable/disable self-healing of file contents. |
| metadata-self-heal | BOOLEAN | - | - | No | off|yes|no | Enable/disable self-healing of meta-data (permissions, ownership, modification times). |
| entry-self-heal | BOOLEAN | - | - | No | off|yes|no | Enable/disable self-healing of directory entries. |
| data-change-log | BOOLEAN | - | - | No | on|off|yes|no | Enable/disable writing of change log for data operations. |
| metadata-change-log | BOOLEAN | - | - | No | off|yes|no | Enable/disable writing of change log for meta-data operations. |
| entry-change-log | BOOLEAN | - | - | No | off|yes|no | Enable/disable writing of change log for entry operations. |
| data-lock-server-count | INTEGER | 0 | - | No | 1 | When changing the content of a file, this value determines the number replicas on which glusterFS acquires a lock on, in order to synchronize access to this file among numerous clients. |
| metadata-lock-server-count | INTEGER | 0 | - | No | 0 | When changing a file or directory meta-data, this value determines the number replicas on which glusterFS acquires a lock on, in order to synchronize access to this file among numerous clients. |
| entry-lock-server-count | INTEGER | 0 | - | No | 1 | When changing the content of a directory, this value determines the number replicas on which glusterFS acquires a lock on, in order to synchronize access to this file among numerous clients. |
[edit]
cluster/distribute
| Options | Type | Min | Max | Mandatory? | Values | Description |
|---|---|---|---|---|---|---|
| lookup-unhashed | BOOLEAN | - | - | No | off|yes|no | It is possible that the distribute translator finds that a lookup operation for a file or a directory failed on the node to which this file/dir was scheduled to. In this case, if this option is enabled, distribute translator sends a lookup operation to all the underlying sub-volumes in anticipation that at least one would return a successful reply. |
| min-free-disk | PERCENT | - | - | No | - | This option tells the 'cluster/distribute' volume to stop creating files in the volume where the file gets hashed to, if the available disk space is lesser than the given option. Default option '10%' |
[edit]
cluster/unify
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| namespace | XLATOR | - | - | - | - |
| scheduler | STRING | - | - | rr|random|nufa|switch | - |
| self-heal | STRING | - | - | background|off | - |
| optimisit | BOOLEAN | - | - | off|yes|no | - |
[edit]
scheduler/alu
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| scheduler.alu.order (alu.order) | ANY | - | - | - | - |
| scheduler.alu.disk-usage.entry-threshold (alu.disk-usage.entry-threshold) | SIZET | - | - | - | - |
| scheduler.alu.disk-usage.exit-threshold (alu.disk-usage.exit-threshold) | SIZET | - | - | - | - |
| scheduler.alu.write-usage.entry-threshold (alu.write-usage.entry-threshold) | SIZET | - | - | - | - |
| scheduler.alu.write-usage.exit-threshold (alu.write-usage.exit-threshold) | SIZET | - | - | - | - |
| scheduler.alu.read-usage.entry-threshold (alu.read-usage.entry-threshold) | SIZET | - | - | - | - |
| scheduler.alu.read-usage.exit-threshold (alu.read-usage.exit-threshold) | SIZET | - | - | - | - |
| scheduler.alu.open-files-usage.entry-threshold (alu.open-files-usage.entry-threshold) | INTEGER | - | - | - | - |
| scheduler.alu.open-files-usage.exit-threshold (alu.open-files-usage.exit-threshold) | INTEGER | - | - | - | - |
| scheduler.read-only-subvolumes (alu.read-only-subvolumes) | ANY | - | - | - | - |
| scheduler.refresh-interval (alu.refresh-interval) | TIME | - | - | - | - |
| scheduler.limits.min-free-disk (alu.limits.min-free-disk) | PERCENT | - | - | - | - |
| scheduler.alu.stat-refresh.num-file-create (alu.stat-refresh.num-file-create) | INTEGER | - | - | - | - |
[edit]
scheduler/nufa
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| scheduler.refresh-interval (nufa.refresh-interval) | TIME | - | - | - | - |
| scheduler.limits.min-free-disk (nufa.limits.min-free-disk) | PERCENT | - | - | - | - |
| scheduler.local-volume-name (nufa.local-volume-name) | XLATOR | - | - | - | - |
[edit]
scheduler/random
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| scheduler.refresh-interval (random.refresh-interval) | TIME | - | - | - | - |
| scheduler.limits.min-free-disk (random.limits.min-free-disk) | PERCENT | - | - | - | - |
[edit]
scheduler/rr
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| scheduler.refresh-interval (rr.refresh-interval) | TIME | - | - | - | - |
| scheduler.limits.min-free-disk (rr.limits.min-free-disk) | PERCENT | - | - | - | - |
| scheduler.read-only-subvolumes (rr.read-only-subvolumes) | ANY | - | - | - | - |
[edit]
scheduler/switch
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| scheduler.read-only-subvolumes (switch.read-only-subvolumes | ANY | - | - | - | - |
| scheduler.local-volume-name (switch.nufa.local-volume.name) | XLATOR | - | - | - | - |
| scheduler.switch.case (switch.case) | ANY | - | - | - | - |
[edit]
cluster/nufa
| Options | Type | Min | Max | Mandatory? | Values(Default in bold) | Description |
|---|---|---|---|---|---|---|
| lookup-unhashed | BOOLEAN | - | - | No | off|yes|no | It is possible that nufa translator finds that a lookup operation for a file or a directory failed on the node to which this file/dir was scheduled to. In this case, if this option is enabled, nufa translator sends a lookup operation to all the underlying sub-volumes in anticipation that at least one would return a successful reply. |
| local-volume-name | XLATOR | - | - | No | Volume name, By default local volume name is assumed to be the hostname. | The volume that should be considered as the local and preferred volume for non-uniform access. |
[edit]
cluster/stripe
| Options | Type | Min | Max | Mandatory? | Values(Default in bold) | Description |
|---|---|---|---|---|---|---|
| block-size | ANY | - | - | No | <filename-pattern:blk-size>*:128KiB | Allows the user to specify the size of the stripe unit that will be read from or written to the underlying volumes. The default tuple, as shown, uses a stripe size of 128 KiB for all files. For specifying different stripe unit sizes for different files, multiple comma-separated <filename-pattern:blk-size> tuples can be specified. In the patter, 'blk-size' specifies the number of KiBs in a stripe unit. |
| use-xattr | BOOLEAN | - | - | No | off|yes|no | Files created through stripe are sparse files with different chunks of the files going to different volumes. In case the configuration including the block-size is changed, we must ensure that files that were created using the previous block size are read from and written to using the old block size. This block is stored inside the extended attributes of the files and the support for adding such extended attributes can be enabled or disabled through this option. |
[edit]
performance/read-ahead
| Options | Type | Min | Max | Mandatory? | Values(Default in bold) | Description |
|---|---|---|---|---|---|---|
| force-atime-update | BOOLEAN | - | - | No | no|on|off | Whether to force an access time (atime) update on the file on every read. Without
this, the atime will be slightly imprecise, as it will reflect the time when the read-ahead translator read the data, not when the application actually read it. |
| page-size | SIZET | 64KB | 2MB | No | 256 KiB | The size of the page in which the read-ahead will be performed. |
| page-count | SIZET | 1 | 16 | No | 2 | When read-ahead is triggered, this value determines how many pages of 'page-size' will be fetched. |
[edit]
performance/write-behind
| Options | Type | Min | Max | mandatory? | Values | Description |
|---|---|---|---|---|---|---|
| flush-behind | BOOLEAN | - | - | No | off|yes|no | When an application calls close(), there could be corresponding buffer in the write-behind translator. This flag allows close() to return immediately and the buffers to get flushed later. |
| block-size | SIZET | 128KiB | 4MiB | No | 0 | The value of this argument ensures that underlying translators will not be handed a message smaller than 'aggregate-size'. If the default setting is used, every write however small it is will be handed in its original size at the time of flushing of buffers, i.e. without aggregation. |
| window-size | SIZET | 512KiB | 1GiB | No | 0 | The size of the per-file write-behind buffer. |
| enable-O_SYNC | BOOLEAN | - | - | No | off|yes|no | Setting this flag makes glusterFS respect the O_SYNC flag for files which are opened with this flag. By default, all files' writes are buffered. |
| disable-for-first-nbytes | SIZET | 1 Byte | 1MiB | No | 1 Byte | Disabled write-behind buffering for the first N bytes specified in this option. |
[edit]
performance/symlink-cache
[edit]
performance/io-cache
| Options | Type | Min | Max | Mandatory? | Values | Description |
|---|---|---|---|---|---|---|
| priority | ANY | - | - | No | Values must comprise of comma-separated <pattern>:<prio> tuples, where <pattern>s are like *.mpg format and <prio> is an integer. | Assigns priority to filenames with specific patterns so that when a page needs to be ejected out of the cache, the page of a file whose priority is the lowest will be ejected earlier. |
| cache-timeout (force-revalidate-timeout) | TIME | 0 | 60 | No | 1 | If the cached page for a file is greater than 'cache-timeout' seconds old, io-cache translator forces a re-validation of the page. |
| page-size | SIZET | 16KiB | 4MiB | No | 128KiB | Size of the page in which file data is cached and validated. |
| cache-size | SIZET | 4MiB | 6GiB | No | 32MiB | Size of the read cache. |
[edit]
performance/io-threads
| Options | Type | Min | Max | Mandatory? | Values | Description |
|---|---|---|---|---|---|---|
| thread-count | INTEGER | 2 | - | No | 16 | Number of threads to keep around in the thread pool. |
[edit]
features/path-convertor
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| start-offset | INTEGER | 0 | 4095 | - | - |
| end-offset | INTEGER | 1 | 4096 | - | - |
| replace-with | ANY | - | - | - | - |
[edit]
features/trash
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| trash-dir | PATH | - | - | - | - |
[edit]
features/locks
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| mandatory-locks | BOOLEAN | - | - | - | - |
[edit]
features/filter
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| root-squashing | BOOLEAN | - | - | - | - |
| read-only | BOOLEAN | - | - | - | - |
| fixed-uid | INTEGER | - | - | - | - |
| fixed-gid | INTEGER | - | - | - | - |
| translate-uid | ANY | - | - | - | - |
| translate-gid | ANY | - | - | - | - |
| filter-uid | ANY | - | - | - | - |
| filter-gid | ANY | - | - | - | - |
[edit]
features/quota
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| min-free-disk-limit | PERCENT | - | - | - | - |
| refresh-interval | TIME | - | - | - | - |
| disk-usage-limit | SIZET | - | - | - | - |
[edit]
debug/trace
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| include-ops | STRING | - | - | - | - |
| exclude-ops | STRING | - | - | - | - |
[edit]
encryption/rot-13
| options | type | min | max | values | description |
|---|---|---|---|---|---|
| encrypt-write | BOOLEAN | - | - | - | - |
| decrypt-read | BOOLEAN | - | - | - | - |
[edit]
Transports
[edit]
ib-verbs
| option | type | min | max | values | description |
|---|---|---|---|---|---|
| transport.ib-verbs.port | GF_OPTION_TYPE_INT | 1 | 4 | - | check the option by 'ibv_devinfo' |
| transport.ib-verbs.mtu (ib-verbs-mtu) | GF_OPTION_TYPE_INT | - | - | - | - |
| transport.ib-verbs.device-name (ib-verbs-device-name) | GF_OPTION_TYPE_ANY | - | - | - | check by 'ibv_devinfo' |
| transport.ib-verbs.work-request-send-size (ib-verbs-work-request-send-size) | GF_OPTION_TYPE_INT | - | - | - | - |
| transport-ib-verbs.work-request-recv-size (ib-verbs-work-request-recv-size) | GF_OPTION_TYPE_INT | - | - | - | - |
| transport.ib-verbs.work-request-send-count (ib-verbs-work-request-send-count) | GF_OPTION_TYPE_INT | - | - | - | - |
| transport.ib-verbs.work-request-recv-count (ib-verbs-work-request-recv-count) | GF_OPTION_TYPE_INT | - | - | - | - |
| remote-port (transport.remote-port, transport.ib-verbs.remote-port) | GF_OPTION_TYPE_INT | - | - | - | - |
| transport.ib-verbs.listen-port | GF_OPTION_TYPE_INT | - | - | - | - |
| transport.ib-verbs.connect-path (connect-path) | GF_OPTION_TYPE_ANY | - | - | - | - |
| transport.ib-verbs.bind-path | GF_OPTION_TYPE_ANY | - | - | - | - |
| transport.ib-verbs.listen-path (listen-path) | GF_OPTION_TYPE_ANY | - | - | - | - |
| transport.address-family (address-family) | GF_OPTION_TYPE_STR | - | - | inet6|inet/inet6|inet6/inet|unix|inet-sdp | - |
[edit]
socket
| option | type | min | max | values | description |
|---|---|---|---|---|---|
| transport.socket.remote-port (transport.remote-port, remote-port) | GF_OPTION_TYPE_INT | - | - | - | - |
| transport.socket.listen-port (listen-port) | GF_OPTION_TYPE_INT | - | - | - | - |
| transport.socket.bind-address (bind-address) | GF_OPTION_TYPE_INT | - | - | - | - |
| transport.socket.connect-path (connect-path) | GF_OPTION_TYPE_ANY | - | - | - | - |
| transport.socket.bind-path (bind-path) | GF_OPTION_TYPE_ANY | - | - | - | - |
| transport.socket.listen-path (listen-path) | GF_OPTION_TYPE_ANY | - | - | - | - |
| transport.address-family (address-family) | GF_OPTION_TYPE_ANY | - | - | inet6|inet/inet6|inet6/inet|unix|inet-sdp | - |
