You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/deploy/health-checks.md
+16-13Lines changed: 16 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,18 @@ A failure on the former leads to a restart, whereas a failure on the latter temp
13
13
14
14
[Learn more about health checks on Kubernetes.](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes) {.learn-more}
15
15
16
-
::: warning Limited support for readiness checks on CF
17
-
Although supported by the Cloud Foundry core, readiness checks are not yet supported by the Cloud Foundtry CLI as well as the Cloud MTA Build Tool (MBT).
18
-
:::
19
-
20
-
The Node.js runtime provides an out-of-the-box endpoint for liveness and readiness checks at `/health`.
16
+
For **CAP Node.js**, the runtime provides an out-of-the-box endpoint for liveness and readiness checks at `/health`.
21
17
Requests that reach this public endpoint are answered with the status code 200 and the body `{ status: 'UP' }`.
22
18
23
-
For CAP Java, the `cds add` facets `mta`, `cf-manifest`, `helm`, and `helm-unified-runtime` add the necessary dependencies and configuration for the publicly available probe endpoints `/actuator/health/liveness` and `/actuator/health/readiness`.
24
-
For more details on adding Spring Boot health checks to your CAP Java app, please see [Spring Boot Health Checks](../../java/operating-applications/observability#spring-health-checks).
19
+
[Learn more about availability checks in Node.js.](../../node.js/best-practices#availability-checks) {.learn-more}
20
+
21
+
22
+
For **CAP Java**, `cds add mta` and `cds add kyma` add the necessary dependencies and configuration for the publicly available probe endpoints `/actuator/health/liveness` and `/actuator/health/readiness`.
23
+
24
+
[Learn more about availability checks in Java.](../../java/operating-applications/observability#availability) {.learn-more}
25
+
26
+
27
+
[Learn more about Spring Boot health checks.](../../java/operating-applications/observability#spring-health-checks){.learn-more}
25
28
26
29
<!--
27
30
@@ -33,13 +36,13 @@ This means, if you have a _fully custom_ `server.js`, you will need to add the `
33
36
34
37
-->
35
38
36
-
For deployment to Kyma/ Kubernetes, `@sap/cds-dk` adds the necessary configurations to Helm charts to make the setup complete.
37
-
Once supported, `@sap/cds-dk` will also add the necessary configurations to MTA deployment descriptors.
39
+
For deployment to Kyma/ Kubernetes, `@sap/cds-dk` adds the necessary configurations to Helm charts.
38
40
39
-
::: tip
40
-
Don't forget to adjust the values in your deployment descriptors in case you add different Spring Boot health check endpoints or use a _fully custom_`server.js`.
41
+
::: warning Limited support for readiness checks on CF
42
+
Although supported by the Cloud Foundry core, readiness checks are not yet supported by the Cloud Foundtry CLI as well as the Cloud MTA Build Tool (MBT).
41
43
:::
42
44
43
-
[Learn more about availability checks in Node.js.](../../node.js/best-practices#availability-checks) {.learn-more}
45
+
::: tip Adjust deployment descriptors for custom health checks
46
+
Adjust the values created by `cds add` in case you add different Spring Boot health check endpoints or use a fully custom _server.js_.
47
+
:::
44
48
45
-
[Learn more about availability checks in Java.](../../java/operating-applications/observability#availability) {.learn-more}
0 commit comments