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

VTAdmin: Support for Workflow Actions #16816

Merged
merged 9 commits into from
Oct 15, 2024

Conversation

beingnoble03
Copy link
Member

@beingnoble03 beingnoble03 commented Sep 21, 2024

Description

This PR adds support for workflow complete, switchtraffic, reversetraffic and cancel operation from VTAdmin.

Related Issue(s)

Screenshots

Screenshot 2024-10-08 at 4 12 21 PM Screenshot 2024-09-21 at 11 12 03 PM Screenshot 2024-10-08 at 4 12 38 PM

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Sep 21, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Sep 21, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 21, 2024
@beingnoble03 beingnoble03 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTAdmin VTadmin interface and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Sep 21, 2024
Copy link

codecov bot commented Sep 21, 2024

Codecov Report

Attention: Patch coverage is 3.61446% with 80 lines in your changes missing coverage. Please review.

Project coverage is 69.36%. Comparing base (8b37c52) to head (94ab67f).
Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtadmin/http/workflows.go 0.00% 42 Missing ⚠️
go/vt/vtadmin/api.go 7.50% 37 Missing ⚠️
go/vt/vtadmin/rbac/config.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16816      +/-   ##
==========================================
- Coverage   69.41%   69.36%   -0.05%     
==========================================
  Files        1570     1570              
  Lines      203929   204053     +124     
==========================================
- Hits       141551   141544       -7     
- Misses      62378    62509     +131     

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

@vitess-bot vitess-bot modified the milestones: v21.0.0, v22.0.0 Oct 8, 2024
@beingnoble03 beingnoble03 marked this pull request as draft October 8, 2024 10:43
@beingnoble03 beingnoble03 changed the title VTAdmin: Support for MoveTables complete VTAdmin: Support for Workflow Actions Oct 8, 2024
@beingnoble03 beingnoble03 marked this pull request as ready for review October 8, 2024 10:53
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Looks good! I played around with it and it works as expected. The pop-up window on complete that presents you with the relevant options is really nice.

The only surprise is that we do not have this for Reshard too since it's otherwise roughly equivalent support-wise on main.

@@ -384,6 +386,7 @@ func (api *API) Handler() http.Handler {
router.HandleFunc("/migration/{cluster_id}/{keyspace}/launch", httpAPI.Adapt(vtadminhttp.LaunchSchemaMigration)).Name("API.LaunchSchemaMigration").Methods("PUT", "OPTIONS")
router.HandleFunc("/migration/{cluster_id}/{keyspace}/retry", httpAPI.Adapt(vtadminhttp.RetrySchemaMigration)).Name("API.RetrySchemaMigration").Methods("PUT", "OPTIONS")
router.HandleFunc("/migrations/", httpAPI.Adapt(vtadminhttp.GetSchemaMigrations)).Name("API.GetSchemaMigrations")
router.HandleFunc("/movetables/{cluster_id}/complete", httpAPI.Adapt(vtadminhttp.MoveTablesComplete)).Name("API.MoveTablesComplete")
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason we're doing movetables and not reshard? Looks like this PR branch does not appear to have the Reshard work from #16903, so that may be why. Can we add it here so that we have some uniformity? We can also do it in a follow-up if needed.

Copy link
Contributor

Choose a reason for hiding this comment

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

Same for Materialize, which we'll have shortly: #16941

Copy link
Member Author

Choose a reason for hiding this comment

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

I think complete can be done for Reshard. I can do that in a follow-up PR.

@beingnoble03
Copy link
Member Author

Updated the branch with latest changes, and tested the changes locally after the merge.

@rohit-nayak-ps rohit-nayak-ps merged commit 9414611 into vitessio:main Oct 15, 2024
101 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTAdmin VTadmin interface Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants