Navigation Menu

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

KubeService liveness/readiness probes #782

Closed
jefflill opened this issue Mar 22, 2020 · 1 comment
Closed

KubeService liveness/readiness probes #782

jefflill opened this issue Mar 22, 2020 · 1 comment
Assignees
Labels
breaking This is a breaking change feature New feature or request
Projects

Comments

@jefflill
Copy link
Collaborator

jefflill commented Mar 22, 2020

BREAKING: We need to enhance the KubeService to optionally write some kind of readiness file to disk that a Kubernetes probe script could examine to determine the worker health. In theory, this will have to work on all platforms (Windows, Linux, and OS/X) as well as for unit testing.

Service developers can enable this by passing the the fully qualified path to the status file as the new optional statusFilePath parameter to the KubeService constructor. By default, this will be NULL, indicating that no file should be created.

You'll need to code your health probe to examine this file. If the file doesn't exist, your probe should assume that the service hasn't been started yet. If the status file does exist, it will have one of the following text values with no line ending characters:

not-started
starting
running
unhealthy
terminated

Note that there's one related breaking change: KubeService.SetRunning() has is now async and has been renamed to SetRunningAsync(). You'll need to update your services,

@jefflill jefflill added the feature New feature or request label Mar 22, 2020
@jefflill jefflill self-assigned this Mar 22, 2020
@jefflill jefflill added the breaking This is a breaking change label Mar 22, 2020
@jefflill
Copy link
Collaborator Author

Implemented for: v2.0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking This is a breaking change feature New feature or request
Projects
No open projects
Kubernetes
Awaiting triage
Development

No branches or pull requests

1 participant