Documentation for OCI Object Storage health checks (helidon-io#3181)

* Documentation for OCI Object Storage health checks. Same dependency but different usage depending on SE or MP. Signed-off-by: Santiago Pericasgeertsen <[email protected]> * Removed trailing empty lines. Signed-off-by: Santiago Pericasgeertsen <[email protected]>
Captain1653 · Jul 9, 2021 · 6b43191 · 6b43191
1 parent 76b7d56
commit 6b43191
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 0 deletions.
diff --git a/docs/mp/oci/02_object-storage.adoc b/docs/mp/oci/02_object-storage.adoc
@@ -182,3 +182,25 @@ public Response delete(@PathParam("file-name") String fileName) {
 
 <1> Use `deleteObject` function and configure a `DeleteObject.Request.builder()` to submit the delete request
 <2> Return the result
+
+== Object Storage Health Check
+
+If your Helidon application depends on Object Storage accessibility, you may consider setting
+up a health check to verify connectivity with an OCI bucket. To do so, first add the following
+dependency in your pom file:
+
+[source,xml]
+----
+<dependency>
+    <groupId>io.helidon.integrations.oci</groupId>
+    <artifactId>helidon-integrations-oci-objectstorage-health</artifactId>
+</dependency>
+----
+
+By adding this dependency to your application, you get a (built-in) health check automatically
+registered for you. This health check is controlled by the Config properties `oci.objectstorage.namespace`
+and `oci.objectstorage.bucket`, in addition to the user-specific configuration under `~/.oci/config`.
+
+When executed, this health check will _ping_ the bucket to make sure it is accessible in your
+environment. For more information about health checks see <<mp/health/01_introduction.adoc,
+MicroProfile Health>>.
diff --git a/docs/se/oci/02_object-storage.adoc b/docs/se/oci/02_object-storage.adoc
@@ -212,3 +212,47 @@ private void delete(ServerRequest req, ServerResponse res) {
 
 <1> Use `deleteObject` function and configure a `DeleteObject.Request.builder()` to submit the delete request
 <2> The request is made in asynchronous way; a `Single` is returned
+
+== Object Storage Health Check
+
+If your Helidon application depends on Object Storage accessibility, you may consider setting
+up a health check to verify connectivity with an OCI bucket. To do so, first add the following
+dependency in your pom file:
+
+[source,xml]
+----
+<dependency>
+    <groupId>io.helidon.integrations.oci</groupId>
+    <artifactId>helidon-integrations-oci-objectstorage-health</artifactId>
+</dependency>
+----
+
+In order to register the new health check in Helidon SE, create an instance of `HealthSupport`
+and configure it as shown next:
+
+[source,java]
+----
+HealthSupport health = HealthSupport.builder()
+    .addLiveness(OciObjectStorageHealthCheck.builder()
+                                            .ociObjectStorage(ociObjectStorage)
+                                            .bucket(bucketName)
+                                            .namespace(namespace)
+                                            .build())
+    .build();
+----
+
+where `ociObjectStorage`, `bucketName` and `namespace` are as required for any other
+Object Storage access. Finally, include your newly created `HealthSupport` object
+as part of your application's routing:
+
+[source,java]
+----
+Routing routing = Routing.builder()
+                         .register(health)
+                         // other routes here
+                         .build();
+----
+
+When executed, this health check will _ping_ the bucket to make sure it is accessible in your
+environment. For more information about health checks see <<se/health/01_health.adoc,
+Health Checks>>.