root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

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
This commit is contained in:
Hui Li 2020-06-02 16:15:10 +09:00 committed by Phillip Webb
parent 9dfb09c5d7
commit e6ade05c2d
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -894,18 +894,20 @@ You can then configure your Kubernetes infrastructure with the following endpoin
livenessProbe:
httpGet:
path: /actuator/health/liveness
port: liveness-port
port: management-port
failureThreshold: ...
periodSeconds: ...
readinessProbe:
httpGet:
path: /actuator/health/readiness
port: liveness-port
port: management-port
failureThreshold: ...
periodSeconds: ...
----
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.
These health groups are only enabled automatically if the application is <<deployment.adoc#cloud-deployment-kubernetes,running in a Kubernetes environment>>.
You can enable them in any environment using the configprop:management.health.probes.enabled[] configuration property.