Clarify how warnings about soon-to-expire SSL certificates are reported #45564
Labels
status: blocked
An issue that's blocked on an external project change
type: documentation
A documentation update
Milestone
Related to #44650, the documentation about the current behavior is not clear about how warnings for soon-to-expire SSL certificates will be reported.
For health, the documentation says:
spring-boot/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc
Lines 674 to 676 in 6aad225
The implementation doesn't really produce a warning, but one can be inferred from the status of a certificate. Specifically,
details.validChains.certificates.[*].validity.status
will beWILL_EXPIRE_SOON
. If details are not enabled, it appears that the warning is hidden.For info, the documentation says:
spring-boot/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc
Line 1259 in 6aad225
Similar to health, the implementation doesn't really produce a warning, but one can be inferred once again. Specifically,
ssl.bundles.[*].certificateChains.[*].certificates.[*].validity.status
will beWILL_EXPIRE_SOON
.We need to improve the documentation to describe how to identify the warning in the response. We may want to keep #44560 in mind when doing so as the current plan is that the concept of
WILL_EXPIRE_SOON
will be removed from the info side of things.The text was updated successfully, but these errors were encountered: