From 9878312b4d759a7000a31c0a387f1089c7d7779e Mon Sep 17 00:00:00 2001 From: Zach Brown Date: Thu, 11 Feb 2021 14:11:23 -0800 Subject: [PATCH] Update man pages for quorum slot changes 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 --- utils/man/scoutfs.5 | 24 +++++++++++------------- utils/man/scoutfs.8 | 28 +++++++++++++++------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/utils/man/scoutfs.5 b/utils/man/scoutfs.5 index b85571cb..add720f0 100644 --- a/utils/man/scoutfs.5 +++ b/utils/man/scoutfs.5 @@ -21,21 +21,19 @@ contains the filesystem's metadata. .sp This option is required. .TP -.B server_addr= -The server_addr option indicates that this mount will participate in -quorum election to try and run a server for all the mounts of its -filesystem. The option specifies the local TCP IPv4 address that the -mount's elected server will listen on for connections from all other -mounts of the filesystem. +.B quorum_slot_nr= +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 -The IPv4 address must be specified as a dotted quad, name resolution is -not supported. A specific port may be provided after a seperating -colon. If no port is specified then a random port will be chosen. The -address will be used for the lifetime of the mount and can not be -changed. The mount must be unmounted to specify a different address. +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 -If server_addr is not specified then the mount will read the filesystem -until it sees the address of an elected server to connect to. +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 diff --git a/utils/man/scoutfs.8 b/utils/man/scoutfs.8 index a43d4ff7..e05c42e0 100644 --- a/utils/man/scoutfs.8 +++ b/utils/man/scoutfs.8 @@ -32,7 +32,7 @@ A path within a ScoutFS filesystem. .PD .TP -.BI "mkfs META-DEVICE DATA-DEVICE {-Q|--quorum-count} NUM [-m|--max-meta-size SIZE] [-d|--max-data-size SIZE] [-f|--force]" +.BI "mkfs META-DEVICE DATA-DEVICE {-Q|--quorum-slot} NR,ADDR,PORT [-m|--max-meta-size SIZE] [-d|--max-data-size SIZE] [-f|--force]" .sp Initialize a new ScoutFS filesystem on the target devices. Since ScoutFS uses separate block devices for its metadata and data storage, two are required. @@ -57,18 +57,20 @@ a faster block device for the metadata device. The path to the block device to be used for ScoutFS file data. If possible, use a larger block device for the data device. .TP -.B "-Q, --quorum-count NUM" -The number of mounts needed to reach quorum and elect one -to be the server. Mounts of the filesystem will hang until a quorum of -mounts are operational. -.sp -Mounts with the -.B server_addr -mount option participate in quorum. The safest quorum number is the -smallest majority of an odd number of participating mounts. For -example, -two out of three total mounts. This ensures that there can only be one -set of mounts that can establish quorum. +.B "-Q, --quorum-slot NR,ADDR,PORT" +Each \-Q option configures a quorum slot. The NR specifies the number +of the slot to configure which must be between 0 and 14. Each slot +number must only be used once, but they can be used in any order and +they need not be consecutive. This is to allow natural relationships +between slot numbers and nodes which may have arbitrary numbering +schemes. ADDR and PORT are the numerical IPv4 address and port which +will be used as the UDP endpoint for leader elections and as the TCP +listening address for server connections. The number of configured +slots determines the size of the quorum of member mounts which must be +present to start the server for the filesystem to operate. A simple +majority is typically required, while one mount is sufficient if only +one or two slots are configured. Until the majority quorum are present, +all mounts will hang waiting for a server to connect to. .TP .B "-m, --max-meta-size SIZE" Limit the space used by ScoutFS on the metadata device to the