Add a /health endpoint which does not require authentication
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
Research direction
Start with mux.go, where the request routes and authentication behavior can be traced. Add a GET /health endpoint that does not require authentication and returns HTTP 200 when the server is healthy; verify the endpoint is reachable without credentials and suitable for a Kubernetes livenessProbe.
Written by the indexing model from the issue text.
Description
Trying to deploy restic/rest-server:0.10.0 in k8s. I want a URL endpoint that I can use for "livenessProbe" (GET, should return 200).
As far as I can see from some testing, guided by mux.go - everything returns 401 Unauthorized. At the moment, I'm using a naive tcp 'liveness' probe, which is not nearly as expressive/accurate.
It would be nice if there was a /health endpoint (or similar) which did not require authentication, and returned 200 (assuming the server was ok).
- Dominant language
- Go
- Stars
- 1.5k
- Forks
- 179
- Avg merge
- 15d 9h
- Merged PRs (30d)
- 2
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from restic/rest-server
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
restic/rest-server#389 ·
-
state: need feedback
Difficulty 3/5 1-2 days Newbie friendliness 55/100
restic/rest-server#391 · 5 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
restic/rest-server#390 · 1 comment · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
restic/rest-server#384 · 2 comments ·
-
Exit after configurable idle period for servers with limited RAM or are off/suspended when unusedOpen
Difficulty 4/5 3-5 days Newbie friendliness 50/100
restic/rest-server#383 · 2 comments ·
All issues in restic/rest-server
Similar issues
-
cvss-severity:high devguard l3montree-cybersecurity/devguard/devguard pkg:golang/github.com/l3montree-dev/devguard risk:low state:open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
l3montree-dev/devguard#3146 · 1 comment ·
Maintainers usually reply within 1 day
-
CLI
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
databricks/cli#6910 ·
Maintainers usually reply within 1 day
-
Table presenter appends a spurious ", ..." to the FIX column when all fix versions are already shownOpen
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
canonical/microceph#900 · 1 comment ·
Maintainers usually reply within 1 day
-
vulncheck or vulndb
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day