Skip to content

Add healthcheck to JupyterLab module #346

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add healthcheck to JupyterLab module #346

wants to merge 2 commits into from

Conversation

blink-so[bot]
Copy link
Contributor

@blink-so blink-so bot commented Aug 20, 2025 •
edited
Loading

Adds /api/status healthcheck to the JupyterLab module to prevent the app from showing as ready before JupyterLab server is fully started and responding.

Changes

  • Added healthcheck block to coder_app resource
  • Uses JupyterLab's built-in /api/status endpoint
  • 5-second interval with 6 successful checks required (30 seconds total)
  • Handles both subdomain true and false cases

Testing

Use this module in your template:

module "jupyterlab" {
  source   = "git::https://github.com/coder/registry.git//registry/coder/modules/jupyterlab?ref=blink/jupyterlab-healthcheck"
  agent_id = coder_agent.main.id
}

Fixes #345

@blink-so
Add healthcheck to JupyterLab module
d52af54 
Adds /api/status healthcheck to prevent the app from showing as ready
before JupyterLab server is fully started and responding.

Fixes: #345
matifali
matifali reviewed Aug 20, 2025
View reviewed changes
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

Suggested a few things. Also snippet should be as in how to use the module a copy pastable block with source set to the correct git path and branch.

registry/coder/modules/jupyterlab/main.tf Outdated
Comment on lines 83 to 85
# Healthcheck ensures JupyterLab is fully ready before showing as available
# Test with: git clone https://github.com/coder/registry.git && cd registry/registry/coder/modules/jupyterlab
# Then use this module in a template to verify the app only appears when JupyterLab is responding
Copy link
Member

Choose a reason for hiding this comment

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

Remove the comment.

registry/coder/modules/jupyterlab/main.tf Outdated
# Test with: git clone https://github.com/coder/registry.git && cd registry/registry/coder/modules/jupyterlab
# Then use this module in a template to verify the app only appears when JupyterLab is responding
healthcheck {
url = "http://localhost:${var.port}/api/status"
Copy link
Member

Choose a reason for hiding this comment

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

This should handle both subdomain true and false case.

@matifali matifali self-assigned this Aug 20, 2025
@blink-so
Address review feedback
7979582 
- Remove testing comment as requested
- Update healthcheck URL to handle both subdomain true/false cases
- Match the same URL pattern as the main app URL
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matifali matifali matifali left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@matifali matifali

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

JupyterLab module does not include app health checks, therefore shows up too early
1 participant
@matifali