github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/documentation/docs/steps/healthExecuteCheck.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  Endpoint for health check is configured.
     8  
     9  !!! warning
    10      The health endpoint needs to be available without authentication!
    11  
    12  !!! tip
    13      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 documentation for Endpoints](http://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html)
    14  
    15  ## ${docGenParameters}
    16  
    17  ## ${docGenConfiguration}
    18  
    19  ## ${docJenkinsPluginDependencies}
    20  
    21  ## Example
    22  
    23  Pipeline step:
    24  
    25  ```groovy
    26  healthExecuteCheck testServerUrl: 'https://testserver.com'
    27  ```