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

feat(server): add a health check route before auth #531

Merged
merged 2 commits into from
Jan 13, 2021

Conversation

ddunkin
Copy link
Contributor

@ddunkin ddunkin commented Jan 12, 2021

Google Kubernetes Engine default ingress requires a health check route that returns a 200 response. If basic authentication is enabled, there is no route that can be used for a health check. This PR adds a /healthz route before the auth middleware to be used for health checks.

@patrickhulce
Copy link
Collaborator

thanks @ddunkin! where does /healthz come from? :)

  • /ping
  • /health
  • /status

All come to mind as options, but if the z has significance I don't know of, happy to leave as-is :)

@ddunkin
Copy link
Contributor Author

ddunkin commented Jan 12, 2021

/healthz is a common convention because it's used in a lot of examples, at least in Kubernetes and Google Cloud. I don't think there's a significance to the z; the story I've heard is that long ago some Google internal service needed a health check and /health conflicted with an existing endpoint, so they tacked a z on the end and it stuck.

@patrickhulce
Copy link
Collaborator

cool, works for me then! a test that this new endpoint works would be much appreciated and we're good to merge :)

Copy link
Collaborator

@patrickhulce patrickhulce left a comment

Choose a reason for hiding this comment

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

thanks!

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.

2 participants