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

docs: tetragon troubleshoot improve #2115

Merged
merged 1 commit into from
Feb 27, 2024
Merged

Conversation

janvi01
Copy link
Contributor

@janvi01 janvi01 commented Feb 16, 2024

Improved doc around tetra bugtool, demo how to run it for all different installation k8s, container or systemd host installation.

Fixes #1974 second tick box.

@janvi01 janvi01 requested review from mtardy and a team as code owners February 16, 2024 12:42
Copy link

netlify bot commented Feb 16, 2024

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit dc65465
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/65ddcf86864d26000838e98b
😎 Deploy Preview https://deploy-preview-2115--tetragon.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.

@mtardy mtardy added area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation. labels Feb 19, 2024
Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

Thanks a lot for taking the time to do that, I have some remarks on the form, I hope it's not too much.

docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
@mtardy mtardy requested a review from tixxdz February 19, 2024 09:46
@janvi01 janvi01 requested a review from mtardy February 19, 2024 17:01
Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

Thanks a lot, to me it looks good! Could you squash your commits into one with only your first commit message? Thanks :)

docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
@mtardy
Copy link
Member

mtardy commented Feb 20, 2024

Hey, I saw you added a merge commit. Please use git rebase -i <your_first_branch_commit>^ then drop the merge commit and squash all the commits into the first one. Then you can just resync your main branch and when on your dev branch, just git rebase main.

@janvi01
Copy link
Contributor Author

janvi01 commented Feb 20, 2024

Thanks @mtardy quite confused about how to squash commit after the merge commit, it shows various commits to pick(that's probably of others who got in the merge commit)

git rebase -i <your_first_branch_commit>^ i.e. git rebase -i 7bf5737e16b71f62a794144f3ac5b6ec49c9a9ac shows me this, doesn't shows my merge commit

pick 393068fb docs: improve tetra bugtool installations
pick 728f22f2 docs: improve tetra bugtool installations
pick 4361285e docs: merge debugging tetragon tutorial with troubleshooting
pick cd1c898d docs: improve tetra bugtool installations

# Rebase 3b7eda5c..cd1c898d onto 3b7eda5c (4 commands)

Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

All right I did the fix for you, here are a few things to consider please on the content this time, sorry I didn't do everything at once. Please try to amend the existing commit with your changes or add commits and then squash them.

docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/troubleshooting/_index.md Outdated Show resolved Hide resolved
@janvi01 janvi01 requested a review from willfindlay as a code owner February 21, 2024 06:01
@janvi01
Copy link
Contributor Author

janvi01 commented Feb 21, 2024

@mtardy I did the required changes and amended the commit (apologies quite confused, how did I get others commits here).

@janvi01 janvi01 requested a review from mtardy February 21, 2024 06:05
@mtardy
Copy link
Member

mtardy commented Feb 21, 2024

@mtardy I did the required changes and amended the commit (apologies quite confused, how did I get others commits here).

Thanks for taking the time to do the changes!

Sorry this time you'll need to cleanup your PR. Instead of opening a new PR like last time or me tidying up stuff, I think you should take some time to get more familiar with git and git rebase in particular, that will be really useful for you! :)

@janvi01
Copy link
Contributor Author

janvi01 commented Feb 21, 2024

@mtardy I squash the commits into a single one, but how to remove others' file changes. Apologies for the inconvenience.

Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

I'm going to merge that, I forced pushed again removing all the changes from other commits you merged into your initial commit.

While we really appreciate you taking the time to write documentation, please take a bit more time next time testing the commands you put in the documentation. Almost all of them were not working.

  • the kubectl get pods -l app.kubernetes.io/name=tetragon label was wrong, with a space instead of the /
  • the kubectl exec was missing the -c tetragon option
  • the kubectl cp was missing the -c tetragon and the archive name was wrong.
  • the docker cp had a wrong archive name.

@mtardy mtardy merged commit 5f04ece into cilium:main Feb 27, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: improve troubleshooting Tetragon
2 participants