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 2014/08/22 21:39:50 UTC
[1/3] git commit: docs: Minor edits
Repository: trafficserver
Updated Branches:
refs/heads/5.1.x 45f23caf6 -> fe18f3b0c
docs: Minor edits
This closes #89
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/fe18f3b0
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/fe18f3b0
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/fe18f3b0
Branch: refs/heads/5.1.x
Commit: fe18f3b0cc40ad5b0ad37967cdbfa659ebe8f6e1
Parents: 31f2062
Author: Jack Bates <ja...@nottheoilrig.com>
Authored: Thu May 22 09:42:53 2014 -0700
Committer: James Peach <jp...@apache.org>
Committed: Fri Aug 22 12:39:40 2014 -0700
----------------------------------------------------------------------
doc/reference/api/TSLifecycleHookAdd.en.rst | 17 ++++++++++-------
.../configuration/ssl_multicert.config.en.rst | 10 +++++-----
2 files changed, 15 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/fe18f3b0/doc/reference/api/TSLifecycleHookAdd.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSLifecycleHookAdd.en.rst b/doc/reference/api/TSLifecycleHookAdd.en.rst
index 3f58f5c..ae18207 100644
--- a/doc/reference/api/TSLifecycleHookAdd.en.rst
+++ b/doc/reference/api/TSLifecycleHookAdd.en.rst
@@ -36,31 +36,34 @@ Description
based on the Traffic Server process, not on any specific transaction or session. These will typically be called only
once during the execution of the Traffic Server process and therefore should be added in :func:`TSPluginInit` (which could itself be considered a lifecyle hook). Unlike other hooks, lifecycle hooks may not have a well defined ordering and use of them should not assume that one of the hooks is always called before another unless specifically mentioned.
-`TS_LIFECYCLE_PORTS_INITIALIZED_HOOK`
+.. c:var:: TS_LIFECYCLE_PORTS_INITIALIZED_HOOK
+
Called after the :ts:cv:`proxy server port <proxy.config.http.server_ports>` data structures have been initialized
but before connections are accepted on those ports. The sockets corresponding to the ports may or may not be open
depending on how the :program:`traffic_server` process was invoked. Other API functions that depend on server ports should be
called from this hook and not :func:`TSPluginInit`.
- Invoked with the event `TS_EVENT_LIFECYCLE_PORTS_INITIALIZED` and `NULL` data.
+ Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_PORTS_INITIALIZED` and :c:data:`NULL` data.
+
+.. c:var:: TS_LIFECYCLE_PORTS_READY_HOOK
-`TS_LIFECYCLE_PORTS_READY_HOOK`
Called after enabling connections on the proxy server ports. Because Traffic Server is threaded this may or may not
be called before any connections are accepted. The hook code may assume that any connection to Traffic Server started
after this hook is called will be accepted by Traffic Server, making this a convenient place to signal external
processes of that.
- Invoked with the event `TS_EVENT_LIFECYCLE_PORTS_READY` and `NULL` data.
+ Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_PORTS_READY` and :c:data:`NULL` data.
+
+.. c:var:: TS_LIFECYCLE_CACHE_READY_HOOK
-`TS_LIFECYCLE_CACHE_READY_HOOK`
Called after Traffic Server cache initialization has finished.
- Invoked with the event `TS_EVENT_LIFECYCLE_CACHE_READY` and `NULL` data.
+ Invoked with the event :c:data:`TS_EVENT_LIFECYCLE_CACHE_READY` and :c:data:`NULL` data.
Ordering
========
-`TS_LIFECYCLE_PORTS_INITIALIZED_HOOK` will always be called before `TS_LIFECYCLE_PORTS_READY_HOOK`.
+:c:data:`TS_LIFECYCLE_PORTS_INITIALIZED_HOOK` will always be called before :c:data:`TS_LIFECYCLE_PORTS_READY_HOOK`.
Examples
========
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/fe18f3b0/doc/reference/configuration/ssl_multicert.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/ssl_multicert.config.en.rst b/doc/reference/configuration/ssl_multicert.config.en.rst
index f044868..8bdeeb8 100644
--- a/doc/reference/configuration/ssl_multicert.config.en.rst
+++ b/doc/reference/configuration/ssl_multicert.config.en.rst
@@ -47,7 +47,7 @@ Each :file:`ssl_multicert.config` line consists of a sequence of
particular SSL certificate.
ssl_cert_name=FILENAME[,FILENAME ...]
- The name of the file containing the TLS certificate. `FILENAME`
+ The name of the file containing the TLS certificate. *FILENAME*
is located relative to the directory specified by the
:ts:cv:`proxy.config.ssl.server.cert.path` configuration variable.
It may also include the intermediate CA certificates, sorted from
@@ -70,7 +70,7 @@ ssl_cert_name=FILENAME[,FILENAME ...]
dest_ip=ADDRESS (optional)
The IP (v4 or v6) address that the certificate should be presented
on. This is now only used as a fallback in the case that the TLS
- SubjectNameIndication extension is not supported. If `ADDRESS` is
+ SubjectNameIndication extension is not supported. If *ADDRESS* is
`*`, the corresponding certificate will be used as the global
default fallback if no other match can be made. The address may
contain a port specifier, in which case the corresponding certificate
@@ -81,13 +81,13 @@ dest_ip=ADDRESS (optional)
ssl_key_name=FILENAME (optional)
The name of the file containing the private key for this certificate.
If the key is contained in the certificate file, this field can
- be omitted, otherwise `FILENAME` is resolved relative to the
+ be omitted, otherwise *FILENAME* is resolved relative to the
:ts:cv:`proxy.config.ssl.server.private_key.path` configuration variable.
ssl_ca_name=FILENAME (optional)
If the certificate is issued by an authority that is not in the
system CA bundle, additional certificates may be needed to validate
- the certificate chain. `FILENAME` is resolved relative to the
+ the certificate chain. *FILENAME* is resolved relative to the
:ts:cv:`proxy.config.ssl.CA.cert.path` configuration variable.
ssl_ticket_enabled=1|0 (optional)
@@ -97,7 +97,7 @@ ssl_ticket_enabled=1|0 (optional)
ticket_key_name=FILENAME (optional)
The name of session ticket key file which contains a secret for
- encrypting and decrypting TLS session tickets. If `FILENAME` is
+ encrypting and decrypting TLS session tickets. If *FILENAME* is
not an absolute path, it is resolved relative to the
:ts:cv:`proxy.config.ssl.server.cert.path` configuration variable.
This option has no effect if session tickets are disabled by the
[2/3] git commit: header_rewrite: remove docs references to PARAMS
and PORT conditions
Posted by jp...@apache.org.
header_rewrite: remove docs references to PARAMS and PORT conditions
PARAMS doesn't appear to be implemented... removing it from the
docs. Was it replaced by QUERY? PORT doesn't appear to be supported
in ATS 5 either.
This closes #102
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/31f2062d
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/31f2062d
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/31f2062d
Branch: refs/heads/5.1.x
Commit: 31f2062ddbcf77053b291efc591b2bdd2cffa908
Parents: 2a331c2
Author: Scott Beardsley <sc...@gmail.com>
Authored: Tue Aug 12 15:00:33 2014 -0700
Committer: James Peach <jp...@apache.org>
Committed: Fri Aug 22 12:39:40 2014 -0700
----------------------------------------------------------------------
doc/reference/plugins/header_rewrite.en.rst | 2 --
1 file changed, 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/31f2062d/doc/reference/plugins/header_rewrite.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/header_rewrite.en.rst b/doc/reference/plugins/header_rewrite.en.rst
index 669f63c..ae532c0 100644
--- a/doc/reference/plugins/header_rewrite.en.rst
+++ b/doc/reference/plugins/header_rewrite.en.rst
@@ -112,12 +112,10 @@ only be evaluated if the condition(s) are met::
cond %{COOKIE:cookie-name} operand [condition_flags]
cond %{CLIENT-HEADER:header-name} operand [condition_flags]
cond %{PROTOCOL} operand [condition_flags]
- cond %{PORT} operand [condition_flags]
cond %{HOST} operand [condition_flags]
cond %{TOHOST} operand [condition_flags]
cond %{FROMHOST} operand [condition_flags]
cond %{PATH} operand [condition_flags]
- cond %{PARAMS} operand [condition_flags]
cond %{QUERY} operand [condition_flags]
cond %{INTERNAL-TRANSACTION} [condition_flags]
cond %{CLIENT-IP} [condition_flags]
[3/3] git commit: header_rewrite: set-redirect documentation
corrections
Posted by jp...@apache.org.
header_rewrite: set-redirect documentation corrections
set-redirect requires two params status-code and destination. Also
QSA appears to be a supported operator flag. This closes #98
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/2a331c25
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/2a331c25
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/2a331c25
Branch: refs/heads/5.1.x
Commit: 2a331c250c7d4901b3616c40701b8c64614a4199
Parents: 45f23ca
Author: Scott Beardsley <sc...@gmail.com>
Authored: Wed Jul 23 15:57:25 2014 -0700
Committer: James Peach <jp...@apache.org>
Committed: Fri Aug 22 12:39:40 2014 -0700
----------------------------------------------------------------------
doc/reference/plugins/header_rewrite.en.rst | 25 ++++++++++++------------
1 file changed, 13 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2a331c25/doc/reference/plugins/header_rewrite.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/header_rewrite.en.rst b/doc/reference/plugins/header_rewrite.en.rst
index 3b69a3a..669f63c 100644
--- a/doc/reference/plugins/header_rewrite.en.rst
+++ b/doc/reference/plugins/header_rewrite.en.rst
@@ -51,18 +51,18 @@ Operators
The following operators are available::
- rm-header header-name [operator_flags]
- add-header header <value> [operator_flags]
- set-header header <value> [operator_flags]
- set-status <status-code> [operator_flags]
- set-destination [qual] <value> [operator_flags]
- set-redirect <value> [operator_flags]
- set-timeout-out <value> [operator_flags]
- set-status-reason <value> [operator_flags]
- set-config overridable-config <value> [operator_flags]
- set-conn-dscp <value> [operator_flags]
- counter counter-name [operator_flags]
- no-op [operator_flags]
+ rm-header header-name [operator_flags]
+ add-header header <value> [operator_flags]
+ set-header header <value> [operator_flags]
+ set-status <status-code> [operator_flags]
+ set-destination [qual] <value> [operator_flags]
+ set-redirect <status-code> <destination> [operator_flags]
+ set-timeout-out <value> [operator_flags]
+ set-status-reason <value> [operator_flags]
+ set-config overridable-config <value> [operator_flags]
+ set-conn-dscp <value> [operator_flags]
+ counter counter-name [operator_flags]
+ no-op [operator_flags]
Where qual is one of the support URL qualifiers::
@@ -84,6 +84,7 @@ The operator flags are optional, and must not contain whitespaces inside
the brackets. Currently, only one flag is supported::
[L] Last rule, do not continue
+ [QSA] Append query string
Variable expansion
------------------