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

Add ChangeTabletTags RPC to vtctl, ChangeTags RPC to vttablet #16857

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Sep 27, 2024

Description

As discussed in #16377, this PR implements a new vtctld and corresponding vttablet RPC to allow the tags of a tablet to be changed

  • VTCtld RPC: ChangeTabletTags
  • VTTablet RPC: ChangeTags

The new RPC supports both replacing and merging the existing tags. This merging happens on the tablet under a lock

CLI

tim@Tims-MacBook-Pro vitess % ./bin/vtctldclient ChangeTabletTags --help 2>&1 | head       
Changes the tablet tags for the specified tablet, if possible.

Tags must be specified as key=value pairs.

Usage:
  vtctldclient ChangeTabletTags <alias> <tablet-tag> [ <tablet-tag> ... ]

Flags:
  -h, --help      help for ChangeTabletTags
  -r, --replace   Replace all tablet tags with the tags provided. By default tags are merged/updated.

Related Issue(s)

#16377

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

@timvaillancourt timvaillancourt added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: vtctl Component: VTTablet labels Sep 27, 2024
@timvaillancourt timvaillancourt self-assigned this Sep 27, 2024
Copy link
Contributor

vitess-bot bot commented Sep 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 Sep 27, 2024
@timvaillancourt timvaillancourt removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Sep 27, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 27, 2024
Copy link

codecov bot commented Sep 27, 2024

Codecov Report

Attention: Patch coverage is 38.31169% with 95 lines in your changes missing coverage. Please review.

Project coverage is 69.42%. Comparing base (2e2b223) to head (9a739f4).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
go/cmd/vtctldclient/command/tablets.go 9.52% 19 Missing ⚠️
go/vt/vttablet/tabletmanager/rpc_actions.go 0.00% 15 Missing ⚠️
go/vt/vttablet/grpctmclient/client.go 0.00% 12 Missing ⚠️
go/vt/vttablet/tmrpctest/test_tm_rpc.go 0.00% 12 Missing ⚠️
go/vt/vttablet/grpctmserver/server.go 0.00% 7 Missing ⚠️
go/vt/vttablet/tabletmanager/tm_state.go 0.00% 7 Missing ⚠️
...t/vtctl/grpcvtctldserver/testutil/test_tmclient.go 53.84% 6 Missing ⚠️
go/vt/vtcombo/tablet_map.go 0.00% 5 Missing ⚠️
go/vt/vtctl/grpcvtctldclient/client_gen.go 0.00% 4 Missing ⚠️
go/vt/topotools/tablet.go 84.21% 3 Missing ⚠️
... and 3 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16857      +/-   ##
==========================================
- Coverage   69.43%   69.42%   -0.02%     
==========================================
  Files        1571     1571              
  Lines      203021   203238     +217     
==========================================
+ Hits       140970   141093     +123     
- Misses      62051    62145      +94     

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

@timvaillancourt timvaillancourt force-pushed the changeTabletTagsRPC branch 2 times, most recently from edd1cb9 to c6d7eca Compare September 27, 2024 20:17
Signed-off-by: Tim Vaillancourt <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: vtctl Component: VTTablet NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant