Skip to content

Commit

Permalink
docs: improve tetra bugtool installations
Browse files Browse the repository at this point in the history
  • Loading branch information
janvi01 committed Feb 15, 2024
1 parent 393068f commit 728f22f
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions docs/content/en/docs/troubleshooting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -52,21 +52,26 @@ kubectl get pods -n <tetragron-namespace> -l app.kubernetes.io/name=tetragon
kubectl exec -n <tetragron-namespace> <tetragron-pod-name> -- tetra bugtool
```

Scenario 2: Container Installation
#### Scenario 2: Container Installation

Enter the Tetragon Container:
1. **Enter the Tetragon Container:**

Bash
```bash
docker exec -it <tetragron-container-id> /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.

0 comments on commit 728f22f

Please sign in to comment.