Healthcheck

[ramonpetgrave64]

#95

Summary

Adds a healthcheck grpc service. For now, it is imported from a pre-grenerated healthcheck service and served alongside rekor-server as another grpc service on the grpc server. Kubernetes has built-in support for checking against this service.

• https://grpc.io/docs/guides/health-checking/
• https://v1-31.docs.kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-grpc-liveness-probe

Testing process

No unit tests, but can be manually tested.

start the server

docker-compose up -d

invoke the grpc health prober, to see what it reports.

./grpc_health_probe-darwin-arm64 --addr localhost:3001

status: SERVING

TODO:

• Decide whether to add another set of "healthcheck" methods to the rekor service, so that rekor also implements the "healthcheck" protocol. With this, I think we would not need to import the pre-generated service, so long as we implement the Watch and Check methods.
  • https://github.com/grpc/grpc/blob/master/doc/health-checking.md
• add a default "service config" to a client for easy consumption.
  • https://github.com/grpc/grpc-go/blob/eb744dec5da784e7e2fc140ddaa6d2aa645b5371/examples/features/health/client/main.go#L73
  • pending Add client methods #113

Release Note

Adds healthchecks.

Documentation

Adds docs about healthchecks.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 21.79%. Comparing base (c736036) to head (f2a8f8b).
Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #115      +/-   ##
==========================================
+ Coverage   21.33%   21.79%   +0.45%     
==========================================
  Files          27       27              
  Lines        1692     1716      +24     
==========================================
+ Hits          361      374      +13     
- Misses       1299     1308       +9     
- Partials       32       34       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[loosebazooka]

do we want to do this healthz thing too? https://github.com/sigstore/fulcio/blob/main/cmd/app/http.go#L74

[ramonpetgrave64]

@loosebazooka I think you're right. I have something working on another branch. I'll change this PR to use that next week.

• main...ramonpetgrave64:rekor-tiles:healthz

[loosebazooka]

Happy to do it incrementally too

[ramonpetgrave64]

redoing in #142