mirror of
https://github.com/versity/scoutfs.git
synced 2026-04-21 22:10:30 +00:00
9878312b4d
Update the man pages with descriptions of the new mkfs -Q quorum slot configuration and quorum_slot_nr mount option. Signed-off-by: Zach Brown <zab@versity.com>
53 lines
1.6 KiB
Groff
53 lines
1.6 KiB
Groff
.TH scoutfs 5
|
|
.SH NAME
|
|
scoutfs \- overview and mount options for the scoutfs filesystem
|
|
.SH DESCRIPTION
|
|
A scoutfs filesystem is stored on two block devices. Multiple mounts of
|
|
the filesystem are supported between hosts that share access to the
|
|
block device. A new filesystem is created with the
|
|
.B mkfs
|
|
command in the
|
|
.BR scoutfs (8)
|
|
utility.
|
|
.SH MOUNT OPTIONS
|
|
The following mount options are supported by scoutfs in addition to the
|
|
general mount options described in the
|
|
.BR mount (8)
|
|
manual page.
|
|
.TP
|
|
.B metadev_path=<device>
|
|
The metadev_path option specifies the path to the block device that
|
|
contains the filesystem's metadata.
|
|
.sp
|
|
This option is required.
|
|
.TP
|
|
.B quorum_slot_nr=<number>
|
|
The quorum_slot_nr option assigns a quorum member slot to the mount.
|
|
The mount will use the slot assignment to claim exclusive ownership of
|
|
the slot's configured address and an associated metadata device block.
|
|
Each slot number must be used by only one mount at any given time.
|
|
.sp
|
|
When a mount is assigned a quorum slot it becomes a quorum member and
|
|
will participate in the raft leader election process and could start
|
|
the server for the filesystem if it is elected leader.
|
|
.sp
|
|
The assigned number must match one of the slots defined with \-Q options
|
|
when the filesystem was created with mkfs. If the number assigned
|
|
doesn't match a number created during mkfs then the mount will fail.
|
|
.SH FURTHER READING
|
|
A
|
|
.B scoutfs
|
|
filesystem can detect corruption at runtime. A catalog of kernel log
|
|
messages that indicate corruption can be found in
|
|
.BR scoutfs-corruption (8)
|
|
\&.
|
|
|
|
.SH SEE ALSO
|
|
.BR scoutfs (8),
|
|
.BR scoutfs-corruption (7).
|
|
|
|
.SH AUTHORS
|
|
Zach Brown <zab@versity.com>
|
|
|
|
|