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.

Sign up for GitHub

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

Jump to bottom

[VTAdmin] Remove vtctld web link, improve local example #15607

Merged
merged 3 commits into from
Apr 2, 2024
Merged

[VTAdmin] Remove vtctld web link, improve local example #15607

merged 3 commits into from
Apr 2, 2024

Conversation

notfelineit
Copy link
Contributor

@notfelineit notfelineit commented Apr 2, 2024 •
edited
Loading

Description

This PR:

  • Removes the link to vtctld web, since we deprecated it in v17
  • Improves vtadmin-up.sh by 1) outputting the variables that are being set and 2) shortening the wait time for cluster discovery
  • Improves web/vtadmin/build.sh by 1) outputting the variables set and 2) when no hostname is set, uses the local machine's hostname

The last bullet point made it so that I could run ./101_initial_clusters.sh without any extra steps, and get vtadmin-web/vtadmin-api working:

Screenshot 2024-04-01 at 6 14 19 PM

Related Issue(s)

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

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Apr 2, 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 Apr 2, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Apr 2, 2024
@notfelineit notfelineit added Type: Bug Component: VTAdmin VTadmin interface Component: web UI javascript Pull requests that update Javascript code 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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Apr 2, 2024
@notfelineit notfelineit marked this pull request as ready for review April 2, 2024 01:24
@notfelineit
Fix lint issues
b394a9f 
Signed-off-by: notfelineit <[email protected]>
@notfelineit notfelineit merged commit a4988f3 into vitessio:main Apr 2, 2024
104 checks passed
@notfelineit notfelineit deleted the remove-vtctld-link branch April 2, 2024 16:42
This was referenced Apr 2, 2024
Closed
Open
deepthi
deepthi reviewed Apr 2, 2024
View reviewed changes
web/vtadmin/build.sh
Comment on lines +27 to +32
if [ -z "${hostname}" ]
then
hostname=$(hostname -f)
output "\n\033[1;32mhostname was empty, set it to \"${hostname}\"\033[0m"
fi

Copy link
Member

Choose a reason for hiding this comment

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

Good one. I believe we've all been working around this using /etc/hosts.

notfelineit
notfelineit commented Apr 2, 2024
View reviewed changes
examples/common/scripts/vtadmin-up.sh
# Wait for vtadmin to successfully discover the cluster
expected_cluster_result="{\"result\":{\"clusters\":[{\"id\":\"${cluster_name}\",\"name\":\"${cluster_name}\"}]},\"ok\":true}"
for _ in {0..300}; do
for _ in {0..100}; do
Copy link
Contributor Author

Choose a reason for hiding this comment

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

FYI - this was taking a long time when I ran it locally. Shortening to 100 was much faster, and I think 100 is a fine threshold. If it's not found by then, it probably wasn't set up correctly. We can also tune this if it becomes an issue!

@notfelineit notfelineit added Backport to: release-17.0 Backport to: release-18.0 Needs to be back ported to release-18.0 labels Apr 30, 2024
@notfelineit notfelineit added the Backport to: release-19.0 Needs to be back ported to release-19.0 label Apr 30, 2024
notfelineit added a commit to planetscale/vitess that referenced this pull request May 1, 2024
@notfelineit
[VTAdmin] Remove vtctld web link, improve local example (vitessio#15607)
79dd600 
Signed-off-by: notfelineit <[email protected]>
@notfelineit notfelineit mentioned this pull request May 1, 2024
Merged
notfelineit added a commit to planetscale/vitess that referenced this pull request May 1, 2024
@notfelineit
[VTAdmin] Remove vtctld web link, improve local example (vitessio#15607)
d69abb6 
Signed-off-by: notfelineit <[email protected]>
notfelineit added a commit to planetscale/vitess that referenced this pull request May 1, 2024
@notfelineit
[VTAdmin] Remove vtctld web link, improve local example (vitessio#15607)
3076ba6 
Signed-off-by: notfelineit <[email protected]>
@notfelineit notfelineit mentioned this pull request May 1, 2024
Merged
@deepthi
Copy link
Member

deepthi commented May 1, 2024

Backporting because it's been reported in both v18 and v19.
Not back porting to v17 because

  • it seems not broken in v17
  • vtctld web was deprecated in v17, but not deleted

mattlord pushed a commit that referenced this pull request May 1, 2024
@notfelineit
[VTAdmin] Remove vtctld web link, improve local example (#15607) (#15825
9e65cd7 
)

Signed-off-by: notfelineit <[email protected]>
notfelineit added a commit that referenced this pull request May 2, 2024
@notfelineit
[VTAdmin] Remove vtctld web link, improve local example (#15607) (#15824
2c42825 
)

Signed-off-by: notfelineit <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepthi deepthi deepthi left review comments

@mattlord mattlord mattlord approved these changes

@rohit-nayak-ps rohit-nayak-ps rohit-nayak-ps approved these changes

@ajm188 ajm188 Awaiting requested review from ajm188 ajm188 is a code owner

Assignees
No one assigned
Labels
Backport to: release-18.0 Needs to be back ported to release-18.0 Backport to: release-19.0 Needs to be back ported to release-19.0 Component: VTAdmin VTadmin interface Component: web UI javascript Pull requests that update Javascript code Type: Bug
Projects
None yet
Milestone
v20.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@notfelineit @deepthi @mattlord @rohit-nayak-ps