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

Adds Health gRPC Server and Refactor Main() #148

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

danehans
Copy link
Contributor

@danehans danehans commented Jan 4, 2025

Adds a health gRPC Server and refactors main() for better lifecycle management:

  • Introduced a health gRPC server to handle liveness and readiness probes.
  • Refactored main() to manage server goroutines using sync.WaitGroup.
  • Added graceful shutdown for servers and controller manager.
  • Improved logging consistency and ensured datastore readiness checks.

Fixes #96

…ement

- Introduced a health gRPC server to handle liveness and readiness probes.
- Refactored main() to manage server goroutines using sync.WaitGroup.
- Added graceful shutdown for servers and controller manager.
- Improved logging consistency and ensured datastore readiness checks.

Signed-off-by: Daneyon Hansen <[email protected]>
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: danehans
Once this PR has been reviewed and has the lgtm label, please assign ahg-g for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested a review from ahg-g January 4, 2025 01:02
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 4, 2025
@k8s-ci-robot k8s-ci-robot requested a review from kfswain January 4, 2025 01:02
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 4, 2025
@kfswain
Copy link
Collaborator

kfswain commented Jan 6, 2025

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 6, 2025
}
ready = true
return false
})
Copy link
Contributor

Choose a reason for hiding this comment

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

At startup, I think we want to ensure that the extension did a sync with the api server and fetched the models, but not declare itself ready only if at least one model is defined.


datastore := backend.NewK8sDataStore()
// Error channel to handle server errors
errChan := make(chan error, 5)
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a comment why we chose 5 and in what case we may need to adjust it? also, wouldn't one be enough since receiving any error is sufficient to shutdown?

if err := extSvr.Serve(lis); err != nil && err != grpc.ErrServerStopped {
errChan <- fmt.Errorf("ext-proc server failed: %w", err)
}
klog.Infof("Ext-proc server serving on port: %d", *grpcPort)
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto: This log line could be moved up right before the call to the Serve func, and here we want to have a message indicating that the server is exiting.


if err := extSvr.Serve(lis); err != nil && err != grpc.ErrServerStopped {
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add a comment clarifying that this is blocking and will return when shutting down.

if err := healthSvr.Serve(healthLis); err != nil && err != grpc.ErrServerStopped {
errChan <- fmt.Errorf("health server failed: %w", err)
}
klog.Infof("Health server serving on port: %d", *grpcHealthPort)
Copy link
Contributor

Choose a reason for hiding this comment

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

This log line could be moved up right before the call to the Serve func, and here we want to have a message indicating that the server is exiting.

}

errChan := make(chan error)
// Start the controller manager
wg.Add(1)
Copy link
Contributor

Choose a reason for hiding this comment

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

can we encapsulate each goroutine in a function prefixed with Start?

  • StartSignalHandler
  • StartHealthServer
  • StartExternalProcessorServer

}
klog.Info("controller manager started")
Copy link
Contributor

Choose a reason for hiding this comment

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

At this point the serve is actually exiting not starting, can we please correct the log line?

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 7, 2025
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a liveness/readiness endpoint to the extension
4 participants