From 63083b965be76003cd608eacb45a2cdf7426e5bb Mon Sep 17 00:00:00 2001
From: Philipp Mieden <dreadl0ck@protonmail.ch>
Date: Thu, 14 Apr 2022 16:09:21 +0200
Subject: [PATCH] chore: add readme for example app debugging

---
 test/app/README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 test/app/README.md

diff --git a/test/app/README.md b/test/app/README.md
new file mode 100644
index 0000000..0daa5ac
--- /dev/null
+++ b/test/app/README.md
@@ -0,0 +1,52 @@
+# README
+
+Instructions to debug the example app.
+
+## STEPS
+
+Install dependencies: 
+
+    $ brew install helm kubectx k9s
+
+Start docker, check which context you are connected to:
+
+    $ kubectx
+    docker-desktop
+
+Setup local cluster, deploy test chart:
+
+    $ cd test/app
+    $ make build && make deploy
+
+Use k9s to check if the example app pod is running:
+
+    $ k9s
+
+then patch:
+
+    $ gograpple patch example --image golang
+
+and debug (using vscode):
+    
+    $ gograpple delve example --source . --vscode
+
+set a breakpoint in the HTTP handler.
+
+> Note: before the startup of the service debugging does not work as delve is not started yet!
+
+Use port forwarding via k9s to expose the pod (shift-F):
+
+- App Port: 80
+- Local Port: 8080
+
+> Note: This will be reverted once you exit k9s!
+
+Now access the web service by visiting: http://localhost:8080
+
+You should be dropped into the debugger in VSCode at the breakpoint!
+
+Once done, rollback:
+
+    $ gograpple patch example --rollback
+
+Happy debugging!
\ No newline at end of file