diff --git a/spec/src/main/asciidoc/overview.asciidoc b/spec/src/main/asciidoc/overview.asciidoc index cec0d41..295a707 100644 --- a/spec/src/main/asciidoc/overview.asciidoc +++ b/spec/src/main/asciidoc/overview.asciidoc @@ -27,7 +27,7 @@ https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-read In this scenario health checks are used to determine if a computing node needs to be discarded (terminated, shutdown) and eventually replaced by another (healthy) instance. -The MicroProfile Health architecture consists of three `/health/ready`, `/health/live` and `/health/start` endpoints in a MicroProfile runtime that respectively represent the readiness, the liveness and the startup health of the entire runtime. +The MicroProfile Health architecture consists of three `/health/ready`, `/health/live` and `/health/started` endpoints in a MicroProfile runtime that respectively represent the readiness, the liveness and the startup health of the entire runtime. These endpoints are linked to health check procedures defined with specifications API and annotated respectively with `@Readiness`, `@Liveness` and `@Startup` annotations. A 4th endpoint `/health` is also available and can be used to provide a combination of the previous endpoints. diff --git a/spec/src/main/asciidoc/protocol-wireformat.asciidoc b/spec/src/main/asciidoc/protocol-wireformat.asciidoc index 4b8e7c4..68b9fd2 100644 --- a/spec/src/main/asciidoc/protocol-wireformat.asciidoc +++ b/spec/src/main/asciidoc/protocol-wireformat.asciidoc @@ -225,7 +225,7 @@ Aspects regarding the secure access of health check information. | Readiness | See Appendix B -| /health/start +| /health/started | GET | 200, 500, 503 | Startup @@ -255,7 +255,7 @@ The following table gives valid health check responses for all kinds of health c | Request | HTTP Status | JSON Payload | Status | Comment | /health/live /health/ready - /health/start + /health/started /health | 200 | Yes @@ -264,7 +264,7 @@ The following table gives valid health check responses for all kinds of health c | /health/live /health/ready - /health/start + /health/started /health | 200 | Yes @@ -273,7 +273,7 @@ The following table gives valid health check responses for all kinds of health c | /health/live /health/ready - /health/start + /health/started /health | 503 | Yes @@ -282,7 +282,7 @@ The following table gives valid health check responses for all kinds of health c | /health/live /health/ready - /health/start + /health/started /health | 503 | Yes @@ -291,7 +291,7 @@ The following table gives valid health check responses for all kinds of health c | /health/live /health/ready - /health/start + /health/started /health | 500 | No diff --git a/spec/src/main/asciidoc/release_notes.asciidoc b/spec/src/main/asciidoc/release_notes.asciidoc index 58dc778..06d8d81 100644 --- a/spec/src/main/asciidoc/release_notes.asciidoc +++ b/spec/src/main/asciidoc/release_notes.asciidoc @@ -34,6 +34,7 @@ A full list of changes may be found on the link:https://github.com/eclipse/micro === API/SPI Changes - Added `@Startup` qualifier for the Kubernetes startup probes health check procedures (https://github.com/eclipse/microprofile-health/issues/274[#274]) +- Introduction of `/health/started` endpoint that must call all the startup procedures === Functional Changes diff --git a/tck/src/main/java/org/eclipse/microprofile/health/tck/CDIProducedProceduresTest.java b/tck/src/main/java/org/eclipse/microprofile/health/tck/CDIProducedProceduresTest.java index f324137..1c597b0 100644 --- a/tck/src/main/java/org/eclipse/microprofile/health/tck/CDIProducedProceduresTest.java +++ b/tck/src/main/java/org/eclipse/microprofile/health/tck/CDIProducedProceduresTest.java @@ -37,7 +37,7 @@ /** * Verifies the liveness, readiness, and startup health integration with CDI when the Health Check procedures are * defined with CDI method Producers. - * + * * @author Prashanth Gunapalasingam */ public class CDIProducedProceduresTest extends TCKBase { @@ -99,7 +99,7 @@ public void testFailureReadinessResponsePayload() { @Test @RunAsClient public void testSuccessStartupResponsePayload() { - Response response = getUrlStartContents(); + Response response = getUrlStartedContents(); // status code Assert.assertEquals(response.getStatus(), 200); diff --git a/tck/src/main/java/org/eclipse/microprofile/health/tck/MultipleStartupFailedTest.java b/tck/src/main/java/org/eclipse/microprofile/health/tck/MultipleStartupFailedTest.java index 0bfcf33..e806b92 100644 --- a/tck/src/main/java/org/eclipse/microprofile/health/tck/MultipleStartupFailedTest.java +++ b/tck/src/main/java/org/eclipse/microprofile/health/tck/MultipleStartupFailedTest.java @@ -53,7 +53,7 @@ public static Archive getDeployment() { @Test @RunAsClient public void testFailingStartupResponsePayload() { - Response response = getUrlStartContents(); + Response response = getUrlStartedContents(); // status code Assert.assertEquals(response.getStatus(), 503); diff --git a/tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupFailedTest.java b/tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupFailedTest.java index ca836da..f8fb7bf 100644 --- a/tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupFailedTest.java +++ b/tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupFailedTest.java @@ -49,7 +49,7 @@ public static Archive getDeployment() { @Test @RunAsClient public void testFailedResponsePayload() { - Response response = getUrlStartContents(); + Response response = getUrlStartedContents(); // status code Assert.assertEquals(response.getStatus(), 503); diff --git a/tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupSuccessfulTest.java b/tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupSuccessfulTest.java index 41c4b66..37f3797 100644 --- a/tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupSuccessfulTest.java +++ b/tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupSuccessfulTest.java @@ -49,7 +49,7 @@ public static Archive getDeployment() { @Test @RunAsClient public void testSuccessResponsePayload() { - Response response = getUrlStartContents(); + Response response = getUrlStartedContents(); // status code Assert.assertEquals(response.getStatus(), 200); diff --git a/tck/src/main/java/org/eclipse/microprofile/health/tck/TCKBase.java b/tck/src/main/java/org/eclipse/microprofile/health/tck/TCKBase.java index b47e645..6c44fa9 100644 --- a/tck/src/main/java/org/eclipse/microprofile/health/tck/TCKBase.java +++ b/tck/src/main/java/org/eclipse/microprofile/health/tck/TCKBase.java @@ -75,8 +75,8 @@ Response getUrlReadyContents() { return getUrlContents(this.uri + "/health/ready", false); } - Response getUrlStartContents() { - return getUrlContents(this.uri + "/health/start", false); + Response getUrlStartedContents() { + return getUrlContents(this.uri + "/health/started", false); } private Response getUrlContents(String theUrl, boolean useAuth) {