You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2013/09/06 05:35:37 UTC
git commit: TS-361 Document human readable number multiplies for
configuration values
Updated Branches:
refs/heads/master c6c817d01 -> f15a2559a
TS-361 Document human readable number multiplies for configuration values
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/f15a2559
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/f15a2559
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/f15a2559
Branch: refs/heads/master
Commit: f15a2559abd60f86cee489e7d1599fdf1215c3cf
Parents: c6c817d
Author: Leif Hedstrom <zw...@apache.org>
Authored: Thu Sep 5 21:35:30 2013 -0600
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Thu Sep 5 21:35:30 2013 -0600
----------------------------------------------------------------------
.../configuration/records.config.en.rst | 30 +++++++++++++++++--
.../configuration/storage.config.en.rst | 31 +++++++++++++++++---
2 files changed, 54 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f15a2559/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
index f92ed71..0652198 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -39,16 +39,34 @@ Each variable has the following format::
where
-``SCOPE`` is related to clustering and is either ``CONFIG`` (all members of the cluster) or ``LOCAL`` (only the local machine)
+``SCOPE`` is related to clustering and is either ``CONFIG`` (all members of
+the cluster) or ``LOCAL`` (only the local machine)
-``DATATYPE`` is one of ``INT`` (integer), ``STRING`` (string), ``FLOAT`` (floating point).
+``DATATYPE`` is one of ``INT`` (integer), ``STRING`` (string), ``FLOAT``
+(floating point).
-A variable marked as ``Deprecated`` is still functional but should be avoided as it may be removed in a future release without warning.
+A variable marked as ``Deprecated`` is still functional but should be avoided
+as it may be removed in a future release without warning.
A variable marked as ``Reloadable`` can be updated via the command::
traffic_line -x
+``INT`` type configurations are expressed as any normal integer,
+e.g. *32768*. They can also be expressed using more human readable values
+using standard prefixes, e.g. *32K*. The following prefixes are supported
+for all ``INT` type configurations ::
+
+ - ``K`` Kilobytes
+ - ``M`` Megabytes
+ - ``G`` Gigabytes
+ - ``T`` Terabytes
+
+.. note::
+
+ Traffic Server currently writes back configurations to disk periodically,
+ and when doing so, will not preserve the prefixes.
+
Examples
========
@@ -73,6 +91,12 @@ to 10 seconds. ::
CONFIG proxy.config.cluster.startup_timeout INT 10
+The last examples configures a 64GB RAM cache, using a human readable
+prefix. ::
+
+ CONFIG proxy.config.cache.ram_cache.size INT 64G
+
+
Environment Overrides
=====================
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f15a2559/doc/reference/configuration/storage.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/storage.config.en.rst b/doc/reference/configuration/storage.config.en.rst
index d216846..4b7575c 100644
--- a/doc/reference/configuration/storage.config.en.rst
+++ b/doc/reference/configuration/storage.config.en.rst
@@ -50,10 +50,22 @@ Specify pathnames according to your operating system requirements. See
the following examples. In the :file:`storage.config` file, a formatted or
raw disk must be at least 128 MB.
-When using raw disk or partitions, you should make sure the :ts:cv:`Traffic Server user <proxy.config.admin.user_id>`
-used by the Traffic Server process has read and write privileges on the raw disk device or partition. One good practice
-is to make sure the device file is set with 'g+rw' and the Traffic Server user is in the group which owns the device file.
-However, some operating systems have stronger requirements - see the following examples for more information.
+When using raw disk or partitions, you should make sure the :ts:cv:`Traffic
+Server user <proxy.config.admin.user_id>` used by the Traffic Server process
+has read and write privileges on the raw disk device or partition. One good
+practice is to make sure the device file is set with 'g+rw' and the Traffic
+Server user is in the group which owns the device file. However, some
+operating systems have stronger requirements - see the following examples for
+more information.
+
+As with standard ``records.config`` integers, human readable prefixes are also
+supported. They include::
+
+ - ``K`` Kilobytes
+ - ``M`` Megabytes
+ - ``G`` Gigabytes
+ - ``T`` Terabytes
+
Examples
========
@@ -68,6 +80,17 @@ example for 64 MB of cache storage in the current directory::
. 134217728
+As an alternative, using the human readable prefixes, you can express a 64GB
+cache file with::
+
+ /really_big_dir 64G
+
+
+.. note::
+ When using on-filesystem cache disk storage, you can only have one such
+ directory specified. This will be address in a future version.
+
+
Solaris Example
---------------