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: fix flag syntax for zkctl #14469

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Conversation

deepthi
Copy link
Member

@deepthi deepthi commented Nov 5, 2023

Description

Running the local example with TOPO=zk2 fails with an error from zkctl startup.
This is because we changed flags to use -- instead of - back in v16.
This was broken at least on main, most likely on 17, and probably on v16 as well.

Related Issue(s)

Fixes #14471

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Nov 5, 2023

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 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 Nov 5, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Nov 5, 2023
@deepthi deepthi added Backport to: release-16.0 and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels Nov 5, 2023
@deepthi
Copy link
Member Author

deepthi commented Nov 5, 2023

We don't seem to run local example with zookeeper in CI. If we did, we might have caught this.
OTOH, we still have this, though we've deleted the k8s topo. I'm not sure how that is passing.

local_example / Local example using k8s on ubuntu-22.04 (pull_request) 

@dbussink
Copy link
Contributor

dbussink commented Nov 5, 2023

OTOH, we still have this, though we've deleted the k8s topo. I'm not sure how that is passing.

Code looks like this:

# start topo server
if [ "${TOPO}" = "zk2" ]; then
  CELL=zone1 ../common/scripts/zk-up.sh
elif [ "${TOPO}" = "consul" ]; then
  CELL=zone1 ../common/scripts/consul-up.sh
else
  CELL=zone1 ../common/scripts/etcd-up.sh
fi

So it considers the default to be etcd, if you set something random / unknown.

@@ -8,7 +8,7 @@ jobs:
runs-on: gh-hosted-runners-16cores-1
strategy:
matrix:
topo: [consul,etcd,k8s]
topo: [consul,etcd,zk2]
Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, that’s why we didn’t notice 🙂

Copy link
Contributor

Choose a reason for hiding this comment

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

I removed the local k8s example from the required checks for main.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we want to make the zk2 one required? Wasn’t sure about that.

@deepthi deepthi merged commit 1a9119d into vitessio:main Nov 7, 2023
115 checks passed
@deepthi deepthi deleted the ds-zk2-ex branch November 7, 2023 20:38
vitess-bot pushed a commit that referenced this pull request Nov 7, 2023
harshit-gangal pushed a commit that referenced this pull request Nov 10, 2023
Signed-off-by: deepthi <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
deepthi added a commit that referenced this pull request Nov 11, 2023
Signed-off-by: deepthi <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: deepthi <[email protected]>
deepthi added a commit that referenced this pull request Nov 11, 2023
Signed-off-by: deepthi <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: deepthi <[email protected]>
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Dec 13, 2023
@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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: local example fails to run with zookeeper topo
3 participants