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

Common issue faced during the setup of the Vitess operator for Kubernetes #1848

Merged
merged 9 commits into from
Oct 7, 2024
Merged

Common issue faced during the setup of the Vitess operator for Kubernetes #1848

merged 9 commits into from
Oct 7, 2024

Conversation

shailpujan88
Copy link
Collaborator

@shailpujan88 shailpujan88 commented Sep 15, 2024 •
edited by mattlord
Loading

This PR For Add new getting started example #1798

Added a new troubleshooting section to the Vitess Operator for Kubernetes documentation to address common port conflict issues that users may encounter during setup.

Changes made:

  1. Added a new entry in the "Common Issues and Solutions" section of the document.
  2. Described the issue of port conflicts when running the port-forward script.
  3. Provided step-by-step instructions for identifying and resolving port conflicts.
  4. Included relevant commands for troubleshooting (lsof, kill).

Preview: https://deploy-preview-1848--vitess.netlify.app/docs/21.0/get-started/operator/#common-issues-and-solutions

@netlify Netlify
Copy link

netlify bot commented Sep 15, 2024 •
edited
Loading

✅ Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 3387167
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/6704206dbdd286000842d6a8
😎 Deploy Preview https://deploy-preview-1848--vitess.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mattlord mattlord mentioned this pull request Sep 17, 2024
Closed
24 tasks
@shailpujan88 shailpujan88 marked this pull request as ready for review September 17, 2024 16:54
mattlord
mattlord reviewed Sep 17, 2024
View reviewed changes
Copy link
Collaborator

@mattlord mattlord left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Overall it looks good! https://deploy-preview-1848--vitess.netlify.app/docs/21.0/get-started/operator/#common-issues-and-solutions

I had some suggestions. Can you also please update the title to better reflect the content of the PR?

content/en/docs/21.0/get-started/operator.md Outdated Show resolved Hide resolved
content/en/docs/21.0/get-started/operator.md Outdated Show resolved Hide resolved
content/en/docs/21.0/get-started/operator.md Outdated Show resolved Hide resolved
frouioui
frouioui reviewed Sep 17, 2024
View reviewed changes
content/en/docs/21.0/get-started/operator.md Outdated
@@ -173,6 +173,30 @@ Exiting due to to DRV_AS_ROOT: The "docker" driver should not be used with root

<b>Solution:</b> Create a new user and add it to your [docker group](https://docs.docker.com/engine/install/linux-postinstall).

<b>Issue:</b> Port conflicts when running the port-forward script
Copy link
Member

Choose a reason for hiding this comment

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

As we are adding more elements to the Common Issues and Solutions section of this page, I think it would be visually more intuitive if we had sub-section for each issue. Right now each issue is highlighted with a bold keyword Issue:. I am thinking it could look like this:

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've implemented the changes as discussed. Now, each issue in the Common Issues and Solutions section is organized into its own sub-section, which should make the layout more intuitive and easier to navigate.

frouioui
frouioui reviewed Sep 17, 2024
View reviewed changes
content/en/docs/21.0/get-started/operator.md Outdated
alias vtctldclient="vtctldclient --server=localhost:15999"
alias mysql="mysql -h 127.0.0.1 -P 15306 -u user"
```
You may encounter an error indicating that Vitess is unable to start because the necessary network ports are already in use by other processes on your system.
Copy link
Member

Choose a reason for hiding this comment

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

Is it an error because the ports that Vitess wants are already busy, or because the ports that port-forwarding (./pf.sh) wants are busy?

The title of the issue describes only port-forwarding but here we mention "Vitess is unable to start", which can be confusing. If we only want to focus on the port-forwarding issue, we should mention that port-forwarding is unable to start.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It was becuase of the ports are busy. Done with the changes as mentioned by you

frouioui
frouioui reviewed Sep 17, 2024
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

I have left some comments. I think we should make the Common Issues and Solutions section a bit easier to navigate for readers. And make it more clear that we're only talking about port-forwarding and not about Vitess's binaries.

Moreover, while the solution you have found is correct, doing killall -9 kubectl will solve the same issue more efficiently, assuming the user does not have other kubectl running in the background that are unrelated to port-forwarding. We could even add that command to the Setup Port-forward section.

@frouioui
Copy link
Member

frouioui commented Oct 3, 2024

Hello @shailpujan88 I think both #1848 (review) and #1848 (comment) are pending, also kindly please update the PR title.

@shailpujan88
Copy link
Collaborator Author

I have left some comments. I think we should make the Common Issues and Solutions section a bit easier to navigate for readers. And make it more clear that we're only talking about port-forwarding and not about Vitess's binaries.

Moreover, while the solution you have found is correct, doing killall -9 kubectl will solve the same issue more efficiently, assuming the user does not have other kubectl running in the background that are unrelated to port-forwarding. We could even add that command to the Setup Port-forward section.

If I am not wrong Are you asking if we should also include the setup port forwarding section in the document?

@shailpujan88 shailpujan88 changed the title Common issue Common issue faced during the setup of the Vitess operator for Kubernetes Oct 3, 2024
mattlord
mattlord approved these changes Oct 6, 2024
View reviewed changes
Copy link
Collaborator

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you for sticking with it @shailpujan88 🙂

@frouioui
Copy link
Member

frouioui commented Oct 7, 2024

I am not seeing #1848 (comment) as implemented when looking at the preview on https://deploy-preview-1848--vitess.netlify.app/docs/21.0/get-started/operator/#common-issues-and-solutions.

mattlord
mattlord reviewed Oct 7, 2024
View reviewed changes
content/en/docs/21.0/get-started/operator.md Outdated
@@ -184,3 +202,6 @@ Or alternatively, if you would like to teardown your example:
kubectl delete -f 101_initial_cluster.yaml
```
Congratulations on completing this exercise!


[def]: ./#setup-port-forward
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we remove this?

shailpujan88 and others added 9 commits October 7, 2024 23:22
@shailpujan88
Add common issue in Vitess Operator setup
dd7d8ee 
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@shailpujan88
Add common issue in Vitess Operator setup
ee72e8b 
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@shailpujan88
Updated the PR with required changes
d3a9ae5 
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@shailpujan88
Updated the PR with required changes
1954aee 
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@shailpujan88
Common issue faced during setup of Vitess Operator for Kubernetes
016176a 
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@shailpujan88
Link to port-forward section and simplify port conflict solution
d6f56d4 
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@mattlord @shailpujan88
Minor fix
e7fbeb2 
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@mattlord @shailpujan88
Formatting
ab70a3c 
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@shailpujan88
Made the issue subheadings
3387167 
Signed-off-by: Shail Pujan <shailsing977@gmail.com>
@frouioui frouioui merged commit 8af4d78 into prod Oct 7, 2024
5 checks passed
@frouioui frouioui deleted the common-issue branch October 7, 2024 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattlord mattlord mattlord approved these changes

@frouioui frouioui frouioui approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shailpujan88 @frouioui @mattlord