Updated Branches: refs/heads/master a2c2ded90 -> 8b6ab74d6
Document the remap.config '.include' directive Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/8b6ab74d Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/8b6ab74d Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/8b6ab74d Branch: refs/heads/master Commit: 8b6ab74d6eb099674dc4d101297699459abcca65 Parents: 49111ee Author: James Peach <[email protected]> Authored: Fri Dec 6 16:36:14 2013 -0800 Committer: James Peach <[email protected]> Committed: Tue Dec 10 09:05:31 2013 -0800 ---------------------------------------------------------------------- doc/reference/configuration/remap.config.en.rst | 53 +++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8b6ab74d/doc/reference/configuration/remap.config.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/configuration/remap.config.en.rst b/doc/reference/configuration/remap.config.en.rst index fa2713d..b6223da 100644 --- a/doc/reference/configuration/remap.config.en.rst +++ b/doc/reference/configuration/remap.config.en.rst @@ -284,7 +284,9 @@ Examples :: - map http://url/path http://url/path @plugin=/etc/traffic_server/config/plugins/plugin1.so @pparam=1 @pparam=2 @plugin=/etc/traffic_server/config/plugins/plugin2.so @pparam=3 + map http://url/path http://url/path \ + @plugin=/etc/traffic_server/config/plugins/plugin1.so @pparam=1 @pparam=2 \ + @plugin=/etc/traffic_server/config/plugins/plugin2.so @pparam=3 will pass "1" and "2" to plugin1.so and "3" to plugin2.so. @@ -324,3 +326,52 @@ The filter `disable_delete_purge` will be applied to all of the mapping rules. (It is activated before any mappings and is never deactivated.) The filter `internal_only` will only be applied to the second mapping. + +Including Additional Remap Files +================================ + +The ``.include`` directive allows mapping rules to be spread across +multiple files. The argument to the ``.include`` directive is a +list of file names to be parsed for additional mapping rules. Unless +the names are absolute paths, they are resolved relative to the +Traffic Server configuration directory. + +The effect of the ``.include`` directive is as if the contents of +the listed files is included in the parent and parsing restarted +at the point of inclusion. This means that and filters named in the +included files are global in scope, and that additional ``.include`` +directives are allowed. + +.. note:: + + Included remap files are not currently tracked by the configuration + subsystem. Changes to included remap files will not be noticed + by online configuration changes applied by :option:`traffic_line + -x` unless :file:`remap.config` has also changed. + +Examples +-------- + +In this example, a top-level :file:`remap.config` file simply +references additional mapping rules files :: + + .include filters.config + .include one.example.com.config two.example.com.config + +The file `filters.config` contains :: + + .definefilter deny_purge @action=deny @method=purge + .definefilter allow_purge @action=allow @method=purge + +The file `one.example.com.config` contains:: + + .activatefilter deny_purge + map http://one.example.com http://origin-one.example.com + .deactivatefilter deny_purge + +The file `two.example.com.config` contains:: + + .activatefilter allow_purge + map http://two.example.com http://origin-two.example.com + .deactivatefilter dallowpurge +
