CLEANUP: Remove appsession documentation

I was about to partly revert 294d0f08b3,
because there were no 'X' for 'appsession' in the keyword matrix until
I checked the blame, realizing that the feature does not exist any more.

Clearly the documentation is confusing here, the removal note is only
listed *below* the old documentation and the supported sections still
show 'backend' and 'listen'.

It's been 3.5 years and 4 releases (1.6, 1.7, 1.8 and 1.9), I guess
this can be removed from the documentation of future versions.
This commit is contained in:
Tim Duesterhus 2019-05-06 01:19:52 +02:00 committed by Willy Tarreau
parent 054a5b82c1
commit 473c283d95
2 changed files with 1 additions and 55 deletions

View File

@ -2221,7 +2221,6 @@ specified in a previous "defaults" section.
keyword defaults frontend listen backend
------------------------------------+----------+----------+---------+---------
acl - X X X
appsession - - - -
backlog X X X -
balance X - X X
bind - X X -
@ -2434,59 +2433,6 @@ acl <aclname> <criterion> [flags] [operator] <value> ...
See section 7 about ACL usage.
appsession <cookie> len <length> timeout <holdtime>
[request-learn] [prefix] [mode <path-parameters|query-string>]
Define session stickiness on an existing application cookie.
May be used in sections : defaults | frontend | listen | backend
no | no | yes | yes
Arguments :
<cookie> this is the name of the cookie used by the application and which
HAProxy will have to learn for each new session.
<length> this is the max number of characters that will be memorized and
checked in each cookie value.
<holdtime> this is the time after which the cookie will be removed from
memory if unused. If no unit is specified, this time is in
milliseconds.
request-learn
If this option is specified, then haproxy will be able to learn
the cookie found in the request in case the server does not
specify any in response. This is typically what happens with
PHPSESSID cookies, or when haproxy's session expires before
the application's session and the correct server is selected.
It is recommended to specify this option to improve reliability.
prefix When this option is specified, haproxy will match on the cookie
prefix (or URL parameter prefix). The appsession value is the
data following this prefix.
Example :
appsession ASPSESSIONID len 64 timeout 3h prefix
This will match the cookie ASPSESSIONIDXXX=XXXX,
the appsession value will be XXX=XXXX.
mode This option allows to change the URL parser mode.
2 modes are currently supported :
- path-parameters :
The parser looks for the appsession in the path parameters
part (each parameter is separated by a semi-colon), which is
convenient for JSESSIONID for example.
This is the default mode if the option is not set.
- query-string :
In this mode, the parser will look for the appsession in the
query string.
As of version 1.6, appsessions was removed. It is more flexible and more
convenient to use stick-tables instead, and stick-tables support multi-master
replication and data conservation across reloads, which appsessions did not.
See also : "cookie", "capture cookie", "balance", "stick", "stick-table",
"ignore-persist", "nbproc" and "bind-process".
backlog <conns>
Give hints to the system about the approximate listen backlog desired size
May be used in sections : defaults | frontend | listen | backend

View File

@ -1290,7 +1290,7 @@ int cfg_parse_listen(const char *file, int linenum, char **args, int kwm)
}
}
else if (!strcmp(args[0], "appsession")) { /* cookie name */
ha_alert("parsing [%s:%d] : '%s' is not supported anymore, please check the documentation.\n", file, linenum, args[0]);
ha_alert("parsing [%s:%d] : '%s' is not supported anymore since HAProxy 1.6.\n", file, linenum, args[0]);
err_code |= ERR_ALERT | ERR_FATAL;
goto out;
}