add helm trace

Signed-off-by: Adam Gardner <[email protected]>
agardnerIT · Aug 12, 2023 · 6d10301 · 6d10301
1 parent cfa9021
commit 6d10301
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/docs/index.md b/docs/index.md
@@ -17,7 +17,7 @@ Want to do a similar thing with logs? Check out [logpusher](https://agardnerit.g
 
 - [Trace CICD Pipelines with OpenTelemetry](https://github.com/agardnerIT/tracepusher/blob/main/samples/gitlab/README.md)
 - [Trace shell scripts with OpenTelemetry](https://github.com/agardnerIT/tracepusher/blob/main/samples/script.sh)
-- [Trace Helm with tracepusher](https://github.com/agardnerit/helm-trace)
+- [Trace Helm with tracepusher](usage/helm.md)
 - [Use tracepusher in a CICD system](usage/ci.md)
 - Trace anything with OpenTelemetry
 

diff --git a/docs/usage/helm.md b/docs/usage/helm.md
@@ -0,0 +1,18 @@
+# Trace Helm with Tracepusher
+
+It is possible to trace `helm` commands using tracepusher.
+
+Just add the word `trace` to any regulard `helm` command.
+
+For example, `helm version` becomes `helm trace version`
+
+## Instructions
+
+1. Download and add a tracepusher binary to your `PATH`
+1. Install `helm trace` plugin:
+
+```
+helm plugin install https://github.com/agardnerit/helm-trace
+```
+
+Full documentation is available on the [helm trace GitHub repo](https://github.com/agardnerIT/helm-trace).