Skip to content

Add EXPERIMENTAL tablet type to vtgate serving path#20115

Open
ejortegau wants to merge 1 commit into
vitessio:mainfrom
ejortegau:ejortegau/experimental-tablets-serve
Open

Add EXPERIMENTAL tablet type to vtgate serving path#20115
ejortegau wants to merge 1 commit into
vitessio:mainfrom
ejortegau:ejortegau/experimental-tablets-serve

Conversation

@ejortegau
Copy link
Copy Markdown
Contributor

@ejortegau ejortegau commented May 15, 2026

Description

The EXPERIMENTAL tablet type was never included in vtgate's serving path, making it impossible to route queries to EXPERIMENTAL tablets through vtgate. This PR adds EXPERIMENTAL to the serving graph, the SrvKeyspace partition rebuild, the update stream, and the SHOW TABLETS output so vtgate can discover and route queries to EXPERIMENTAL tablets.

After deploying, operators need to run vtctldclient RebuildKeyspaceGraph <keyspace> to regenerate the SrvKeyspace with the new EXPERIMENTAL partition.

Related Issue(s)

Fixes #20114

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

After deploying vtctld with this change, run vtctldclient RebuildKeyspaceGraph <keyspace> for any keyspace that has EXPERIMENTAL tablets. This regenerates the SrvKeyspace to include the EXPERIMENTAL partition. vtgate must also be restarted (or will pick up the new SrvKeyspace via its topo watcher) to begin routing to EXPERIMENTAL tablets.

Optionally add experimental to the arguments of --tablet_types_to_wait if you want vtgate to wait for healthy EXPERIMENTAL tablets at startup.

AI Disclosure

This PR was written with the help of Claude Code.

Copilot AI review requested due to automatic review settings May 15, 2026 12:41
@github-actions github-actions Bot added this to the v25.0.0 milestone May 15, 2026
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot Bot commented May 15, 2026

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 NeedsWebsiteDocsUpdate What it says NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work 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 May 15, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR extends Vitess’ serving/visibility logic to treat EXPERIMENTAL tablets as part of the vtgate-serving path (serving graph + SrvKeyspace partitions), so they can be routed to/considered similarly to other serving tablet types.

Changes:

  • Include TabletType_EXPERIMENTAL in serving graph and update-stream checks (topo.IsInServingGraph, topo.IsRunningUpdateStream).
  • Add EXPERIMENTAL to the set of served tablet types when rebuilding SrvKeyspace partitions (topotools.RebuildKeyspaceLocked).
  • Show replication status for EXPERIMENTAL tablets in SHOW VITESS_REPLICATION_STATUS.
  • Disable two GitHub workflows by ignoring all branches (appears unrelated to the stated PR purpose).

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
go/vt/vtgate/executor.go Extends replication-status display filtering to include EXPERIMENTAL tablets.
go/vt/topotools/rebuild_keyspace.go Adds EXPERIMENTAL to SrvKeyspace partition rebuild served types.
go/vt/topo/tablet.go Treats EXPERIMENTAL as in the serving graph and eligible for update-stream running checks.
.github/workflows/pr_opened_tasks.yml Disables PR-opened automation by ignoring all branches.
.github/workflows/error_code_docs_generate.yml Disables error-code docs generation workflow by ignoring all branches.

Comment thread .github/workflows/pr_opened_tasks.yml Outdated
Comment thread .github/workflows/error_code_docs_generate.yml
Allow vtgate to route queries to EXPERIMENTAL tablets by adding the type
to the serving graph, SrvKeyspace partition rebuild, update stream, and
SHOW TABLETS output.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Signed-off-by: Eduardo Ortega <5791035+ejortegau@users.noreply.github.com>
@ejortegau ejortegau force-pushed the ejortegau/experimental-tablets-serve branch from 3830e9e to 44230a0 Compare May 15, 2026 12:59
@ejortegau ejortegau marked this pull request as ready for review May 15, 2026 12:59
Copilot AI review requested due to automatic review settings May 15, 2026 12:59
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

@promptless
Copy link
Copy Markdown
Contributor

promptless Bot commented May 15, 2026

📝 Documentation updates suggested

I've created documentation updates for this PR:

vitessio/website - Added EXPERIMENTAL tablet type documentation:

  • Tablet concepts page with SPARE and EXPERIMENTAL type definitions
  • FAQ entry for tablet types
  • vtgate configuration guide with --tablet-types-to-wait flag documentation

vitessio/vitess - Added changelog entry:

  • Documents vtgate EXPERIMENTAL tablet routing capability
  • Includes deployment steps (RebuildKeyspaceGraph required)
  • Notes optional --tablet-types-to-wait configuration

🤖 Generated by Promptless

@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 81.99%. Comparing base (70c7a72) to head (44230a0).
⚠️ Report is 270 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/topo/tablet.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main   #20115       +/-   ##
===========================================
+ Coverage   69.67%   81.99%   +12.32%     
===========================================
  Files        1614      399     -1215     
  Lines      216793    62983   -153810     
===========================================
- Hits       151044    51643    -99401     
+ Misses      65749    11340    -54409     
Flag Coverage Δ
partial 81.99% <50.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Build/CI Component: Topology Component: VTGate 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request: tablets with type EXPERIMENTAL should be able to serve queries

3 participants