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.

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

feat: introduce health checks for Numaflow CRDs #20297

Merged
merged 1 commit into from
Oct 9, 2024
Merged

feat: introduce health checks for Numaflow CRDs #20297

merged 1 commit into from
Oct 9, 2024

Conversation

dpadhiar
Copy link
Member

@dpadhiar dpadhiar commented Oct 8, 2024

Fixes numaproj/numaflow#1739

Adding health checks for all Numaflow CRDs including:

  • Pipeline
  • Vertex
  • InterStepBufferService
  • MonoVertex

These are similar to the already implemented health checks for Numaplane rollouts.

Numaflow resources should also have their own health checks in the case that a user is not using Numaplane to deploy Numaflow to their environment.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

@dpadhiar
feat: introduce health checks for Numaflow CRDs
b59925a 
Signed-off-by: Dillen Padhiar <dillen_padhiar@intuit.com>
@bunnyshell Bunnyshell
Copy link

bunnyshell bot commented Oct 8, 2024 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

@codecov Codecov
Copy link

codecov bot commented Oct 8, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.81%. Comparing base (dc27102) to head (b59925a).
Report is 11 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #20297      +/-   ##
==========================================
+ Coverage   55.98%   56.81%   +0.83%     
==========================================
  Files         322      322              
  Lines       44701    45694     +993     
==========================================
+ Hits        25024    25963     +939     
+ Misses      17080    17079       -1     
- Partials     2597     2652      +55

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@crenshaw-dev
Copy link
Member

@CodiumAI-Agent /review

@crenshaw-dev crenshaw-dev reopened this Oct 9, 2024
@bunnyshell Bunnyshell
Copy link

bunnyshell bot commented Oct 9, 2024 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

@crenshaw-dev
Copy link
Member

Sorry, wrong button :-P

@CodiumAI-Agent
Copy link

CodiumAI-Agent commented Oct 9, 2024 •
edited
Loading

PR Reviewer Guide 🔍

(Review updated until commit b59925a)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 PR contains tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Code Redundancy
The condition checks for health status are repeated across different health.lua files for various resources. Consider abstracting common logic into a utility function to reduce redundancy and improve maintainability.

Code Redundancy
Similar to other health.lua scripts, there is repeated logic for health status checks. Abstracting this into a shared utility could simplify updates and maintenance.

Code Redundancy
The health check script for Pipeline contains redundant condition checks similar to other resources. Consider using a shared utility function to handle these checks.

Code Redundancy
The health check script for Vertex repeats similar logic found in other health.lua scripts. Refactoring to use a common utility function could be beneficial.

crenshaw-dev
crenshaw-dev approved these changes Oct 9, 2024
View reviewed changes
Copy link
Member

@crenshaw-dev crenshaw-dev left a comment

Choose a reason for hiding this comment

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

lgtm!

@dpadhiar dpadhiar marked this pull request as ready for review October 9, 2024 16:10
@dpadhiar dpadhiar requested a review from a team as a code owner October 9, 2024 16:10
@crenshaw-dev crenshaw-dev enabled auto-merge (squash) October 9, 2024 16:28
@crenshaw-dev crenshaw-dev merged commit 82484ce into argoproj:master Oct 9, 2024
48 checks passed
@CodiumAI-Agent
Copy link

Persistent review updated to latest commit b59925a

@dpadhiar
Copy link
Member Author

dpadhiar commented Oct 9, 2024

@crenshaw-dev Hey Michael, gonna do a quick follow up to this PR - just need to make the conditions checks more generic since we may change the condition names in the future so it would be best to not hardcode the names. Should be up soon.

@crenshaw-dev
Copy link
Member

@dpadhiar sounds good, will review ASAP once it's up.

@dpadhiar dpadhiar mentioned this pull request Oct 9, 2024
Merged
14 tasks
ali-hamza-noor pushed a commit to ali-hamza-noor/argo-cd that referenced this pull request Oct 10, 2024
@dpadhiar @ali-hamza-noor
feat: introduce health checks for Numaflow CRDs (argoproj#20297)
370bb51 
Signed-off-by: Dillen Padhiar <dillen_padhiar@intuit.com>
Signed-off-by: alnoor <alihamzanoor99@gmail.com>
austin5219 pushed a commit to austin5219/argo-cd that referenced this pull request Oct 16, 2024
@dpadhiar @austin5219
feat: introduce health checks for Numaflow CRDs (argoproj#20297)
56b46d5 
Signed-off-by: Dillen Padhiar <dillen_padhiar@intuit.com>
Signed-off-by: austin5219 <3936059+austin5219@users.noreply.github.com>
adriananeci pushed a commit to adriananeci/argo-cd that referenced this pull request Dec 4, 2024
@dpadhiar @adriananeci
feat: introduce health checks for Numaflow CRDs (argoproj#20297)
8f690dd 
Signed-off-by: Dillen Padhiar <dillen_padhiar@intuit.com>
Signed-off-by: Adrian Aneci <aneci@adobe.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crenshaw-dev crenshaw-dev crenshaw-dev approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Define custom health check for Numaflow resources in Argo CD
3 participants
@dpadhiar @crenshaw-dev @CodiumAI-Agent