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

675 B

${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

${docGenParameters}

${docGenConfiguration}

${docJenkinsPluginDependencies}

Example

Pipeline step:

healthExecuteCheck testServerUrl: 'https://testserver.com'