From 4eb28406ccc4ffb7794bcfd9e4662d5899b60e76 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Tue, 26 Jul 2022 20:09:38 +0200
Subject: [PATCH] Add troubleshooting page

---
 docs/troubleshooting-execution.md | 46 +++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 docs/troubleshooting-execution.md

diff --git a/docs/troubleshooting-execution.md b/docs/troubleshooting-execution.md
new file mode 100644
index 000000000..479ba93bd
--- /dev/null
+++ b/docs/troubleshooting-execution.md
@@ -0,0 +1,46 @@
+---
+title: Troubleshooting
+has_children: false
+parent: Running Benchmarks
+nav_order: 10
+---
+
+# Troubleshooting Execution
+
+## Verify your Installation
+
+First you should make sure that all Theodolite pods are up and running by typing:
+
+```sh
+kubectl get pods
+```
+
+If pods are still creating or failing to start, you should simply wait a bit longer or investigate this further.
+
+If Theodolite is [installed via Helm](installation.md), you can also use `helm test` to verify that everything is installed as expected. Just run the following command (replace `theodolite` by your release name) and wait for all tests to be completed:
+
+```sh
+helm test theodolite
+```
+
+## Getting Execution Events
+
+Theodolite produces Kubernetes events, which you can view by running:
+
+```sh
+kubectl describe execution <your-execution-name>
+```
+
+## Looking the Operator Logs
+
+If you cannot figure out why your benchmark execution fails, you might want to have look at the operator logs:
+
+```sh
+kubectl logs -l app=theodolite -c theodolite
+```
+
+You might also add the `-f` flag to follow the logs.
+
+## Contact the Maintainers
+
+Do not hesitate to [ask for help](project-info#getting-help) if you are still having problems. Attaching Theodolite's logs to your request is likely to help us solving your problem.
-- 
GitLab