From df19c83155f7526f3d7c1b454e019a6f1984bb0f Mon Sep 17 00:00:00 2001 From: Jim Jagielski Date: Wed, 9 Feb 2005 20:47:47 +0000 Subject: [PATCH] Docs update. Refresh as well as fold in (better??) docs about balancer. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@153116 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/allmodules.xml.ja | 4 +- docs/manual/mod/index.html.en | 3 +- docs/manual/mod/mod_authnz_ldap.html.en | 28 +++++- docs/manual/mod/mod_authz_owner.html | 4 + docs/manual/mod/mod_authz_owner.html.en | 2 + docs/manual/mod/mod_authz_owner.xml.meta | 1 + docs/manual/mod/mod_authz_user.html | 4 + docs/manual/mod/mod_authz_user.html.en | 2 + docs/manual/mod/mod_authz_user.xml.meta | 1 + docs/manual/mod/mod_proxy.html.en | 1 + docs/manual/mod/mod_proxy.xml | 1 + docs/manual/mod/mod_proxy_balancer.html.en | 104 ++++++++++++++++++-- docs/manual/mod/mod_proxy_balancer.xml | 106 +++++++++++++++++++-- docs/manual/mod/quickreference.html.en | 2 +- docs/manual/platform/netware.html.en | 31 ++---- docs/manual/platform/netware.xml.ko | 2 +- 16 files changed, 254 insertions(+), 42 deletions(-) diff --git a/docs/manual/mod/allmodules.xml.ja b/docs/manual/mod/allmodules.xml.ja index 6ccfb62944..d18b190011 100644 --- a/docs/manual/mod/allmodules.xml.ja +++ b/docs/manual/mod/allmodules.xml.ja @@ -16,8 +16,8 @@ mod_authz_default.xml.ja mod_authz_groupfile.xml.ja mod_authz_host.xml.ja - mod_authz_owner.xml - mod_authz_user.xml + mod_authz_owner.xml.ja + mod_authz_user.xml.ja mod_autoindex.xml.ja mod_cache.xml.ja mod_cern_meta.xml diff --git a/docs/manual/mod/index.html.en b/docs/manual/mod/index.html.en index 34012fc93b..21b22d70ee 100644 --- a/docs/manual/mod/index.html.en +++ b/docs/manual/mod/index.html.en @@ -147,8 +147,7 @@ by other LDAP modules
mod_proxy
HTTP/1.1 proxy/gateway server
mod_proxy_ajp
AJP support module for mod_proxy
-
mod_proxy_balancer
mod_proxy extension for -load balancing
+
mod_proxy_balancer
mod_proxy extension for load balancing
mod_proxy_connect
mod_proxy extension for CONNECT request handling
mod_proxy_ftp
FTP support module for diff --git a/docs/manual/mod/mod_authnz_ldap.html.en b/docs/manual/mod/mod_authnz_ldap.html.en index cd23757b67..c9bc4fa338 100644 --- a/docs/manual/mod/mod_authnz_ldap.html.en +++ b/docs/manual/mod/mod_authnz_ldap.html.en @@ -542,12 +542,18 @@ require valid-user

Using TLS

-

To use TLS, see the mod_ldap directives LDAPTrustedCA and LDAPTrustedCAType.

+

To use TLS, see the mod_ldap directives LDAPTrustedClientCert, LDAPTrustedGlobalCert and LDAPTrustedMode.

+ +

An optional second parameter can be added to the + AuthLDAPURL to override + the default connection type set by LDAPTrustedMode. + This will allow the connection established by an ldap:// Url + to be upgraded to a secure connection on the same port.

top

Using SSL

-

To use SSL, see the mod_ldap directives LDAPTrustedCA and LDAPTrustedCAType.

+

To use SSL, see the mod_ldap directives LDAPTrustedClientCert, LDAPTrustedGlobalCert and LDAPTrustedMode.

To specify a secure LDAP server, use ldaps:// in the AuthLDAPURL @@ -799,7 +805,7 @@ environment variable

AuthLDAPUrl Directive

- + @@ -887,6 +893,22 @@ environment variable Jenson, the resulting search filter will be (&(posixid=*)(cn=Babs Jenson)).

+

An optional parameter can be added to allow the LDAP Url to override + the connection type. This parameter can be one of the following:

+ +
+
NONE
+
Establish an unsecure connection on the default LDAP port. This + is the same as ldap:// on port 389.
+
SSL
+
Establish a secure connection on the default secure LDAP port. + This is the same as ldaps://
+
TLS | STARTTLS
+
Establish an upgraded secure connection on the default LDAP port. + This connection will be initiated on port 389 by default and then + upgraded to a secure connection on the same port.
+
+

See above for examples of AuthLDAPURL URLs.

diff --git a/docs/manual/mod/mod_authz_owner.html b/docs/manual/mod/mod_authz_owner.html index e0ab78af4e..f23a815ffe 100644 --- a/docs/manual/mod/mod_authz_owner.html +++ b/docs/manual/mod/mod_authz_owner.html @@ -2,6 +2,10 @@ URI: mod_authz_owner.html.en Content-Language: en Content-type: text/html; charset=ISO-8859-1 +URI: mod_authz_owner.html.ja.euc-jp +Content-Language: ja +Content-type: text/html; charset=EUC-JP + URI: mod_authz_owner.html.ko.euc-kr Content-Language: ko Content-type: text/html; charset=EUC-KR diff --git a/docs/manual/mod/mod_authz_owner.html.en b/docs/manual/mod/mod_authz_owner.html.en index 963487255e..be7ad185b9 100644 --- a/docs/manual/mod/mod_authz_owner.html.en +++ b/docs/manual/mod/mod_authz_owner.html.en @@ -22,6 +22,7 @@

Apache Module mod_authz_owner

Available Languages:  en  | + ja  |  ko 

Description:URL specifying the LDAP search parameters
Syntax:AuthLDAPUrl url
Syntax:AuthLDAPUrl url [NONE|SSL|TLS|STARTTLS]
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
@@ -176,6 +177,7 @@ modules

Available Languages:  en  | + ja  |  ko 

Description:Authorization based on file ownership
@@ -75,6 +76,7 @@ modules

Available Languages:  en  | + ja  |  ko 

top
diff --git a/docs/manual/mod/mod_proxy.xml b/docs/manual/mod/mod_proxy.xml index d3cfc66ee2..764d3cd0e9 100644 --- a/docs/manual/mod/mod_proxy.xml +++ b/docs/manual/mod/mod_proxy.xml @@ -65,6 +65,7 @@ mod_proxy_httpmod_proxy_ftpmod_proxy_connect +mod_proxy_balancermod_ssl
Forward and Reverse Proxies diff --git a/docs/manual/mod/mod_proxy_balancer.html.en b/docs/manual/mod/mod_proxy_balancer.html.en index 12dfb262a4..26821299ff 100644 --- a/docs/manual/mod/mod_proxy_balancer.html.en +++ b/docs/manual/mod/mod_proxy_balancer.html.en @@ -24,8 +24,7 @@

Available Languages:  en  |  ja 

-
Description:User Authorization
+
Description:mod_proxy extension for -load balancing
@@ -52,6 +51,8 @@ load balancing

Topics

See also

    @@ -61,10 +62,25 @@ load balancing

    Load balancer scheduler algorithm

    -

    The idea behind this scheduler is the following:

    +

    At present, there are 2 load balancer scheduler algorithms available + for use: Request Counting and Weighted Traffic Counting. These are controlled + via the lbmethod value of the Balancer definition. See + the Proxy directive for + more information.

    + +
    top
    +
    +

    Request Counting Algorithm

    + +

    Enabled via lbmethod=requests, the idea behind this + scheduler is that we distribute the requests among the + various workers to ensure that each gets their configured share + of the number of requests. It works as follows:

    lbfactor is how much we expect this worker - to work, or the workers's work quota.

    + to work, or the workers's work quota. This is + a normalized value representing their "share" of the amount of + work to be done.

    lbstatus is how urgent this worker has to work to fulfill its quota of work.

    @@ -76,7 +92,8 @@ load balancing which of them needs to work most urgently (biggest lbstatus). This worker is then selected for work, and its lbstatus reduced by the total work quota we distributed to all workers. Thus the sum of all - lbstatus does not change.(*)

    + lbstatus does not change(*) and we distribute the requests + as desired.

    If some workers are disabled, the others will still be scheduled correctly.

    @@ -135,7 +152,49 @@ candidate lbstatus -= total factor

    That is it schedules: a c d a c d a c - d ...

    + d ... Please note that:

    + +
Description:mod_proxy extension for load balancing
Status:Extension
Module Identifier:proxy_balancer_module
Source File:proxy_balancer.c
+ + + + + + + + + +
workerabcd
lbfactor25252525
+ +

Has the exact same behavior as:

+ + + + + + + + + + + +
workerabcd
lbfactor1111
+ +

This is because all values of lbfactor are normalized + with respect to the others. For:

+ + + + + + + + + +
workerabc
lbfactor141
+ +

worker b will, on average, get 4 times the requests + that a and c will.

The following asymmetric configuration works as one would expect:

@@ -183,6 +242,39 @@ candidate lbstatus -= total factor
are selected with 3 b interspersed.

top
+

Weighted Traffic Counting Algorithm

+ +

Enabled via lbmethod=traffic, the idea behind this + scheduler is very similar to the Request Counting method, with + the following changes:

+ +

lbfactor is how much traffic, in bytes, we want + this worker to handle. This is also a normalized value + representing their "share" of the amount of work to be done, + but instead of simply counting the number of requests, we take + into account the amount of traffic this worker has seen.

+ +

If a balancer is configured as follows:

+ + + + + + + + + +
workerabc
lbfactor121
+ +

Then we mean that we want b to process twice the + amount of bytes than a or c should. It does + not necessarily mean that b would handle twice as + many requests, but it would process twice the I/O. Thus, the + size of the request and response are applied to the weighting + and selection algorithm.

+ +
top
+

Enabling Balancer Manager Support

This module requires the service of diff --git a/docs/manual/mod/mod_proxy_balancer.xml b/docs/manual/mod/mod_proxy_balancer.xml index 6099bf8fa9..ee1e8c757f 100644 --- a/docs/manual/mod/mod_proxy_balancer.xml +++ b/docs/manual/mod/mod_proxy_balancer.xml @@ -23,8 +23,7 @@ mod_proxy_balancer -mod_proxy extension for -load balancing +mod_proxy extension for load balancing Extension proxy_balancer.c proxy_balancer_module @@ -51,10 +50,25 @@ load balancing

Load balancer scheduler algorithm -

The idea behind this scheduler is the following:

+

At present, there are 2 load balancer scheduler algorithms available + for use: Request Counting and Weighted Traffic Counting. These are controlled + via the lbmethod value of the Balancer definition. See + the Proxy directive for + more information.

+ +
+ +
+ Request Counting Algorithm +

Enabled via lbmethod=requests, the idea behind this + scheduler is that we distribute the requests among the + various workers to ensure that each gets their configured share + of the number of requests. It works as follows:

lbfactor is how much we expect this worker - to work, or the workers's work quota.

+ to work, or the workers's work quota. This is + a normalized value representing their "share" of the amount of + work to be done.

lbstatus is how urgent this worker has to work to fulfill its quota of work.

@@ -66,7 +80,8 @@ load balancing which of them needs to work most urgently (biggest lbstatus). This worker is then selected for work, and its lbstatus reduced by the total work quota we distributed to all workers. Thus the sum of all - lbstatus does not change.(*)

+ lbstatus does not change(*) and we distribute the requests + as desired.

If some workers are disabled, the others will still be scheduled correctly.

@@ -128,7 +143,52 @@ candidate lbstatus -= total factor

That is it schedules: a c d a c d a c - d ...

+ d ... Please note that:

+ + + + + + + + + + + + +
workerabcd
lbfactor25252525
+ +

Has the exact same behavior as:

+ + + + + + + + + + + + +
workerabcd
lbfactor1111
+ +

This is because all values of lbfactor are normalized + with respect to the others. For:

+ + + + + + + + + + +
workerabc
lbfactor141
+ +

worker b will, on average, get 4 times the requests + that a and c will.

The following asymmetric configuration works as one would expect:

@@ -177,6 +237,40 @@ candidate lbstatus -= total factor are selected with 3 b interspersed.

