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

Fix vttestserver run script defaults #12004

Merged
merged 1 commit into from
Dec 21, 2022

Conversation

GuptaManan100
Copy link
Member

Description

This PR fixes the default values for a couple of parameters in the run script used by the vttestserver docker image.

This fixes the issue described in #12003. Running the docker image without specifying the TABLET_REFRESH_INTERVAL environment variable works just fine after these changes.

The default planner has also been changed to gen4.

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

Deployment Notes

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 21, 2022

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.

@mattlord
Copy link
Contributor

I didn't want to block approval for this as this PR is not adding anything new... but could we take this opportunity to document these ENV vars? Probably makes sense to do it here:

  1. https://hub.docker.com/r/vitess/vttestserver
  2. https://github.com/vitessio/vitess/blob/main/docker/README.md

/cc @rsajwani and @deepthi

@deepthi
Copy link
Member

deepthi commented Dec 21, 2022

I didn't want to block approval for this as this PR is not adding anything new... but could we take this opportunity to document these ENV vars? Probably makes sense to do it here:

  1. https://hub.docker.com/r/vitess/vttestserver
  2. https://github.com/vitessio/vitess/blob/main/docker/README.md

/cc @rsajwani and @deepthi

Another doc that is out-of-date 😭
We need an issue to track it and get to it at some point.

@deepthi
Copy link
Member

deepthi commented Dec 21, 2022

Thank you fixing this. Definitely something I missed while reviewing the previous PR.

@deepthi deepthi merged commit b4eafe1 into vitessio:main Dec 21, 2022
@deepthi deepthi deleted the vttestserver-fix branch December 21, 2022 19:39
@rsajwani
Copy link
Contributor

Yeah I missed it during my testing as well.. :(. Thanks Manan

Copy link
Contributor

@rsajwani rsajwani left a comment

Choose a reason for hiding this comment

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

LGTM

@rsajwani
Copy link
Contributor

I didn't want to block approval for this as this PR is not adding anything new... but could we take this opportunity to document these ENV vars? Probably makes sense to do it here:

  1. https://hub.docker.com/r/vitess/vttestserver
  2. https://github.com/vitessio/vitess/blob/main/docker/README.md

/cc @rsajwani and @deepthi

Another doc that is out-of-date 😭 We need an issue to track it and get to it at some point.

I have created issue. (vitessio/website#1312).
Also I have pointed out in issue we need to add TABLET_REFRESH_INTERVAL flag on website here

@rsajwani
Copy link
Contributor

Yeah I missed it during my testing as well.. :(. Thanks Manan

@GuptaManan100 for review vitessio/website#1313

@GuptaManan100
Copy link
Member Author

@rsajwani Apologies, I didn't link the website changes, but I fixed the environment variables too while doing the docs review. Doing the docs review is how I found the problem. vitessio/website#1309

@rsajwani
Copy link
Contributor

vitessio/website#1309

no worries , i will review the website PR tomorrow. will close mine

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

Successfully merging this pull request may close these issues.

Bug Report: Vttestserver docker image command doesn't work
4 participants