From c4923a4d26cac21992949a6b4fce8cebe2d2c4f7 Mon Sep 17 00:00:00 2001 From: Jason Edgecombe Date: Sun, 20 Jan 2008 00:17:45 +0000 Subject: [PATCH] DEVEL15-man-page-fileserver-limits-20080119 LICENSE BSD Document the 2TB volume and partition limits and the -abortthreshold flag to the AFS fileserver. (cherry picked from commit efba39ead059458d222f923db83c660f23c20b80) --- doc/man-pages/pod1/vos.pod | 11 ++++++++ doc/man-pages/pod1/vos_copy.pod | 11 ++++++++ doc/man-pages/pod1/vos_create.pod | 11 ++++++++ doc/man-pages/pod1/vos_move.pod | 9 ++++++ doc/man-pages/pod8/fileserver.pod | 47 ++++++++++++++++++++++++++++--- 5 files changed, 85 insertions(+), 4 deletions(-) diff --git a/doc/man-pages/pod1/vos.pod b/doc/man-pages/pod1/vos.pod index 1ea17e991..d09c7bf8e 100644 --- a/doc/man-pages/pod1/vos.pod +++ b/doc/man-pages/pod1/vos.pod @@ -94,6 +94,17 @@ Commands to obtain help: B and B. =back +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS The following arguments and flags are available on many commands in the diff --git a/doc/man-pages/pod1/vos_copy.pod b/doc/man-pages/pod1/vos_copy.pod index 353f663e3..a9cbfe606 100644 --- a/doc/man-pages/pod1/vos_copy.pod +++ b/doc/man-pages/pod1/vos_copy.pod @@ -25,6 +25,17 @@ The B command makes a copy of a volume with a new name. It is equivalent to B followed by B, but doesn't require the volume be stored locally by the client. +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod1/vos_create.pod b/doc/man-pages/pod1/vos_create.pod index b3a98d4c4..290620563 100644 --- a/doc/man-pages/pod1/vos_create.pod +++ b/doc/man-pages/pod1/vos_create.pod @@ -60,6 +60,17 @@ with the B command. The volume is empty when created. To access it via the Cache Manager, mount it in the file space by using the B command. +=head1 CAUTIONS + +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod1/vos_move.pod b/doc/man-pages/pod1/vos_move.pod index 7ca03ce6e..3acb3545a 100644 --- a/doc/man-pages/pod1/vos_move.pod +++ b/doc/man-pages/pod1/vos_move.pod @@ -86,6 +86,15 @@ confirmation of the kill signal: To confirm termination of the operation, press Ctrl-C a second time; press any other key to continue the operation. +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + =head1 OPTIONS =over 4 diff --git a/doc/man-pages/pod8/fileserver.pod b/doc/man-pages/pod8/fileserver.pod index 116b8f2b1..6199cb1bf 100644 --- a/doc/man-pages/pod8/fileserver.pod +++ b/doc/man-pages/pod8/fileserver.pod @@ -7,11 +7,12 @@ fileserver - Initializes the File Server component of the fs process =for html
-B S<<< [B<-d> >] >>> +B S<<< [B<-auditlog> >] >>> + S<<< [B<-d> >] >>> S<<< [B<-p> >] >>> S<<< [B<-spare> >] >>> S<<< [B<-pctspare> >] >>> S<<< [B<-b> >] >>> - S<<< [B<-l> >] >>> S<<< [B<-s> >] >>> + S<<< [B<-l> >] >>> S<<< [B<-s> >] >>> S<<< [B<-vc> >] >>> S<<< [B<-w> >] >>> S<<< [B<-cb> >] >>> [B<-banner>] [B<-novbc>] S<<< [B<-implicit> >] >>> [B<-readonly>] @@ -27,7 +28,6 @@ B S<<< [B<-d> >] >>> S<<< [B<-udpsize> >] >>> S<<< [B<-sendsize> >] >>> S<<< [B<-abortthreshold> >] >>> - S<<< [B<-auditlog> >] >>> [B<-enable_peer_stats>] [B<-enable_process_stats>] [B<-help>] =for html @@ -188,7 +188,7 @@ suites. Provide the command name and all option names in full. =head1 CAUTIONS Do not use the B<-k> and B<-w> arguments, which are intended for use -by the AFS Development group only. Changing them from their default +by the OpenAFS developers only. Changing them from their default values can result in unpredictable File Server behavior. In any case, on many operating systems the File Server uses native threads rather than the LWP threads, so using the B<-k> argument to set the number of @@ -202,6 +202,27 @@ Options that are available only on some system types, such as the B<-m> and B<-lock> options, appear in the output generated by the B<-help> option only on the relevant system type. +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) +and the maximum size of a /vicepX partition on a fileserver is also 2 +terabytes. The fileserver will not report an error when it has access +to a partition larger than 2 terabytes, but it will probably fail if +the administrator attempts to use more than 2 terabytes of space. In +addition, there are reports of erroneous disk usage numbers when +B or other OpenAFS disk reporting tools are used with +partitions larger than 2 terabytes. + +The maximum number of directory entries is 64,000 if all of the +entries have names that are 15 characters or less in length. A name +that is 15 characters long requires the use of only one block in the +directory. Additional sequential blocks are required to store entries +with names that are longer than 15 characters. Each additional block +provides an additional length of 32 characters for the name of the +entry. + +In real world use, the maximum number of objects in an AFS directory +is usually between 16,000 and 25,000, depending on the average name +length. + =head1 OPTIONS =over 4 @@ -389,6 +410,24 @@ GetStatus, and so on) sent or received, aggregated over all connections to other machines. To display or otherwise access the records, use the Rx Monitoring API. +=item B<-abortthreshold> > + +Sets the abort threshold, which is triggered when an AFS client sends +a number of FetchStatus requests in a row and all of them fail due to +access control or some other error. When the abort threshold is +reached, the file server starts to slow down the responses to the +problem client in order to reduce the load on the file server. + +The throttling behaviour can cause issues especially for some versions +of the Windows OpenAFS client. When using Windows Explorer to navigate +the AFS directory tree, directories with only "look" access for the +current user may load more slowly because of the throttling. This is +because the Windows OpenAFS client sends FetchStatus calls one at a +time instead of in bulk like the Unix Open AFS client. + +Setting the threshold to 0 disables the throttling behavior. This +option is available in OpenAFS versions 1.4.1 and later. + =item B<-help> Prints the online help for this command. All other valid options are -- 2.39.5