Skip to content

Commit

Permalink
documentation for probes
Browse files Browse the repository at this point in the history
Signed-off-by: Kavindu Dodanduwa <[email protected]>
  • Loading branch information
Kavindu-Dodan committed Mar 7, 2023
1 parent ffea86f commit 7f5e4cf
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/other_resources/high_level_architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,22 @@ flag configurations watched by the respective implementation. For example, the f
The update provided by sync implementation is pushed to the evaluator engine, which interprets the event and forwards it to the state store. Change notifications generated in the
process gets pushed to event subscribers.

<img src="../images/of-flagd-1.png" width="560">
<img src="../images/of-flagd-1.png" width="560">

## Readiness & Liveness probes

Flagd exposes HTTP liveness and readiness probes. These probes can be used for K8s deployments. With default
start-up configurations, these probes are exposed at the following URLs,

- Liveness: http://localhost:8014/healthz
- Readiness: http://localhost:8014/readyz

### Definition of Liveness

The liveness probe becomes active and HTTP 200 status is served as soon as Flagd service is up and running.

### Definition of Readiness

The readiness probe becomes active similar to the liveness probe as soon as Flagd service is up and running. However,
the probe emits HTTP 412 until all sync providers are ready. This status changes to HTTP 200 when all sync providers at
least have one successful data sync. The status does not change from there on.

0 comments on commit 7f5e4cf

Please sign in to comment.