Integration with Kubernetes

nevisMeta implements two management endpoints that can be used to integrate with Kubernetes. One of the endpoints provides liveness information and the other readiness information. Check the Kubernetes documentation for more information regarding how to configure the liveness and readiness probes.

The Kubernetes integration is only supported by the standalone deployment of nevisMeta using nevisAdmin.

Readiness Endpoint

The readiness endpoint informs whether the server is ready to properly handle requests. The readiness endpoint is accessible through the server port, which you configure with the property management.server.port as described in the chapter Deployment types.

The following table describes the HTTP API of the readiness endpoint:

Readiness Endpoint
Default URL	https://hostname:9000/health
Request HTTP method	GET
Response content-type	application/json;charset=utf-8
Response body if nevisMeta is ready	{ "status" : "UP" }
HTTP status code if nevisMeta is ready	200 (OK)
Response body if nevisMeta is not ready	{ "status" : "DOWN" }
HTTP status code if nevisMeta is not ready	503 (Service Unavailable)

Liveness Endpoint

The liveness endpoint informs whether the server is up and running. The server might be up and running but not ready to properly handle requests (for instance because of a misconfiguration). The liveness endpoint is accessible through the management port, which you configure with the property management.server.port as described in the chapter "Deployment types". Currently only HTTP is supported.

The following table describes the HTTP API of the liveness endpoint:

| Liveness Endpoint | | | --- | | | Default URL | https://hostname:9000/liveness | | Response content-type | application/json;charset=utf-8 | | Response body if nevisMeta is alive | { "status" : "UP" } | | Request HTTP method | GET | | HTTP status code if nevisMeta is alive | 200 (OK) |