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

feat: add force promote actions for Numaplane rollouts #22141

Draft
wants to merge 17 commits into
base: master
Choose a base branch
from

Conversation

dpadhiar
Copy link
Member

@dpadhiar dpadhiar commented Mar 3, 2025

Adding custom action to enable and disable full promote feature for Numaplane rollouts during a Progressive upgrade.

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).

Copy link

bunnyshell bot commented Mar 3, 2025

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

dpadhiar and others added 4 commits March 3, 2025 14:51
Copy link

codecov bot commented Mar 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.82%. Comparing base (9d66e89) to head (4c102e6).

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #22141      +/-   ##
==========================================
+ Coverage   55.74%   55.82%   +0.08%     
==========================================
  Files         342      342              
  Lines       57213    57213              
==========================================
+ Hits        31893    31939      +46     
+ Misses      22678    22638      -40     
+ Partials     2642     2636       -6     

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

@dpadhiar dpadhiar marked this pull request as ready for review March 4, 2025 22:14
@dpadhiar dpadhiar requested review from a team as code owners March 4, 2025 22:14
@juliev0
Copy link
Contributor

juliev0 commented Mar 4, 2025

LGTM

@@ -0,0 +1,7 @@
actionTests:
- action: enable-full-promote
Copy link
Member

Choose a reason for hiding this comment

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

Is this analogous to Argo Rollouts' "promote-full" feature? If so, would it be a good idea to standardize on that naming?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @crenshaw-dev - I see Argo Rollouts has one action called "promote-full"?

One thing I wanted to make clear with how we're handling this is that it's a label that can be applied and removed. That it's not just a one time thing you're doing. If you "enable" it, then you're setting it that way going forward. (and generally, the user should be expected to remove it themselves)

Copy link
Contributor

Choose a reason for hiding this comment

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

Note we made the decision that the Controller would not remove the label after performing the action because that would mean that the Controller was changing something other than Finalizer and Status, which is apparently a best practice.

Copy link
Contributor

Choose a reason for hiding this comment

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

I actually have to admit I like "Enable Force Promote" and "Disable Force Promote" over what we have now, but "full" is more similar to the language of Argo Rollouts. I guess probably one difference between us and Argo Rollouts is that they have a promote which is "full" and one that is "partial" I believe. That's why the "Full" language makes sense for them. We don't have that.

Copy link
Member

Choose a reason for hiding this comment

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

If there are solid reasons to use different language (and it seems like there are), I'd change the language. "Enable Force Promote" and "Disable Force Promote" make a lot of sense to me.

Copy link
Member

Choose a reason for hiding this comment

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

Aside: if it's truly a declarative feature, maybe it belongs in the spec instead of on a label?

Comment on lines 2 to 3
actions["enable-full-promote"] = {["disabled"] = true}
actions["disable-full-promote"] = {["disabled"] = true}
Copy link
Member

Choose a reason for hiding this comment

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

Consider setting a custom display name and icon for the actions: #22202

Copy link
Contributor

Choose a reason for hiding this comment

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

Is there an icon that Argo Rollouts is using that we should consider using as well?

Copy link
Contributor

Choose a reason for hiding this comment

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

If not, we may want to do the icon as an enhancement later instead of right now.

@dpadhiar dpadhiar marked this pull request as draft March 5, 2025 22:16
@dpadhiar dpadhiar changed the title feat: add full-promote actions for Numaplane rollouts feat: add force promote actions for Numaplane rollouts Mar 7, 2025
@dpadhiar dpadhiar requested a review from crenshaw-dev March 7, 2025 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants