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(API): Add workflow start/stop endpoint #16658

Merged
merged 1 commit into from
Aug 27, 2024
Merged

Conversation

beingnoble03
Copy link
Member

@beingnoble03 beingnoble03 commented Aug 27, 2024

Description

This PR adds start and stop VReplication workflow endpoints in the VTAdmin-API. These are to be further used in VTAdmin-Web.

Related Issue(s)

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 Aug 27, 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 Aug 27, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Aug 27, 2024
Copy link

codecov bot commented Aug 27, 2024

Codecov Report

Attention: Patch coverage is 3.12500% with 62 lines in your changes missing coverage. Please review.

Project coverage is 68.90%. Comparing base (a54d5ec) to head (da45f9e).
Report is 5 commits behind head on main.

Files Patch % Lines
go/vt/vtadmin/api.go 4.16% 46 Missing ⚠️
go/vt/vtadmin/http/workflows.go 0.00% 16 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16658      +/-   ##
==========================================
- Coverage   68.93%   68.90%   -0.04%     
==========================================
  Files        1562     1562              
  Lines      200767   200831      +64     
==========================================
- Hits       138407   138376      -31     
- Misses      62360    62455      +95     

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

@rohit-nayak-ps rohit-nayak-ps 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 Aug 27, 2024
@beingnoble03 beingnoble03 marked this pull request as ready for review August 27, 2024 12:19
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.

Nice work, @beingnoble03 ! I only had one small request about the span name. If you can change that — unless I'm missing something and you or @rohit-nayak-ps disagree — then I'll go ahead and merge it.

Thanks!

@@ -1687,6 +1693,73 @@ func (api *API) GetWorkflowStatus(ctx context.Context, req *vtadminpb.GetWorkflo
})
}

// StartWorkflow is part of the vtadminpb.VTAdminServer interface.
func (api *API) StartWorkflow(ctx context.Context, req *vtadminpb.StartWorkflowRequest) (*vtctldatapb.WorkflowUpdateResponse, error) {
span, ctx := trace.NewSpan(ctx, "API.WorkflowUpdate")
Copy link
Contributor

@mattlord mattlord Aug 27, 2024

Choose a reason for hiding this comment

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

We should use the API call name for the trace span here and for stop as well. WorkflowUpdate has its own trace span. Then the action for the span is also obvious (now it's not clear what we're updating in the span info).

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh! Thanks for noticing. I forgot to change here.

@rohit-nayak-ps rohit-nayak-ps merged commit 639b1de into main Aug 27, 2024
226 of 227 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the start-workflow branch August 27, 2024 16:54
venkatraju pushed a commit to slackhq/vitess that referenced this pull request Aug 29, 2024
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.

3 participants