mirrors/haproxy
1
0
Fork 0
mirror of https://git.haproxy.org/git/haproxy.git/ synced 2025-10-26 14:10:59 +01:00
Code Issues Projects Releases Wiki Activity

DOC: clarify the experimental status for certain features

Browse Source 
Certain features require "expose-experimental-directives" to be set in
the global section. Let's clarify that experimental featuers are only
maintained in best effort mode, may break during the stable cycle, and
are generally not maintained beyond the release of the next LTS branch
since it is extremely challenging, and early adopters are expected to
upgrade to benefit from improvements anyway.
This commit is contained in:
Willy Tarreau 2025-10-17 18:39:03 +02:00
parent 51eca5cbce
commit e7c8deb810
2 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
BRANCHES
View File

@ -171,7 +171,17 @@ feedback for developers:
as the previous releases that had 6 months to stabilize. In terms of as the previous releases that had 6 months to stabilize. In terms of
stability it really means that the point zero version already accumulated stability it really means that the point zero version already accumulated
6 months of fixes and that it is much safer to use even just after it is 6 months of fixes and that it is much safer to use even just after it is
released. released. There is one exception though, features marked as "experimental"
are not guaranteed to be maintained beyond the release of the next LTS
branch. The rationale here is that the experimental status is made to
expose an early preview of a feature, that is often incomplete, not always
in its definitive form regarding configuration, and for which developers
are seeking feedback from the users. It is even possible that changes will
be brought within the stable branch and it may happen that the feature
breaks. It is not imaginable to always be able to backport bug fixes too
far in this context since the code and configuration may change quite a
bit. Users who want to try experimental features are expected to upgrade
quickly to benefit from the improvements made to that feature.
- for developers, given that the odd versions are solely used by highly - for developers, given that the odd versions are solely used by highly
skilled users, it's easier to get advanced traces and captures, and there skilled users, it's easier to get advanced traces and captures, and there

9
doc/configuration.txt
View File

@ -2457,7 +2457,14 @@ expose-deprecated-directives
expose-experimental-directives expose-experimental-directives
This statement must appear before using directives tagged as experimental or This statement must appear before using directives tagged as experimental or
the config file will be rejected. the config file will be rejected. Please note that features covered by this
option are not guaranteed to work well and may break during the maintenance
cycle. Developers will maintain them in best effort mode while the next
version is being worked on, and will deploy any reasonable effort to avoid
breaking them but with no guarantee. For these reasons, these features are
not expected to be supported beyond the release of the next LTS release.
Users who want to try experimental features are expected to upgrade quickly
to benefit from the improvements made to that feature.
external-check [preserve-env] external-check [preserve-env]
Allows the use of an external agent to perform health checks. This is Allows the use of an external agent to perform health checks. This is