mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
28 lines
675 B
Markdown
28 lines
675 B
Markdown
# ${docGenStepName}
|
|
|
|
## ${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)
|
|
|
|
## ${docGenParameters}
|
|
|
|
## ${docGenConfiguration}
|
|
|
|
## ${docJenkinsPluginDependencies}
|
|
|
|
## Example
|
|
|
|
Pipeline step:
|
|
|
|
```groovy
|
|
healthExecuteCheck testServerUrl: 'https://testserver.com'
|
|
```
|