Skip to content

Conversation

@bneradt
Copy link
Contributor

@bneradt bneradt commented Aug 4, 2025

In the 10.0.0 release, we renamed proxy.config.ssl.session_cache.enabled to proxy.config.ssl.session_cache.value because enabled seemed incorrect for a configuration that took a non-boolean enumeration of values. We accidentially left the documentation describing
proxy.config.ssl.session_cache.enabled, however. In discussion about this, we decided to rename such configurations to "mode" instead of value. Another issue (#12412) records making these renames for 11.0.0. This PR just addresses the current issues with
proxy.config.ssl.session_cache.enabled by:

  • Adding implementation support for proxy.config.ssl.session_cache.enabled since we documented that already but document it as deprecated.
  • Keep implementation support for proxy.config.ssl.session_cache.value since users might be using that.
  • Add proxy.config.ssl.session_cache.mode as the preferred new mode.

The user can set values for any of these via:

  • implicit default config values,
  • plugin default values via TSMgmtIntCreate,
  • explicit records.yaml values, or
  • override via environment variable.

It will probably be a very rare user that implements any of these across values, but in case they do, this patch implements a selection of the finally chosen config value based on a priority base of the above, with "mode" valued over "value" valued over "enabled".

Fixes: #11901
(cherry picked from commit 87bb602)

In the 10.0.0 release, we renamed proxy.config.ssl.session_cache.enabled
to proxy.config.ssl.session_cache.value because enabled seemed incorrect
for a configuration that took a non-boolean enumeration of values. We
accidentially left the documentation describing
proxy.config.ssl.session_cache.enabled, however. In discussion about
this, we decided to rename such configurations to "mode" instead of
value. Another issue (apache#12412) records making these renames for 11.0.0.
This PR just addresses the current issues with
proxy.config.ssl.session_cache.enabled by:

* Adding implementation support for
  proxy.config.ssl.session_cache.enabled since we documented that
  already but document it as deprecated.
* Keep implementation support for proxy.config.ssl.session_cache.value
  since users might be using that.
* Add proxy.config.ssl.session_cache.mode as the preferred new mode.

The user can set values for any of these via:

* implicit default config values,
* plugin default values via TSMgmtIntCreate,
* explicit records.yaml values, or
* override via environment variable.

It will probably be a very rare user that implements any of these across
values, but in case they do, this patch implements a selection of the
finally chosen config value based on a priority base of the above, with
"mode" valued over "value" valued over "enabled".

Fixes: apache#11901
(cherry picked from commit 87bb602)
@bneradt bneradt added this to the 10.1.0 milestone Aug 4, 2025
@bneradt bneradt requested a review from cmcfarlen August 4, 2025 21:39
@bneradt bneradt self-assigned this Aug 4, 2025
@bneradt bneradt added Configuration TLS Backport Marked for backport for an LTS patch release labels Aug 4, 2025
@cmcfarlen
Copy link
Contributor

[approve ci]

@cmcfarlen cmcfarlen merged commit 46f55b4 into apache:10.1.x Aug 5, 2025
15 checks passed
@bneradt bneradt deleted the backport_session_cache_mode branch August 5, 2025 01:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Backport Marked for backport for an LTS patch release Configuration TLS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants