From c9f9c45a2def2a7f28d9be725f5b287740ba3f56 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Fri, 10 Apr 2026 10:12:43 +0100 Subject: [PATCH] Link to Kubernetes' startup probe documentation Closes gh-50007 --- .../antora/modules/reference/pages/actuator/endpoints.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc index d2417855f81..1a54ff458f4 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc @@ -970,10 +970,10 @@ It could be the main web server port or a separate management port if the `"mana These health groups are automatically enabled only if the application xref:how-to:deployment/cloud.adoc#howto.deployment.cloud.kubernetes[runs in a Kubernetes environment]. You can enable them in any environment by using the configprop:management.endpoint.health.probes.enabled[] configuration property. -NOTE: If an application takes longer to start than the configured liveness period, Kubernetes mentions the `"startupProbe"` as a possible solution. -Generally speaking, the `"startupProbe"` is not necessarily needed here, as the `"readinessProbe"` fails until all startup tasks are done. +NOTE: If an application takes longer to start than the configured liveness period, Kubernetes https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#when-should-you-use-a-startup-probe[mentions the `"startupProbe"` as a possible solution]. +Generally speaking, the `"startupProbe"` is not necessarily needed here as the `"readinessProbe"` fails until all startup tasks are done. This means your application will not receive traffic until it is ready. -However, if your application takes a long time to start, consider using a `"startupProbe"` to make sure that Kubernetes won't kill your application while it is in the process of starting. +However, if your application takes a long time to start, consider https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes[configuring a `"startupProbe"`] that uses the liveness HTTP probe to make sure that Kubernetes won't kill your application while it is in the process of starting. See the section that describes xref:actuator/endpoints.adoc#actuator.endpoints.kubernetes-probes.lifecycle[how probes behave during the application lifecycle]. If your Actuator endpoints are deployed on a separate management context, the endpoints do not use the same web infrastructure (port, connection pools, framework components) as the main application.