Skip to content

Commit e6ade05

Browse files
fastsophilwebb
authored andcommitted
Clarify documentation for probe ports
Update the reference documentation to provide a better description of the port that should be used for Kubernetes probes. See gh-21650
1 parent 9dfb09c commit e6ade05

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -894,18 +894,20 @@ You can then configure your Kubernetes infrastructure with the following endpoin
894894
livenessProbe:
895895
httpGet:
896896
path: /actuator/health/liveness
897-
port: liveness-port
897+
port: management-port
898898
failureThreshold: ...
899899
periodSeconds: ...
900900
901901
readinessProbe:
902902
httpGet:
903903
path: /actuator/health/readiness
904-
port: liveness-port
904+
port: management-port
905905
failureThreshold: ...
906906
periodSeconds: ...
907907
----
908908

909+
NOTE: `"management-port"` means the port that the actuator endpoints are available on. It could be the server port if a separate management port has not been configured or the `"management.server.port"` property if that has been explicitly configured.
910+
909911
These health groups are only enabled automatically if the application is <<deployment.adoc#cloud-deployment-kubernetes,running in a Kubernetes environment>>.
910912
You can enable them in any environment using the configprop:management.health.probes.enabled[] configuration property.
911913

0 commit comments

Comments
 (0)