Deuxfleurs/garage
41
56
Fork 73
Code Issues 99 Pull requests 14 Releases 30 Wiki Activity

Implement /health admin API endpoint to check node health #440

Merged
lx merged 5 commits from admin-health-api into main 2022-12-11 17:25:29 +00:00
Conversation 1 Commits 5 Files changed 9 +833 -10
lx commented 2022-12-05 14:05:22 +00:00
Owner
Copy link

Endpoint returns 200 OK if there is a quorum for all storage partitions, or 503 Service unavailable if quorum is not attained for some partitions.

Endpoint is available as two variants:

  • /health: non-authenticated, minimal for use with e.g. automated Consul health checks, returns a status code and a small text message that describes the situation
  • /v0/health: full JSON API, returns a JSON object with some interesting numeric values on number of available nodes, partitions with quorum, etc.

TODO: update specification of the JSON API

Fix #418

Endpoint returns 200 OK if there is a quorum for all storage partitions, or 503 Service unavailable if quorum is not attained for some partitions. Endpoint is available as two variants: - `/health`: non-authenticated, minimal for use with e.g. automated Consul health checks, returns a status code and a small text message that describes the situation - `/v0/health`: full JSON API, returns a JSON object with some interesting numeric values on number of available nodes, partitions with quorum, etc. TODO: update specification of the JSON API Fix #418
lx added 1 commit 2022-12-05 14:05:23 +00:00
Implement /health admin API endpoint to check node health
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details
2065f011ca
lx added 1 commit 2022-12-05 14:29:16 +00:00
Refactor health check and add ability to return it in json
All checks were successful
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is passing
Details
280d1be7b1
lx added 1 commit 2022-12-05 14:38:52 +00:00
Separate /health (simple text answer) and /v0/health (full json answer, authenticated)
All checks were successful
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is passing
Details
d7868c48a4
lx changed title from WIP: Implement /health admin API endpoint to check node health to Implement /health admin API endpoint to check node health 2022-12-05 16:22:51 +00:00
lx changed title from Implement /health admin API endpoint to check node health to WIP: Implement /health admin API endpoint to check node health 2022-12-05 16:23:01 +00:00
lx added 1 commit 2022-12-11 17:11:45 +00:00
Always return 200 OK on /v0/health, reinstate admin api doc as draft and complete it
All checks were successful
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is passing
Details
5ea5fd2130
lx added 1 commit 2022-12-11 17:17:17 +00:00
simplify
All checks were successful
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is passing
Details
533afcf4e1
lx commented 2022-12-11 17:20:11 +00:00
Author
Owner
Copy link

I have not completed doc/api/garage-admin-v0.yml but I wrote a small section explaining the new endpoints in the markdown file for the admin API. That'll have to do for now.

I have not completed `doc/api/garage-admin-v0.yml` but I wrote a small section explaining the new endpoints in the markdown file for the admin API. That'll have to do for now.
lx changed title from WIP: Implement /health admin API endpoint to check node health to Implement /health admin API endpoint to check node health 2022-12-11 17:20:13 +00:00
lx merged commit defd7d9e63 into main 2022-12-11 17:25:29 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
action
check-aws
The behaviour should be checked against AWS S3

  
action
discussion-needed
We need to discuss if the feature is desirable and/or better specify the envisioned behavior or technical implementation

  
action
for-external-contributors
Core team does not plan working on this in the near future however an external contribution will be reviewed & merged

  
action
for-newcomers
An issue that should be newcomer friendly.

  
action
more-info-needed
More information is needed to investigate this issue

  
action
need-funding
This issue represents lots of work, we need to find money to pay our core team work

  
action
triage-required
It's not very clear what we want to do with this issue yet, more thoughts is required

  
kind
correctness
Issues of theoretical correctness that may impact edge-case scenarios

  
kind
ideas
For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  
kind
improvement
Feature requests that do not fall in other categories

  
kind
performance
Deceptive performance observed OR idea to improve performances

  
kind
testing
Functional tests, integration tests, Jepsen, etc.

  
kind
usability
Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

  
kind
wrong-behavior
Unintended behavior

  
prio
critical
Could impact integrity or availability of production clusters

  
prio
low
For issues that we don't want to spend time on until made absolutely necessary

  
scope
admin-api
Issues concerning the administration API

  
scope
background-healing
Background healing covers repair tasks, anti-entropy, merkle trees, etc. ; everything related to replicating data appropriately.

  
scope
build
Issues with Nix, Drone, Rust Compiler, etc.

  
scope
documentation

  
scope
k8s
Kubernetes related, including Helm Charts

  
scope
layout
Linked to the cluster layout and storage management

  
scope
metadata
Metadata Engine (LMDB, sqlite, etc.)

  
scope
ops
Operations related to operations/maintenance issue, tooling related (like CLI missing info ; impossible, too dangerous, too complicated migration, etc.)

  
scope
rpc
Linked to RPC

  
scope
s3-api
Related to the S3 API (especially compatibility issues).

  
scope
security
Cryptography-related, auth-related, authorization-related issues

  
scope
telemetry
OpenTelemetry (traces, metrics, etc.)

No labels
action
check-aws
action
discussion-needed
action
for-external-contributors
action
for-newcomers
action
more-info-needed
action
need-funding
action
triage-required
kind
correctness
kind
ideas
kind
improvement
kind
performance
kind
testing
kind
usability
kind
wrong-behavior
prio
critical
prio
low
scope
admin-api
scope
background-healing
scope
build
scope
documentation
scope
k8s
scope
layout
scope
metadata
scope
ops
scope
rpc
scope
s3-api
scope
security
scope
telemetry
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#440
No description provided.
Delete branch "admin-health-api"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?