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

Extend plugin meta model to include health check endpoint #17002

Closed
amisevsk opened this issue May 25, 2020 · 6 comments
Closed

Extend plugin meta model to include health check endpoint #17002

amisevsk opened this issue May 25, 2020 · 6 comments
Labels
area/plugin-broker kind/enhancement A feature request - must adhere to the feature request template. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. severity/P1 Has a major impact to usage or development of the system.

Comments

@amisevsk
Copy link
Contributor

Is your enhancement related to a problem? Please describe.

One of the steps in workspace startup is waiting for any servers to be ready. It would be convenient if plugin specs could define an endpoint which can be pinged to check for server readiness/health.

Describe the solution you'd like

Add health check endpoints to plugin meta model. Potentially a liveness and readiness definition, parallel to what exists in Kubernetes.

Describe alternatives you've considered

Rely on communicating with a port defined for the plugin.

Additional context

The Che workspace operator needs to be able to check for server readiness before marking a workspace as 'Running', to avoid 503 errors. See PR devfile/devworkspace-operator#78 for details.

@amisevsk amisevsk added kind/enhancement A feature request - must adhere to the feature request template. area/plugin-broker labels May 25, 2020
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label May 25, 2020
@ibuziuk
Copy link
Member

ibuziuk commented May 25, 2020

I believe we have similar issues on Hosted Che when for example theia route is not yet available - redhat-developer/rh-che#1657 / #17542

@ibuziuk ibuziuk added severity/P1 Has a major impact to usage or development of the system. and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels May 25, 2020
@ibuziuk
Copy link
Member

ibuziuk commented May 25, 2020

@ericwill I put P1, but feel free to update the priority based on the team priorities

@amisevsk
Copy link
Contributor Author

Not sure which area this one actually falls under -- there's a plugin side change somewhere, but the plugin spec changes would mostly be handled by infra/plugin broker. @ibuziuk @ericwill WDYT about:

  • Step 1: add to plugin meta.yaml, etc. spec, and implement handling in wsmaster
  • Step 2: try to add support to actual plugins (machine-exec, theia, etc.)

@sleshchenko
Copy link
Member

Is it something that should be addressed in Devfile 2.x format? @l0rd @davidfestal WDYT?

@che-bot
Copy link
Contributor

che-bot commented Feb 4, 2021

Issues go stale after 180 days of inactivity. lifecycle/stale issues rot after an additional 7 days of inactivity and eventually close.

Mark the issue as fresh with /remove-lifecycle stale in a new comment.

If this issue is safe to close now please do so.

Moderators: Add lifecycle/frozen label to avoid stale mode.

@che-bot che-bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 4, 2021
@amisevsk
Copy link
Contributor Author

amisevsk commented Feb 4, 2021

I think this issue should just be closed; likely this functionality, if useful, would be implemented in devfile 2.0

@amisevsk amisevsk closed this as completed Feb 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/plugin-broker kind/enhancement A feature request - must adhere to the feature request template. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. severity/P1 Has a major impact to usage or development of the system.
Projects
None yet
Development

No branches or pull requests

4 participants