1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-16 11:09:33 +02:00
sap-jenkins-library/documentation/docs/steps/healthExecuteCheck.md

26 lines
639 B
Markdown
Raw Normal View History

2019-04-01 09:47:16 +02:00
# ${docGenStepName}
2019-04-01 09:47:16 +02:00
## ${docGenDescription}
## Prerequisites
Endpoint for health check is configured.
!!! warning
The health endpoint needs to be available without authentication!
!!! tip
If using Spring Boot framework, ideally the provided `/health` endpoint is used and extended by development. Further information can be found in the [Spring Boot documenation for Endpoints](http://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html)
2019-04-01 09:47:16 +02:00
## ${docGenParameters}
## ${docGenConfiguration}
## Example
Pipeline step:
```groovy
healthExecuteCheck testServerUrl: 'https://testserver.com'
```