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

Examples: Correct VTAdmin Discovery File Path And Add Check #12415

Merged

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Feb 21, 2023

Description

VTAdmin failing to discover the Vitess cluster in the local examples was reported in the Vitess Slack.

This was caused by the relative path usage missed as part of the refactoring done in: #12239

And this was easily missed because there was no check done to confirm proper discovery and thus the local examples CI tests did not fail.

In this PR we correct the static discovery file path AND add a check to ensure that the discovery was successful and if not, we exit with an error (which would cause the tests to fail).

Note While testing/confirming this fix in the CI with manual test re-runs, I saw another timing issue related to the specific healthy shard indicator that the scripts were using vs. what vtctld used in checking that a shard has a healthy serving primary tablet when e.g. executing ApplySchema (this was also reported in the Vitess Slack here). I changed the example scripts' healthy shard check to match with what vtctld uses. After that commit, the tests never failed.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Documentation was added or is not required

Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord added Component: VTAdmin VTadmin interface Component: Examples Forwardport to: main This will forward port the PR to the main branch labels Feb 21, 2023
@mattlord mattlord requested a review from deepthi as a code owner February 21, 2023 19:17
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 21, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 21, 2023

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

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

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

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

Copy link
Contributor

@notfelineit notfelineit left a comment

Choose a reason for hiding this comment

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

Nice, love the added check 🥳

@mattlord mattlord removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 21, 2023
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
@GuptaManan100 GuptaManan100 mentioned this pull request Feb 22, 2023
51 tasks
@mattlord mattlord merged commit 8528903 into vitessio:release-16.0 Feb 22, 2023
@mattlord mattlord deleted the examples_vtadmin_discovery_fix branch February 22, 2023 15:14
mattlord added a commit that referenced this pull request Feb 22, 2023
…12415) (#12430)

* Examples: correct VTAdmin discovery file path and add check

Signed-off-by: Matt Lord <mattalord@gmail.com>

* Remove jq dependency

Signed-off-by: Matt Lord <mattalord@gmail.com>

* vtadmin examples scripts hardcode localhost

Signed-off-by: Matt Lord <mattalord@gmail.com>

* Fix errant expectation

Signed-off-by: Matt Lord <mattalord@gmail.com>

* Adjust healthy shard indicator

Signed-off-by: Matt Lord <mattalord@gmail.com>

---------

Signed-off-by: Matt Lord <mattalord@gmail.com>
Co-authored-by: Matt Lord <mattalord@gmail.com>
@hmaurer hmaurer mentioned this pull request Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Examples Component: VTAdmin VTadmin interface Forwardport to: main This will forward port the PR to the main branch Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants