From ef62220d26bc1b496d49780403bfe3d59d2fd9dd Mon Sep 17 00:00:00 2001 From: Kern Sibbald Date: Wed, 3 Jul 2013 11:38:37 +0200 Subject: [PATCH] Clarify bandwidth limit documentation --- docs/manuals/en/main/dirdconf.tex | 14 +++++++++----- docs/manuals/en/main/filedconf.tex | 15 ++++++++++----- docs/manuals/en/main/newbsfeatures.tex | 24 +++++++++++++++++------- 3 files changed, 36 insertions(+), 17 deletions(-) diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex index 7d2f93a3..da0c2fd2 100644 --- a/docs/manuals/en/main/dirdconf.tex +++ b/docs/manuals/en/main/dirdconf.tex @@ -1084,8 +1084,10 @@ during working hours. We can see it like \texttt{Max Start Delay + Max Run \index[dir]{Maximum Bandwidth} \index[dir]{Directive!Maximum Bandwidth} -The speed parameter specifies the maximum allowed bandwidth that a job may -use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. +The speed parameter specifies the maximum allowed bandwidth in bytes that a +job may use. You may specify the following speed parameter modifiers: + k/s (1,000 bytes per second), kb/s (1,024 bytes per second), + m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second). \label{Director:Job:MaxFullInterval} \item [Max Full Interval = \lt{}time\gt{}] @@ -2462,9 +2464,11 @@ console run command. This directive is required. \index[dir]{Maximum Bandwidth Per Job} \index[dir]{Directive!Maximum Bandwidth Per Job} -The speed parameter specifies the maximum allowed bandwidth that a job may use -when started for this Client. The speed parameter should be specified in -k/s, Kb/s, m/s or Mb/s. +The speed parameter specifies the maximum allowed bandwidth in bytes that a +job may use when started for this Client. +You may specify the following speed parameter modifiers: + k/s (1,000 bytes per second), kb/s (1,024 bytes per second), + m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second). % \item [FD Storage Address = \lt{}address\gt{}] % \index[dir]{FDStorageAddress} diff --git a/docs/manuals/en/main/filedconf.tex b/docs/manuals/en/main/filedconf.tex index 45d4182f..bcacc3a2 100644 --- a/docs/manuals/en/main/filedconf.tex +++ b/docs/manuals/en/main/filedconf.tex @@ -234,8 +234,11 @@ only IPv4 resolutions will be permitted, and likewise with ip6. \index[fd]{Maximum Bandwidth Per Job} \index[fd]{Directive!Maximum Bandwidth Per Job} -The speed parameter specifies the maximum allowed bandwidth that a job may -use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. +The speed parameter specifies the maximum allowed bandwidth in bytes per +second that a job may use. +You may specify the following speed parameter modifiers: + k/s (1,000 bytes per second), kb/s (1,024 bytes per second), + m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second). \label{FileDaemon:FileDaemon:HeartbeatInterval} \item [Heartbeat Interval = \lt{}time-interval\gt{}] @@ -314,9 +317,11 @@ resource in the Director's configuration file. This directive is required. \index[fd]{Maximum Bandwidth Per Job} \index[fd]{Directive!Maximum Bandwidth Per Job} -The speed parameter specifies the maximum allowed bandwidth that a job may use -when started from this Director. The speed parameter should be specified in -k/s, Kb/s, m/s or Mb/s. +The speed parameter specifies the maximum allowed bandwidth in bytes per +second that a job may use when started from this Director. +You may specify the following speed parameter modifiers: + k/s (1,000 bytes per second), kb/s (1,024 bytes per second), + m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second). \label{FileDaemon:Director:Monitor} \item [Monitor = \lt{}yes\vb{}no\gt{}] diff --git a/docs/manuals/en/main/newbsfeatures.tex b/docs/manuals/en/main/newbsfeatures.tex index 24d9f608..e8bed3bc 100644 --- a/docs/manuals/en/main/newbsfeatures.tex +++ b/docs/manuals/en/main/newbsfeatures.tex @@ -568,9 +568,10 @@ Enterprise Edition. \subsection{Job Bandwidth Limitation} The new {\bf Job Bandwidth Limitation} directive may be added to the File -daemon's and/or Director's configuration to limit the bandwidth used by a Job -on a Client. It can be set in the File daemon's conf file for all Jobs run in -that File daemon, or it can be set for each Job in the Director's conf file. +daemon's and/or Director's configuration to limit the bandwidth used by a +Job on a Client. It can be set in the File daemon's conf file for all Jobs +run in that File daemon, or it can be set for each Job in the Director's +conf file. The speed is always specified in bytes per second. For example: \begin{lstlisting} @@ -584,9 +585,14 @@ FileDaemon { \end{lstlisting} The above example would cause any jobs running with the FileDaemon to not -exceed 5Mb/s of throughput when sending data to the Storage Daemon. +exceed 5 megabytes per second of throughput when sending data to the +Storage Daemon. Note, the speed is always specified in bytes per second +(not in bits per second), and the case (upper/lower) of the specification +characters is ignored (i.e. 1MB/s = 1Mb/s). -You can specify the speed parameter in k/s, Kb/s, m/s, Mb/s. +You may specify the following speed parameter modifiers: + k/s (1,000 bytes per second), kb/s (1,024 bytes per second), + m/s (1,000,000 bytes per second), or mb/s (1,048,576 bytes per second). For example: \begin{lstlisting} @@ -607,10 +613,14 @@ A new console command \texttt{setbandwidth} permits to set dynamically the maximum throughput of a running Job or for future jobs of a Client. \begin{lstlisting} -* setbandwidth limit=1000000 jobid=10 +* setbandwidth limit=1000 jobid=10 \end{lstlisting} -The \texttt{limit} parameter is in Kb/s. +Please note that the value specified for the \texttt{limit} command +line parameter is always in units of 1024 bytes (i.e. the number +is multiplied by 1024 to give the number of bytes per second). As +a consequence, the above limit of 1000 will be interpreted as a +limit of 1000 * 1024 = 1,024,000 bytes per second. \medskip This project was funded by Bacula Systems and is available in -- 2.39.5