+
+ Weighted Traffic Counting Algorithm +

Enabled via lbmethod=traffic, the idea behind this + scheduler is very similar to the Request Counting method, with + the following changes:

+ +

lbfactor is how much traffic, in bytes, we want + this worker to handle. This is also a normalized value + representing their "share" of the amount of work to be done, + but instead of simply counting the number of requests, we take + into account the amount of traffic this worker has seen.

+ +

If a balancer is configured as follows:

+ + + + + + + + + + +
workerabc
lbfactor121
+ +

Then we mean that we want b to process twice the + amount of bytes than a or c should. It does + not necessarily mean that b would handle twice as + many requests, but it would process twice the I/O. Thus, the + size of the request and response are applied to the weighting + and selection algorithm.

+ +
+
Enabling Balancer Manager Support

This module requires the service of diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 45584ce417..aee74719a1 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -171,7 +171,7 @@ of user groups for authorization group membership AuthLDAPRemoteUserIsDN on|off off dhEUse the DN of the client username to set the REMOTE_USER environment variable -AuthLDAPUrl urldhEURL specifying the LDAP search parameters +AuthLDAPUrl url [NONE|SSL|TLS|STARTTLS]dhEURL specifying the LDAP search parameters AuthName auth-domaindhCAuthorization realm for use in HTTP authentication AuthType Basic|DigestdhCType of user authentication diff --git a/docs/manual/platform/netware.html.en b/docs/manual/platform/netware.html.en index 5478449887..d4a28e6b0c 100644 --- a/docs/manual/platform/netware.html.en +++ b/docs/manual/platform/netware.html.en @@ -514,28 +514,14 @@

  • Download the source code and unzip to an appropriate directory on your workstation.
    • -
  • Change directory to \httpd-2.0\srclib\apr-util\uri and build - GENURI.nlm by running "gmake -f nwgnumakefile".
    • - -
  • Copy the file GENURI.nlm to the SYS: volume - of a NetWare server and run using the following command: -

    SYS:\genuri > sys:\uri_delims.h

    +
  • Change directory to \httpd-2.0 and build the prebuild utilities + by running "gmake -f nwgnumakefile prebuild". This target will create + the directory \httpd-2.0\nwprebuild and copy each of the utilities + to this location that are necessary to complete the following build steps.
    • -
  • Copy the file uri_delims.h to the directory - \httpd-2.0\srclib\apr-util\uri on the build machine.
    • - -
  • Change directory to \httpd-2.0\srclib\apr and build APR - by running "gmake -f nwgnumakefile"
    • - -
  • Change directory to \httpd-2.0\srclib\pcre and build - DFTABLES.nlm by running "gmake -f nwgnumakefile"
    • - -
  • Change directory to \httpd-2.0\server and build - GENCHARS.nlm by running "gmake -f nwgnumakefile"
    • - -
  • Copy the files GENCHARS.nlm and DFTABLES.nlm - from their respective directories to the SYS: volume of a +
  • Copy the files \httpd-2.0\nwprebuild\GENCHARS.nlm and + \httpd-2.0\nwprebuild\DFTABLES.nlm to the SYS: volume of a NetWare server and run them using the following commands:

    SYS:\genchars > sys:\test_char.h
    @@ -570,12 +556,15 @@ distribution with binaries, docs and additional support files in a \dist\Apache2 directory.

    • +
  • gmake -f nwgnumakefile prebuild

    Builds all of the prebuild utilities + and copies them to the \nwprebuild directory.

    • +
  • gmake -f nwgnumakefile installdev

    Same as install but also creates a \lib and \include directory in the destination directory and copies headers and import files.

  • gmake -f nwgnumakefile clean

    Cleans all object files and binaries - from the \release or \debug build areas depending on whether + from the \release.o or \debug.o build areas depending on whether DEBUG has been defined.

  • gmake -f nwgnumakefile clobber_all

    Same as clean and also deletes diff --git a/docs/manual/platform/netware.xml.ko b/docs/manual/platform/netware.xml.ko index 1242777772..9a7031b55c 100644 --- a/docs/manual/platform/netware.xml.ko +++ b/docs/manual/platform/netware.xml.ko @@ -1,7 +1,7 @@ - +