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

[proxy] Add /api/health 200 #18917

Merged
merged 2 commits into from
Oct 13, 2023
Merged

[proxy] Add /api/health 200 #18917

merged 2 commits into from
Oct 13, 2023

Conversation

easyCZ
Copy link
Member

@easyCZ easyCZ commented Oct 12, 2023

Description

Such that a chained NLB can use the proxy's /api/health to determine the target's health. Currently /api/version is used but that endpoint can change, and we'd break the NLBs

Summary generated by Copilot

🤖 Generated by Copilot at c5d70f7

Add health check endpoint for proxy component. This allows external tools to verify that the proxy service is up and running by querying /healthz in the Caddyfile.

Related Issue(s)

Fixes #

How to test

Preview, route to /api/health and get a 200

Documentation

Preview status

Gitpod was successfully deployed to your preview environment.

Build Options

Build
  • /werft with-werft
    Run the build with werft instead of GHA
  • leeway-no-cache
  • /werft no-test
    Run Leeway with --dont-test
Publish
  • /werft publish-to-npm
  • /werft publish-to-jb-marketplace
Installer
  • analytics=segment
  • with-dedicated-emulation
  • workspace-feature-flags
    Add desired feature flags to the end of the line above, space separated
Preview Environment / Integration Tests
  • /werft with-local-preview
    If enabled this will build install/preview
  • /werft with-preview
  • /werft with-large-vm
  • /werft with-gce-vm
    If enabled this will create the environment on GCE infra
  • with-integration-tests=all
    Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh. If enabled, with-preview and with-large-vm will be enabled.
  • with-monitoring

/hold

Copy link
Member

@geropl geropl left a comment

Choose a reason for hiding this comment

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

✔️

@@ -195,6 +195,10 @@ https://{$GITPOD_DOMAIN} {
import ssl_configuration
import security_headers

handle /api/health {
Copy link
Member

Choose a reason for hiding this comment

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

Adding a comment/link/references as to why this is here would be 🧡

@easyCZ
Copy link
Member Author

easyCZ commented Oct 13, 2023

/unhold

@roboquat roboquat merged commit 547b8b3 into main Oct 13, 2023
14 checks passed
@roboquat roboquat deleted the mp/api-health-200 branch October 13, 2023 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants