From 728f22f2a48da0a367d32f7b584895fb871e133e Mon Sep 17 00:00:00 2001 From: janvi01 Date: Thu, 15 Feb 2024 13:32:21 +0530 Subject: [PATCH] docs: improve tetra bugtool installations --- .../content/en/docs/troubleshooting/_index.md | 29 +++++++++++-------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/docs/content/en/docs/troubleshooting/_index.md b/docs/content/en/docs/troubleshooting/_index.md index 8652d07269f..de06135b6ee 100644 --- a/docs/content/en/docs/troubleshooting/_index.md +++ b/docs/content/en/docs/troubleshooting/_index.md @@ -28,7 +28,7 @@ tetra bugtool Tetragon's bugtool captures potentially useful information about your environment for debugging. The tool is meant to be used for debugging a single Tetragon agent node. Note in Kubernetes, the command needs to be run from inside the Tetragon pod/container. -#### Key Information Collected by the Bugtool: +**Key Information Collected by the Bugtool:** - Tetragon configuration - Network configuration @@ -52,21 +52,26 @@ kubectl get pods -n -l app.kubernetes.io/name=tetragon kubectl exec -n -- tetra bugtool ``` -Scenario 2: Container Installation +#### Scenario 2: Container Installation -Enter the Tetragon Container: +1. **Enter the Tetragon Container:** -Bash +```bash docker exec -it /bin/sh -Use code with caution. -Run tetra bugtool: +``` + +2. **Run tetra bugtool:** -Bash +```bash tetra bugtool -Use code with caution. -Scenario 3: Systemd Host Installation +``` -Execute tetra bugtool with Elevated Permissions: -Bash +#### Scenario 3: Systemd Host Installation + +1. **Execute tetra bugtool with Elevated Permissions:** + +```bash sudo tetra bugtool -Use code with caution. +``` + +> Note: Replace <...> placeholders with the actual values applicable to your setup.