You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2015/11/03 07:10:25 UTC
[49/51] trafficserver git commit: doc: move straggling plugin
reference pages
doc: move straggling plugin reference pages
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/018b4ab6
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/018b4ab6
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/018b4ab6
Branch: refs/heads/master
Commit: 018b4ab6ea6ed12df8f8694c13e82611d639db6a
Parents: c619ff3
Author: James Peach <jp...@apache.org>
Authored: Mon Nov 2 21:53:38 2015 -0800
Committer: James Peach <jp...@apache.org>
Committed: Mon Nov 2 22:09:16 2015 -0800
----------------------------------------------------------------------
doc/admin-guide/plugins/cache_promote.en.rst | 54 +++++++++++++++++++++++
doc/admin-guide/plugins/index.en.rst | 48 ++++++++++----------
doc/admin-guide/plugins/mp4.en.rst | 45 +++++++++++++++++++
doc/reference/plugins/cache_promote.en.rst | 54 -----------------------
doc/reference/plugins/mp4.en.rst | 45 -------------------
5 files changed, 123 insertions(+), 123 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/018b4ab6/doc/admin-guide/plugins/cache_promote.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/plugins/cache_promote.en.rst b/doc/admin-guide/plugins/cache_promote.en.rst
new file mode 100644
index 0000000..657acc1
--- /dev/null
+++ b/doc/admin-guide/plugins/cache_promote.en.rst
@@ -0,0 +1,54 @@
+.. 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
+
+ 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.
+
+.. _cache-promote-plugin:
+
+cache_promote Plugin
+====================
+
+The `cache_promote` plugin provides a means to control when an object should
+be allowed to enter the cache. This is orthogonal from normal Cache-Control
+directives, providing a different set of policies to apply. The typical use
+case for this plugin is when you have a very large data set, where you want to
+avoid churning the ATS cache for the long tail content.
+
+All configuration is done via :file:`remap.config`, and the following options
+are available:
+
+ --policy The promotion policy. `lru` and `chance` are supported
+ --sample The sampling rate for the request to be considered
+
+For the `lru` plugin, the following options are also available:
+
+ --hits The minimum number of hits before promotion
+ --buckets The size (entries) of the LRU
+
+These two options combined with your usage patterns will control how likely a
+URL is to become promoted to enter the cache.
+
+Examples
+--------
+
+ map http://cdn.example.com/ http://some-server.example.com \
+ @plugin=cache_promote.so @pparam=--policy=chance --sample=10%
+
+ map http://cdn.example.com/ http://some-server.example.com \
+ @plugin=cache_promote.so @pparam=--policy=lru \
+ @pparam=--hits=10 @pparam=--buckets=10000
+
+Note that the `--sample` option is available for all policies, and when used
+to reduce pressure on the under heavy load.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/018b4ab6/doc/admin-guide/plugins/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/plugins/index.en.rst b/doc/admin-guide/plugins/index.en.rst
index 0952c5d..0b1bce6 100644
--- a/doc/admin-guide/plugins/index.en.rst
+++ b/doc/admin-guide/plugins/index.en.rst
@@ -45,13 +45,13 @@ Plugins that are considered stable are installed by default in |TS| releases.
.. toctree::
:maxdepth: 1
- CacheURL Plugin: allows you to change the key that is used for caching a request by using any portion of the url via regex <cacheurl.en>
- conf_remap Plugin: allows you to override configuration directives dependent on actual remapping rules <conf_remap.en>
- gzip / deflate Plugin: gzips or deflates responses <gzip.en>
- Header Rewrite Plugin: allows you to modify various headers based on defined rules (operations) on a request or response <header_rewrite.en>
- Regex Remap Plugin: allows you to configure mapping rules based on regular expressions <regex_remap.en>
- Stats over HTTP Plugin: implements an HTTP interface to all Traffic Server statistics <stats_over_http.en>
- TCPInfo Plugin: logs TCP metrics at various points in the HTTP processing pipeline <tcpinfo.en>
+ CacheURL: allows you to change the key that is used for caching a request by using any portion of the url via regex <cacheurl.en>
+ Configuration Remap: allows you to override configuration directives dependent on actual remapping rules <conf_remap.en>
+ GZip: gzips or deflates responses <gzip.en>
+ Header Rewrite: allows you to modify various headers based on defined rules (operations) on a request or response <header_rewrite.en>
+ Regex Remap: allows you to configure mapping rules based on regular expressions <regex_remap.en>
+ Stats over HTTP: implements an HTTP interface to all Traffic Server statistics <stats_over_http.en>
+ TCPInfo: logs TCP metrics at various points in the HTTP processing pipeline <tcpinfo.en>
Experimental plugins
====================
@@ -68,22 +68,22 @@ directory of the Apache Traffic Server source tree. Experimental plugins can be
.. toctree::
:maxdepth: 1
- AuthProxy Plugin: delegates the authorization decision of a request to an external HTTP service <authproxy.en>
- Background Fetch Plugin: allows you to proactively fetch content from Origin in a way that it will fill the object into cache <background_fetch.en>
- Balancer Plugin: balances requests across multiple origin servers <balancer.en>
- Buffer Upload Plugin: buffers POST data before connecting to the Origin server <buffer_upload.en>
- Cache Promotion Plugin: provides additional control over when an object should be allowed into the cache <cache_promote.en>
- Combohandler Plugin: provides an intelligent way to combine multiple URLs into a single URL, and have Apache Traffic Server combine the components into one response <combo_handler.en>
- Epic Plugin: emits Traffic Server metrics in a format that is consumed tby the Epic Network Monitoring System <epic.en>
- ESI Plugin: implements the ESI specification <esi.en>
- Generator Plugin: generate arbitrary response data <generator.en>
- GeoIP ACLs Plugin: denying (or allowing) requests based on the source IP geo-location <geoip_acl.en>
- hipes.en
- Metalink Plugin: implements the Metalink download description format in order to try not to download the same file twice. <metalink.en>
- MySQL Remap Plugin: allows dynamic “remaps” from a database <mysql_remap.en>
- AWS S3 Authentication plugin: provides support for the Amazon S3 authentication features <s3_auth.en>
+ AWS S3 Authentication: provides support for the Amazon S3 authentication features <s3_auth.en>
+ AuthProxy: delegates the authorization decision of a request to an external HTTP service <authproxy.en>
+ Background Fetch: allows you to proactively fetch content from Origin in a way that it will fill the object into cache <background_fetch.en>
+ Balancer: balances requests across multiple origin servers <balancer.en>
+ Buffer Upload: buffers POST data before connecting to the Origin server <buffer_upload.en>
+ Cache Promotion: provides additional control over when an object should be allowed into the cache <cache_promote.en>
+ Combo Handler: provides an intelligent way to combine multiple URLs into a single URL, and have Apache Traffic Server combine the components into one response <combo_handler.en>
+ ESI: implements the ESI specification <esi.en>
+ Epic: emits Traffic Server metrics in a format that is consumed tby the Epic Network Monitoring System <epic.en>
+ Generator: generate arbitrary response data <generator.en>
+ GeoIP ACLs: denying (or allowing) requests based on the source IP geo-location <geoip_acl.en>
+ MP4: mp4 streaming media <mp4.en>
+ Metalink: implements the Metalink download description format in order to try not to download the same file twice. <metalink.en>
+ MySQL Remap: allows dynamic “remaps” from a database <mysql_remap.en>
SSL Headers: Populate request headers with SSL session information <sslheaders.en>
+ XDebug: allows HTTP clients to debug the operation of the Traffic Server cache using the X-Debug header <xdebug.en>
+ hipes.en
stale_while_revalidate.en
- ts-lua Plugin: allows plugins to be written in Lua instead of C code <ts_lua.en>
- XDebug Plugin: allows HTTP clients to debug the operation of the Traffic Server cache using the X-Debug header <xdebug.en>
- MP4 Plugin: mp4 streaming media <mp4.en>
+ ts-lua: allows plugins to be written in Lua instead of C code <ts_lua.en>
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/018b4ab6/doc/admin-guide/plugins/mp4.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin-guide/plugins/mp4.en.rst b/doc/admin-guide/plugins/mp4.en.rst
new file mode 100644
index 0000000..deddc29
--- /dev/null
+++ b/doc/admin-guide/plugins/mp4.en.rst
@@ -0,0 +1,45 @@
+.. _mp4-plugin:
+
+MP4 Plugin
+****************
+
+.. 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
+
+ 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.
+
+This module provides streaming media server support for MP4 files.
+User can send a HTTP request to the server with ``start`` argument
+which is measured in seconds, and the server will respond with the
+stream such that its start position corresponds to the requested time,
+for example::
+
+ http://v.foo.com/dota2.mp4?start=290.12
+
+This allows performing a random seeking at any time. We can use flash
+player, vlc, mplayer, firefox or chrome to play the streaming media.
+
+This plugin can be used as a remap plugin. We can write this in remap.config::
+
+ map http://v.foo.com/ http://v.internal.com/ @plugin=mp4.so
+
+
+Note
+===================
+
+This plugin requires that the ``moov`` box in the mp4 file should be ahead
+of ``mdat`` box. It is not a good idea to cache a large mp4 file, many video
+sites will cut a large video file into many small mp4 files, and each
+small mp4 file will be less than 80M(bytes), it will be a reasonable choice.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/018b4ab6/doc/reference/plugins/cache_promote.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/cache_promote.en.rst b/doc/reference/plugins/cache_promote.en.rst
deleted file mode 100644
index 657acc1..0000000
--- a/doc/reference/plugins/cache_promote.en.rst
+++ /dev/null
@@ -1,54 +0,0 @@
-.. 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
-
- 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.
-
-.. _cache-promote-plugin:
-
-cache_promote Plugin
-====================
-
-The `cache_promote` plugin provides a means to control when an object should
-be allowed to enter the cache. This is orthogonal from normal Cache-Control
-directives, providing a different set of policies to apply. The typical use
-case for this plugin is when you have a very large data set, where you want to
-avoid churning the ATS cache for the long tail content.
-
-All configuration is done via :file:`remap.config`, and the following options
-are available:
-
- --policy The promotion policy. `lru` and `chance` are supported
- --sample The sampling rate for the request to be considered
-
-For the `lru` plugin, the following options are also available:
-
- --hits The minimum number of hits before promotion
- --buckets The size (entries) of the LRU
-
-These two options combined with your usage patterns will control how likely a
-URL is to become promoted to enter the cache.
-
-Examples
---------
-
- map http://cdn.example.com/ http://some-server.example.com \
- @plugin=cache_promote.so @pparam=--policy=chance --sample=10%
-
- map http://cdn.example.com/ http://some-server.example.com \
- @plugin=cache_promote.so @pparam=--policy=lru \
- @pparam=--hits=10 @pparam=--buckets=10000
-
-Note that the `--sample` option is available for all policies, and when used
-to reduce pressure on the under heavy load.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/018b4ab6/doc/reference/plugins/mp4.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/mp4.en.rst b/doc/reference/plugins/mp4.en.rst
deleted file mode 100644
index deddc29..0000000
--- a/doc/reference/plugins/mp4.en.rst
+++ /dev/null
@@ -1,45 +0,0 @@
-.. _mp4-plugin:
-
-MP4 Plugin
-****************
-
-.. 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
-
- 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.
-
-This module provides streaming media server support for MP4 files.
-User can send a HTTP request to the server with ``start`` argument
-which is measured in seconds, and the server will respond with the
-stream such that its start position corresponds to the requested time,
-for example::
-
- http://v.foo.com/dota2.mp4?start=290.12
-
-This allows performing a random seeking at any time. We can use flash
-player, vlc, mplayer, firefox or chrome to play the streaming media.
-
-This plugin can be used as a remap plugin. We can write this in remap.config::
-
- map http://v.foo.com/ http://v.internal.com/ @plugin=mp4.so
-
-
-Note
-===================
-
-This plugin requires that the ``moov`` box in the mp4 file should be ahead
-of ``mdat`` box. It is not a good idea to cache a large mp4 file, many video
-sites will cut a large video file into many small mp4 files, and each
-small mp4 file will be less than 80M(bytes), it will be a reasonable choice.