Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add HTTP and GRPC health check endpoints #1258

Merged
merged 6 commits into from Jul 8, 2023

Conversation

bobcallaway
Copy link
Member

@bobcallaway bobcallaway commented Jul 4, 2023

Summary

This adds both HTTP and gRPC health check endpoints to Fulcio.

HTTP: /healthz should return HTTP 200 OK
gRPC: implements gRPC Health Checking Protocol

This also adds coverage for this via K8S local testing using readiness and liveness probes in cluster.

Release Note

  • HTTP and gRPC health check endpoints are now exposed from Fulcio

Documentation

  • update docs.sigstore.dev to denote this feature

Signed-off-by: Bob Callaway <bcallaway@google.com>
cmd/app/http.go Dismissed Show dismissed Hide dismissed
@codecov
Copy link

codecov bot commented Jul 4, 2023

Codecov Report

Merging #1258 (827ebb9) into main (a5b774d) will increase coverage by 0.18%.
The diff coverage is 57.69%.

@@            Coverage Diff             @@
##             main    #1258      +/-   ##
==========================================
+ Coverage   56.07%   56.25%   +0.18%     
==========================================
  Files          50       50              
  Lines        2921     2940      +19     
==========================================
+ Hits         1638     1654      +16     
- Misses       1138     1140       +2     
- Partials      145      146       +1     
Impacted Files Coverage Δ
cmd/app/http.go 51.35% <46.15%> (-2.62%) ⬇️
pkg/server/grpc_server.go 50.55% <55.55%> (-1.15%) ⬇️
cmd/app/grpc.go 47.82% <100.00%> (+1.88%) ⬆️

... and 2 files with indirect coverage changes

Signed-off-by: Bob Callaway <bcallaway@google.com>
Signed-off-by: Bob Callaway <bcallaway@google.com>
…e grpc

Signed-off-by: Bob Callaway <bcallaway@google.com>
Signed-off-by: Bob Callaway <bcallaway@google.com>
Signed-off-by: Bob Callaway <bcallaway@google.com>
Copy link
Contributor

@haydentherapper haydentherapper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any tests for this new endpoint? Would be ideal to see both HTTP and gRPC.

@bobcallaway
Copy link
Member Author

Any tests for this new endpoint? Would be ideal to see both HTTP and gRPC.

The addition in deployment.yaml gets us coverage on both as part of the k8s tests.

@bobcallaway bobcallaway merged commit 1923fa1 into sigstore:main Jul 8, 2023
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants