You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by am...@apache.org on 2013/08/20 22:56:38 UTC
git commit: Doc: Fix storage.config write up about raw devices and
permissions.
Updated Branches:
refs/heads/master 3aff41097 -> 2b07cd098
Doc: Fix storage.config write up about raw devices and permissions.
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/2b07cd09
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/2b07cd09
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/2b07cd09
Branch: refs/heads/master
Commit: 2b07cd098333249b92a223bb109505cd951d24f6
Parents: 3aff410
Author: Alan M. Carroll <am...@network-geographics.com>
Authored: Tue Aug 20 15:53:29 2013 -0500
Committer: Alan M. Carroll <am...@network-geographics.com>
Committed: Tue Aug 20 15:54:44 2013 -0500
----------------------------------------------------------------------
.../configuration/records.config.en.rst | 13 ++--
.../configuration/storage.config.en.rst | 74 ++++++++++----------
2 files changed, 43 insertions(+), 44 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2b07cd09/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 2348baa..1347173 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -291,20 +291,21 @@ Local Manager
The nonprivileged user account designated to Traffic Server.
As of version 2.1.1 if the user_id is prefixed with pound character (#) the remaining of the string is considered to be
-``numeric user identifier <http://en.wikipedia.org/wiki/User_identifier>``_.
-If the value is set to ``#-1`` Traffic Server will not change the user during startup.
+a `numeric user identifier <http://en.wikipedia.org/wiki/User_identifier>`_. If the value is set to ``#-1`` Traffic
+Server will not change the user during startup.
Setting ``user_id`` to ``root`` or ``#0`` is now forbidden to
increase security. Trying to do so, will cause the
:program:`traffic_server` fatal failure. However there are two ways to
-bypass that restriction: Specify ``-DBIG_SECURITY_HOLE`` in
-``CXXFLAGS`` during compilation. Set the ``user_id=#-1`` and start
-trafficserver as root.
+bypass that restriction
+
+* Specify ``-DBIG_SECURITY_HOLE`` in ``CXXFLAGS`` during compilation.
+* Set the ``user_id=#-1`` and start trafficserver as root.
Process Manager
===============
-.. ts:cv:: CONFIOG proxy.config.process_manager.mgmt_port INT 8084
+.. ts:cv:: CONFIG proxy.config.process_manager.mgmt_port INT 8084
The port used for internal communication between the :program:`traffic_manager` and :program:`traffic_server` processes.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2b07cd09/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 f6bc746..6440894 100644
--- a/doc/reference/configuration/storage.config.en.rst
+++ b/doc/reference/configuration/storage.config.en.rst
@@ -1,19 +1,19 @@
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
==============
storage.config
@@ -25,18 +25,18 @@ The :file:`storage.config` file lists all the files, directories, and/or
hard disk partitions that make up the Traffic Server cache. After you
modify the :file:`storage.config` file, you must restart Traffic Server.
-Format
+Format
======
The format of the :file:`storage.config` file is::
- pathname size volume=volume_number
+ pathname size volume=volume_number
-where ``pathname`` is the name of a partition, directory or file, ``size``
+where :arg:`pathname` is the name of a partition, directory or file, :arg:`size`
is the size of the named partition, directory or file (in bytes), and
-``volume`` is the volume number that is used in :file:`volume.config`
+:arg:`volume` is the volume number that is used in :file:`volume.config`
and :file:`hosting.config`. You must specify a size for directories or
-files; size is optional for raw partitions. ``volume`` is optional.
+files; size is optional for raw partitions. :arg:`volume` is optional.
You can use any partition of any size. For best performance:
@@ -50,11 +50,10 @@ 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 admin user,
-which is the traffic_server running at, have the read&write privileges.
-The admin user_id is set in :ts:cv:`proxy.config.admin.user_id`.
-One good practice is if the disk set with 'g+rw', put the admin user into
-the group which have the privileges.
+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.
Examples
========
@@ -62,21 +61,20 @@ Examples
The following basic example shows 64 MB of cache storage in the
``/big_dir`` directory::
- /big_dir 67108864
+ /big_dir 67108864
You can use the ``.`` symbol for the current directory. Here is an
example for 64 MB of cache storage in the current directory::
- . 67108864
+ . 67108864
Solaris Example
---------------
The following example is for the Solaris operating system::
- /dev/rdsk/c0t0d0s5
- /dev/rdsk/c0t0d1s5
-
+ /dev/rdsk/c0t0d0s5
+ /dev/rdsk/c0t0d1s5
.. note:: Size is optional. If not specified, the entire partition is used.
@@ -84,19 +82,19 @@ Linux Example
-------------
The following example will use an entire raw disk in the Linux operating
-system:::
+system::
- /dev/sde volume=1
- /dev/sdf volume=2
+ /dev/sde volume=1
+ /dev/sdf volume=2
In order to make sure :program:`traffic_server` will have access to this disk
you can use :manpage:`udev(7)` to persistently set the right permissions. The
following rules are targeted for an Ubuntu system, and stored in
``/etc/udev/rules.d/51-cache-disk.rules``::
- # Assign /dev/sde and /dev/sdf to the tserver group
- # make the assignment final, no later changes allowed to the group!
- SUBSYSTEM=="block", KERNEL=="sd[ef]", GROUP:="tserver"
+ # Assign /dev/sde and /dev/sdf to the tserver group
+ # make the assignment final, no later changes allowed to the group!
+ SUBSYSTEM=="block", KERNEL=="sd[ef]", GROUP:="tserver"
FreeBSD Example
---------------
@@ -107,13 +105,13 @@ devices on FreeBSD can be accessed raw now.
The following example will use an entire raw disk in the FreeBSD
operating system::
- /dev/ada1
- /dev/ada2
+ /dev/ada1
+ /dev/ada2
In order to make sure :program:`traffic_server` will have access to this disk
you can use :manpage:`devfs(8)` to persistently set the right permissions. The
following rules are stored in :manpage:`devfs.conf(5)`::
- # Assign /dev/ada1 and /dev/ada2 to the tserver user
- own ada[12] tserver:tserver
+ # Assign /dev/ada1 and /dev/ada2 to the tserver user
+ own ada[12] tserver:tserver