Commit c090fc38 authored by Jim Jagielski's avatar Jim Jagielski
Browse files

Update the proxy module docs to reflect current reality. 

Add in the flush settings, which are part of 2.2.x and
reorder params to be in abc order (to make 'em easier
to find)


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.2.x@432350 13f79535-47bb-0310-9956-ffa450edef68
parent 9ba0edbb

docs/manual/mod/mod_proxy.xml

+62 −37
Changes for docs/manual/mod/mod_proxy.xml: 62 added lines, 37 removed lines.
Original line number Diff line number Diff line
@@ -548,20 +548,6 @@ expressions</description> 
    number of connections will be created on demand. Any connections above 

    <code>smax</code> are subject to a time to live or <code>ttl</code>.

    </td></tr>

    <tr><td>ttl</td>

        <td>-</td>

        <td>Time To Live for the inactive connections above the

        <code>smax</code> connections in seconds. Apache will close all

        connections that has not been used inside that time period.

    </td></tr>

    <tr><td>timeout</td>

        <td><directive>Timeout</directive></td>

        <td>Connection timeout in seconds.

        If not set the Apache will wait until the free connection

        is available. This directive is used for limiting the number

        of connections to the backend server together with <code>max</code>

        parameter.

    </td></tr>

    <tr><td>acquire</td>

        <td>-</td>

        <td>If set this will be the maximum time to wait for a free
@@ -569,6 +555,20 @@ expressions</description> 
    in the pool the Apache will return <code>SERVER_BUSY</code> status to

    the client.

    </td></tr>

    <tr><td>flushpackets</td>

        <td>off</td>

        <td>Determines whether the proxy module will auto-flush the output

        brigade after each "chunk" of data. 'off' means that it will flush

        only when needed, 'on' means after each chunk is sent and

        'auto' means poll/wait for a period of time and flush if

        no input has been received for 'flushwait' milliseconds.

        Currently this is in effect only for AJP.

    </td></tr>

    <tr><td>flushwait</td>

        <td>10</td>

        <td>The time to wait for additional input, in milliseconds, before

        flushing the output brigade if 'flushpackets' is 'auto'.

    </td></tr>

    <tr><td>keepalive</td>

        <td>Off</td>

        <td>This parameter should be used when you have a firewall between your
@@ -578,6 +578,20 @@ expressions</description> 
    generally 120ms), and thus prevent the firewall to drop the connection.

    To enable keepalive set this property value to <code>On</code>. 

    </td></tr>

    <tr><td>loadfactor</td>

        <td>1</td>

        <td>Worker load factor. Used with BalancerMember.

         It is a number between 1 and 100 and defines the normalized weighted

         load applied to the worker.

    </td></tr>

    <tr><td>redirect</td>

        <td>-</td>

        <td>Redirection Route of the worker. This value is usually

        set dynamically to enable safe removal of the node from

        the cluster. If set all requests without session id will be

        redirected to the BalancerMember that has route parametar

        equal as this value.

    </td></tr>

    <tr><td>retry</td>

        <td>60</td>

        <td>Connection pool worker retry timeout in seconds.
@@ -586,24 +600,33 @@ expressions</description> 
    expires. This enables to shut down the backend server for maintenance,

    and bring it back online later.

    </td></tr>

    <tr><td>loadfactor</td>

        <td>1</td>

        <td>Worker load factor. Used with BalancerMember.

         It is a number between 1 and 100 and defines the normalized weighted

         load applied to the worker.

    </td></tr>

    <tr><td>route</td>

        <td>-</td>

        <td>Route of the worker when used inside load balancer.

        The route is a value appended to seesion id.

    </td></tr>

    <tr><td>redirect</td>

    <tr><td>status</td>

        <td>-</td>

        <td>Redirection Route of the worker. This value is usually

        set dynamically to enable safe removal of the node from

        the cluster. If set all requests without session id will be

        redirected to the BalancerMember that has route parametar

        equal as this value.

        <td>Single letter value defining the initial status of

        this worker: 'D' is disabled, 'S' is stopped

        and 'E' is in an error state. Status can be set (which is the default)

        by prepending with '+' or cleared by prepending with '-'.

        Thus, a setting of 'S-E' sets this worker to Stopped and

        clears the in-error flag.

    </td></tr>

    <tr><td>timeout</td>

        <td><directive>Timeout</directive></td>

        <td>Connection timeout in seconds.

        If not set the Apache will wait until the free connection

        is available. This directive is used for limiting the number

        of connections to the backend server together with <code>max</code>

        parameter.

    </td></tr>

    <tr><td>ttl</td>

        <td>-</td>

        <td>Time To Live for the inactive connections above the

        <code>smax</code> connections in seconds. Apache will close all

        connections that has not been used inside that time period.

    </td></tr>



    </table>
@@ -612,24 +635,23 @@ expressions</description> 
    <code>balancer://</code> then a virtual worker that does not really

    communicate with the backend server will be created. Instead it is responsible

    for the management of several "real" workers. In that case the special set of

    parameters can be add to this virtual worker.

    parameters can be add to this virtual worker. See <module>mod_proxy_balancer</module>

    for more information about how the balancer works.

    </p>

    <table>

    <tr><th>Parameter</th>

        <th>Default</th>

        <th>Description</th></tr>

    <tr><td>lbmethod</td>

        <td>-</td>

        <td>byrequests</td>

        <td>Balancer load-balance method. Select the load-balancing scheduler

        method to use. Either <code>byrequests</code>, to perform weighted

        request counting or <code>bytraffic</code>, to perform weighted

        traffic byte count balancing. Default is <code>byrequests</code>.

    </td></tr>

    <tr><td>stickysession</td>

        <td>-</td>

        <td>Balancer sticky session name. The value is usually set to something

        like <code>JSESSIONID</code> or <code>PHPSESSIONID</code>,

        and it depends on the backend application server that support sessions.

    <tr><td>maxattempts</td>

        <td>1</td>

        <td>Maximum number of failover attempts before giving up. 

    </td></tr>

    <tr><td>nofailover</td>

        <td>Off</td>
@@ -637,17 +659,20 @@ expressions</description> 
        error state or disabled. Set this value to On if backend servers do not

        support session replication.

    </td></tr>

    <tr><td>stickysession</td>

        <td>-</td>

        <td>Balancer sticky session name. The value is usually set to something

        like <code>JSESSIONID</code> or <code>PHPSESSIONID</code>,

        and it depends on the backend application server that support sessions.

    </td></tr>

    <tr><td>timeout</td>

        <td>0</td>

        <td>Balancer timeout in seconds. If set this will be the maximum time

        to wait for a free worker. Default is not to wait. 

    </td></tr>

    <tr><td>maxattempts</td>

        <td>1</td>

        <td>Maximum number of failover attempts before giving up. 

    </td></tr>

    

    </table>

    <p>A sample balancer setup</p>

    <example>

      ProxyPass /special-area http://special.example.com/ smax=5 max=10<br />

      ProxyPass / balancer://mycluster stickysession=jsessionid nofailover=On<br />