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

[vtcombo] Expose --tablet_types_to_wait flag #14951

Merged
merged 1 commit into from
Feb 20, 2024

Conversation

arthurschreiber
Copy link
Contributor

@arthurschreiber arthurschreiber commented Jan 15, 2024

Description

At GitHub, we use vtcombo in our CI system and our local development environments.

While investigating slow CI setup times, I noticed that vtcombo by default is starting 3 tablets (PRIMARY, RDONLY and REPLICA) per keyspace/cell. For a small topology, that's not really an issue, but we run multiple hundreds of keyspaces in CI, and just starting this setup takes almost a minute.

This is quite wasteful, especially because we don't use RDONLY and REPLICA tablets at all in CI or local development. To improve this, we can set replicaCount to 1 to only start a single REPLICA tablet (which will be promoted to primary), and rdonlyCount to -1 to start no RDONLY tablets.

Unfortunately, vtcombo will start vtgate and instruct it to wait for PRIMARY,REPLICA,RDONLY tablets to be available, which, based on the above configuration, won't ever happen. Eventually, the vtgate will run into a timeout while waiting and then start serving requests anyway.

Exposing the tablet_types_to_wait CLI flag allows setting the flag to e.g. PRIMARY only, which brings down the startup time for vtcombo to ~20 seconds in our setup, which is quite an improvement.

Related Issue(s)

N/A

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 Jan 15, 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 Jan 15, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 15, 2024
@arthurschreiber arthurschreiber force-pushed the arthur/upstream-vtcombo-tablet-type-counts branch from c6831db to b91ee0f Compare January 15, 2024 12:48
Copy link

codecov bot commented Jan 15, 2024

Codecov Report

Attention: 11 lines in your changes are missing coverage. Please review.

Comparison is base (696fe0e) 67.41% compared to head (de43b28) 67.48%.
Report is 28 commits behind head on main.

Files Patch % Lines
go/cmd/vtcombo/cli/main.go 0.00% 11 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14951      +/-   ##
==========================================
+ Coverage   67.41%   67.48%   +0.06%     
==========================================
  Files        1560     1561       +1     
  Lines      192752   193343     +591     
==========================================
+ Hits       129952   130485     +533     
- Misses      62800    62858      +58     

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

@arthurschreiber arthurschreiber removed 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 NeedsWebsiteDocsUpdate What it says labels Jan 18, 2024
Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

Rest LGTM, but I don't think we should change the definition of replica count wherein it includes the primary tablet as well.

@frouioui frouioui added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTCombo labels Jan 29, 2024
@frouioui frouioui modified the milestones: v19.0.0, v20.0.0 Feb 6, 2024
@arthurschreiber arthurschreiber changed the title [vtcombo] Give better control over tablet types [vtcombo] Expose --tablet_types_to_wait flag Feb 19, 2024
@arthurschreiber arthurschreiber force-pushed the arthur/upstream-vtcombo-tablet-type-counts branch from 577ac6f to fb528bb Compare February 19, 2024 09:54
Signed-off-by: Arthur Schreiber <arthurschreiber@github.com>
@arthurschreiber arthurschreiber force-pushed the arthur/upstream-vtcombo-tablet-type-counts branch from fb528bb to de43b28 Compare February 19, 2024 10:26
@arthurschreiber
Copy link
Contributor Author

I changed this to not change how replicaCount and rdonlyCount are treated - I believe the change to expose --tablet_types_to_wait is all I need. 👍

@frouioui frouioui removed the NeedsIssue A linked issue is missing for this Pull Request label Feb 20, 2024
@frouioui
Copy link
Member

I removed the NeedsIssue label as I think the PR description is pretty self-explanatory

@frouioui frouioui merged commit b3a2c99 into main Feb 20, 2024
199 of 200 checks passed
@frouioui frouioui deleted the arthur/upstream-vtcombo-tablet-type-counts branch February 20, 2024 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTCombo Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants