docs: add troubleshooting section

[alegrey91]

PR Type:

Documentation

---

PR Description:

This PR adds a troubleshooting section to the Kubescape Operator documentation. It provides a solution for a specific error related to the node-agent logs, which can be resolved by reinstalling the helm-chart with specific parameters.

---

PR Main Files Walkthrough:

files:

charts/kubescape-operator/README.md: A troubleshooting section has been added to the README. It provides a solution for an error related to the node-agent logs. The solution involves reinstalling the helm-chart with specific parameters.

---

User Description:

Overview

Related to this PR: kubescape/node-agent#139

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Adding a troubleshooting section to the Kubescape Operator documentation
• 📝 PR summary: This PR introduces a troubleshooting section to the Kubescape Operator documentation. It provides a solution for a specific error related to the node-agent logs, which can be resolved by reinstalling the helm-chart with specific parameters.
• 📌 Type of PR: Documentation
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 1, because the PR is straightforward and only involves changes to the documentation.
• 🔒 Security concerns: No security concerns found

PR Feedback

• 💡 General suggestions: The PR is well-structured and the changes are clearly explained. The addition of a troubleshooting section is a good idea as it can help users resolve common issues on their own. However, it would be beneficial to provide more context about when this error might occur and why the suggested solution works.

• 🤖 Code feedback:

  • relevant file: charts/kubescape-operator/README.md
    suggestion: Consider adding more context about when this error might occur and why the suggested solution works. This can help users understand the problem better and apply the solution more confidently. [medium]
    relevant line: {"level":"fatal", "msg":"error starting the container watcher", "error":"failed to initialize container collection: starting runc fanotify: no runc instance can be monitored with fanotify. The following paths were tested: /bin/runc,/usr/bin/runc,/usr/sbin/runc,/usr/local/bin/runc,/usr/local/sbin/runc,/usr/lib/cri-o-runc/sbin/runc,/run/torcx/unpack/docker/bin/runc,/usr/bin/crun. You can use the RUNC_PATH env variable to specify a custom path. If you are succesful doing so, please open a PR to add your custom path to runcPaths\n"}

How to use

To invoke the PR-Agent, add a comment using one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.

[dwertent]

@yossi77 and I worked on a troubleshooting guide. I think we should have that guide published somewhere, maybe in the kubescape.io.
Regarding this PR, I don't think we should publish a troubleshooting only for this scenario.

/cc: @slashben @GibliX

[craigbox]

If this is meant to be user facing, it should be on (or at the least, linked to from), kubescape.io.

[GibliX]

@dwertent Are you referring to this troubleshooting doc?
You suggest we add the RUNC issue to this doc?

[dwertent]

@GibliX Yes