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

doc updates #1664

Merged
merged 2 commits into from
Nov 1, 2023
Merged

doc updates #1664

merged 2 commits into from
Nov 1, 2023

Conversation

kkourt
Copy link
Contributor

@kkourt kkourt commented Oct 27, 2023

No description provided.

@kkourt kkourt requested review from mtardy and a team as code owners October 27, 2023 08:23
@netlify
Copy link

netlify bot commented Oct 27, 2023

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit a50f4bd
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/653bd37024360b0008b82a47
😎 Deploy Preview https://deploy-preview-1664--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.

@kkourt kkourt added the release-note/docs This PR updates the documentation. label Oct 27, 2023
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! I have a few nits/suggestions as always with docs, feel free to ignore some of them :)

docs/content/en/docs/getting-started/install-k8s.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
Copy link
Member

Choose a reason for hiding this comment

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

maybe we can move /docs/tutorials/debugging-tetragon/ to this section (for next PR maybe)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm... not sure. I feel troubleshooting is: "I have a problem, what should I do?" While the debugging section is not really helpful with that because adding more debugging messages is not necessarily a good troubleshooting option.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Some of the entries in the FAQ, however, could be under troubleshooting I think. E.g., the section about btf comes to mind.

You collect information in a Kubernetes cluster using the Cilium CLI:

```shell-session
$ cilium-cli sysdump
Copy link
Contributor

Choose a reason for hiding this comment

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

We should put a note at least how to install cilium-cli here. People might not be aware.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's in the link below. There are many details on this so I thought it would be best to refer to the Cilium docs for this. Thoughts?

Add a troubleshooting section with information about sysdump and
bugtool.

Signed-off-by: Kornilios Kourtis <[email protected]>
Update kind instructions to properly mount /proc.

Signed-off-by: Kornilios Kourtis <[email protected]>
@kkourt kkourt force-pushed the pr/kkourt/docs-updates branch from d17d1fa to a50f4bd Compare October 27, 2023 15:12
@kkourt kkourt merged commit 1c1e41e into main Nov 1, 2023
9 checks passed
@kkourt kkourt deleted the pr/kkourt/docs-updates branch November 1, 2023 07:26
@kkourt
Copy link
Contributor Author

kkourt commented Nov 1, 2023

Merged, we can improve later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note/docs This PR updates the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants